Skip to content

Commit 16ee9c6

Browse files
committed
Improving READEM
1 parent 70d809a commit 16ee9c6

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,27 @@
44

55
> Load, manipulate and save R&S waveform files
66
7-
A few more paragraphs explaining purposes and features.
7+
The RsWaveform package provides a convenient and easy-to-use software solution for creating and modifying waveform files that can be used with Rohde & Schwarz instruments, but it does not provide access to encrypted waveform files that require a license.
8+
9+
## Purpose
10+
11+
### What it does
12+
13+
The RsWaveform package is a software tool developed by Rohde & Schwarz that allows you to create waveform files that can be used with Rohde & Schwarz instruments. This tool can help you to easily create waveform files that match your specific needs, or to load existing waveform files in various formats such as wv, iqtar, and iqw, modify them, and store them again for future use.
14+
15+
### What it not does
16+
17+
The RsWaveform package does not have the capability to load encrypted waveform files that require a license. These waveform files can only be used with a licensed Rohde & Schwarz product, and cannot be modified or analyzed without the appropriate license.
818

919
## Installation
1020

1121
Install from pypi.org:
22+
1223
```sh
1324
$ pip install RsWaveform
1425
```
1526

16-
You need at least Python 3.7.
27+
You need at least Python 3.8.
1728

1829
## Usage
1930

@@ -187,6 +198,17 @@ RsWaveform.calculate_par(data)
187198
>> 0.0
188199
```
189200

201+
### Running the tests
202+
203+
To run the tests, run the following command:
204+
205+
```sh
206+
$ pip install tox
207+
$ tox -e pytest
208+
```
209+
210+
This will run all the tests for the package and report any issues or failures. Make sure that you have installed the necessary dependencies before running the tests.
211+
190212
## Contributing
191213

192214
- Author: Carsten Sauerbrey (<[email protected]>)

0 commit comments

Comments
 (0)