diff --git a/README.rst b/README.rst index 01d69ba..3701591 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,26 @@ The Python ADS-B/Mode-S Decoder ****************************************** -Python library for ADS-B/Mode-S message decoding. Supported Downlink Formats (DF) are: +If you find this project useful for your research, please cite our work (bibtex format): + +:: + + @article{sun2019pymodes, + author={J. {Sun} and H. {V\^u} and J. {Ellerbroek} and J. M. {Hoekstra}}, + journal={IEEE Transactions on Intelligent Transportation Systems}, + title={pyModeS: Decoding Mode-S Surveillance Data for Open Air Transportation Research}, + year={2019}, + doi={10.1109/TITS.2019.2914770}, + ISSN={1524-9050}, + } + + + +Introduction +--------------------- +PyModeS is a Python library designed to decode Mode-S (including ADS-B) message. +Message with following Downlink Formats (DF) are supported: + **DF17 / DF18: Automatic Dependent Surveillance - Broadcast (ADS-B)** @@ -19,12 +38,11 @@ Python library for ADS-B/Mode-S message decoding. Supported Downlink Formats (DF - BDS 1,0: Data link capability report - BDS 1,7: Common usage GICB capability report - BDS 2,0: Aircraft identification -- BDS 2,1: Aircraft and airline registration markings - BDS 3,0: ACAS active resolution advisory - BDS 4,0: Selected vertical intention -- BDS 4,4: Meteorological routine air report +- BDS 4,4: Meteorological routine air report (experimental) +- BDS 4,5: Meteorological hazard report (experimental) - BDS 5,0: Track and turn report -- BDS 5,3: Air-referenced state vector - BDS 6,0: Heading and speed report @@ -32,28 +50,20 @@ Python library for ADS-B/Mode-S message decoding. Supported Downlink Formats (DF **DF5 / DF21: Identity code (squawk code)** -Detailed manual on Mode-S decoding is published by the author, at: -https://mode-s.org/decode - - -New features in v2.0 ---------------------- -- New structure of the libraries -- ADS-B and Comm-B data streaming -- Active aircraft viewing (terminal curses) -- Improved BDS identification -- Optimizing decoding speed - -Source code +Resources ----------- Checkout and contribute to this open-source project at: https://github.com/junzis/pyModeS -API documentation at: +Detailed manual on Mode-S decoding is published at: +https://mode-s.org/decode. + +API documentation of pyModeS is at: http://pymodes.readthedocs.io + Install -------