Skip to content

Commit c708d57

Browse files
author
Junzi Sun
authored
Update README.rst
1 parent 53a258b commit c708d57

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
A Python Mode-S Decoder
2-
=======================
1+
The Python Mode-S Decoder
2+
=========================
33

4-
Python library for Mode-S message decoding. Two separate methods are
5-
implemented to decode the following messages:
4+
Python library for Mode-S message decoding. Support Downlink Formats (DF) are:
65

76
- Automatic Dependent Surveillance - Broadcast (ADS-B) (DF17)
87

@@ -25,7 +24,7 @@ implemented to decode the following messages:
2524
- BDS 5,3 Air-referenced state vector
2625
- BDS 6,0 Heading and speed report
2726

28-
A detailed manual on Mode-S decoding is published by the author, at:
27+
Detailed manual on Mode-S decoding is published by the author, at:
2928
http://adsb-decode-guide.readthedocs.io
3029

3130

@@ -37,17 +36,19 @@ https://github.com/junzis/pyModeS
3736
API documentation at:
3837
http://pymodes.readthedocs.io
3938

39+
4040
Install
4141
-------
4242

43-
Checkout source code, or install using pip:
43+
The easiest installation is to use pip:
4444

4545
::
4646

4747
pip install pyModeS
4848

49-
Usage
50-
-----
49+
50+
Use the library
51+
---------------
5152

5253
.. code:: python
5354
@@ -66,8 +67,7 @@ Common functions:
6667
pms.bin2int(str) # Convert binary string to integer
6768
pms.hex2int(str) # Convert hexadecimal string to integer
6869
69-
pms.bin2gray(str) # Convert binary string to grey code
70-
pms.gray2bin(str) # Convert grey code to binary string
70+
pms.gray2int(str) # Convert grey code to interger
7171
7272
7373
Core functions for ADS-B decoding:
@@ -94,7 +94,7 @@ Core functions for ADS-B decoding:
9494
pms.adsb.airborne_velocity(msg)
9595
9696
97-
Hint: When you have a fix position of the aircraft, it is convenient to
97+
Note: When you have a fix position of the aircraft, it is convenient to
9898
use `position_with_ref()` method to decode with only one position message
9999
(either odd or even). This works with both airborne and surface position
100100
messages. But the reference position shall be with in 180NM (airborne)
@@ -164,7 +164,7 @@ Core functions for EHS decoding:
164164
165165
Developement
166166
------------
167-
To run tests, run the following commands:
167+
To perform unit tests. First install ``tox`` through pip, Then, run the following commands:
168168
```
169169
$ tox
170170
```

0 commit comments

Comments
 (0)