Package: traffic
The traffic library helps to work with common sources of air traffic data.Its main purpose is to provide data analysis methods commonly applied to trajectories and airspaces. When a specific function is not provided, the access to the underlying structure is direct, through an attribute pointing to a pandas dataframe.The library also offers facilities to parse and/or access traffic data from open sources of ADS-B traffic like theOpenSky Networkor Eurocontrol DDR files. It is designed to be easily extendable to other sources of data.Static visualization (images) exports are accessible via Matplotlib/Cartopy. More dynamic visualization frameworks are easily accessible in Jupyter environments withipyleafletandaltair; or through exports to other formats, including CesiumJS or Google Earth.InstallationFull installation instructions are to be found in thedocumentation.If you are not familiar/comfortable with your Python environment, please install the latesttrafficrelease in a new, fresh conda environment.condacreate-ntraffic-cconda-forgepython=3.10trafficAdjust the Python version you need (>=3.8) and append packages you need for working efficiently, such as Jupyter Lab, xarray, PyTorch or more.Then activate the environment every time you need to use thetrafficlibrary:condaactivatetrafficWarning!Dependency resolution may be tricky, esp. if you use an old conda environment where you overwrotecondalibraries withpipinstalls.Please only report installation issues in new, fresh conda environments.If conda fails to resolve an environment in a reasonable time, consider using aDocker imagewith a working installation.For troubleshooting, refer to the appropriatedocumentation section.CreditsLikeother researchers before, if you find this project useful for your research and use it in an academic work, you may cite it as:@article{olive2019traffic,author={Xavier {Olive}},journal={Journal of Open Source Software},title={traffic, a toolbox for processing and analysing air traffic data},year={2019},volume={4},pages={1518},doi={10.21105/joss.01518},issn={2475-9066},}Additionally, you may consider adding a star to the repository. This token of appreciation is often interpreted as positive feedback and improves the visibility of the library.DocumentationDocumentation available athttps://traffic-viz.github.io/Join the Gitter chat for assistance:https://gitter.im/xoolive/trafficTests and code qualityUnit and non-regression tests are written in thetests/directory. You may runpytestfrom the root directory.Tests are checked onGithub Actionsplatform upon each commit. Latest status and coverage are displayed with standard badges hereabove.In addition to unit tests, code is checked against:formatting withblackandruff;static typing withmypypre-commithooks are available in the repository.Feedback and contributionAny input, feedback, bug report or contribution is welcome.Should you encounter anyissue, you may want to file it in theissuesection of this repository.If you intend tocontribute to trafficor file a pull request, the best way to ensure continuous integration does not break is to reproduce an environment with the same exact versions of all dependency libraries. Please follow theappropriate sectionin the documentation.Let us know what you want to do just in case we're already working on an implementation of something similar. This way we can avoid any needless duplication of effort. Also, please don't forget to add tests for any new functions.