AirTrafficSim
AirTrafficSim: An open-source web-based air traffic simulation platform. - Published in JOSS (2023)
Science Score: 93.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 4 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
○Committers with academic emails
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Scientific Fields
Repository
Web-based air traffic simulation and visualization platform for ATM research. Development branch: https://github.com/HKUST-OCTAD-LAB/AirTrafficSim/tree/dev
Basic Info
- Host: GitHub
- Owner: HKUST-OCTAD-LAB
- License: gpl-3.0
- Language: Python
- Default Branch: main
- Homepage: https://hkust-octad-lab.github.io/AirTrafficSim/
- Size: 277 MB
Statistics
- Stars: 56
- Watchers: 3
- Forks: 6
- Open Issues: 14
- Releases: 8
Topics
Metadata Files
README.md
AirTrafficSim is a web-based air traffic simulation software written in Python and javascript. It is designed to visualize historical and simulated flight data and perform microscopic studies of air traffic movement with the integration of a historical weather database. It aims to assist users to evaluate the performance of ATM algorithms.
Features
- Replay historical flights with user-provided data (e.g. from FlightRadar 24)
- Air traffic simulation using BADA 3.15 performance data and OpenAP
- Navigation data simulation and visualization from x-plane 11
- Autopilot and Flight Management System simulation
- ATC commands (e.g. holding, vectoring, and direct to) simulation
- Simulation and visualisation with weather data from ECMWF ERA5 and custom radar image (HKO 256km radar images)
- Aircraft is controlled with an API interface to simulate ATC interaction
Credits
If you find AirTrafficSim useful for your research, please cite the following:
bibtex
@article{Hui2023,
title = {AirTrafficSim: An open-source web-based air traffic simulation platform.},
author = {Ka Yiu Hui and Chris Hc. Nguyen and Go Nam Lui and Rhea P. Liem},
journal = {Journal of Open Source Software},
publisher = {The Open Journal},
year = {2023},
volume = {8},
number = {86},
pages = {4916},
doi = {10.21105/joss.04916},
url = {https://doi.org/10.21105/joss.04916}
}
Installation
Linux or WSL on window is recommended for AirTrafficSim. The latest stable release of AirTrafficSim can be installed from conda-forge. All dependencies will be installed automatically with the web client pre-built and ready for use directly after installation.
It is recommended to install AirTrafficSim in a new conda environment:
conda create -n airtrafficsim -c conda-forge airtrafficsim
Then, please initialise AirTrafficSim by specifying a folder path to create a symbolic link to the airtrafficsim_data folder:
conda activate airtrafficsim
airtrafficsim --init <path to a folder>
This will alow you to provide or retrieve any data and create simulation environments to AirTrafficSim through this folder alias. Please visit the documentation for more information.
After installation, please also download, unzip, and store BADA 3.15 data files in airtrafficsim_data/performance/BADA. In addition, follow this guide to set up the API key for the weather database from ECMWF Climate Data Store.
Running AirTrafficSim
You can run AirTrafficSim by executing the following commands. Please be reminded to activate the conda environment when you use AirTrafficSim.
conda activate airtrafficsim
airtrafficsim
AirTrafficSim uses port 6111 for communication. Please open or forward the port accordingly if needed. You should be able to open the UI using any modern browser at http://localhost:6111. You may also check the console for any messages when using AirTrafficSim.
You can also run AirTrafficSim without the UI by providing the name of the simulation environment which is listed in environment. The environment name should be identical to the file name.
conda activate airtrafficsim
airtrafficsim --headless <environment name>
Documentation
The detailed documentation for AirTrafficSim is available at https://hkust-octad-lab.github.io/AirTrafficSim/, which includes tutorials on UI navigation and project structure as well as running different simulation environment.
Contribution
AirTrafficSim is under active development. We welcome everyone interested to contribute to the project and make AirTrafficSim more feature-rich. Please feel free to visit the detailed contribution guide in this repository or the documentation.
Owner
- Name: HKUST-OCTAD-LAB
- Login: HKUST-OCTAD-LAB
- Kind: organization
- Email: octadlab@ust.hk
- Location: Hong Kong
- Website: https://octadlab.ust.hk/
- Repositories: 2
- Profile: https://github.com/HKUST-OCTAD-LAB
JOSS Publication
AirTrafficSim: An open-source web-based air traffic simulation platform.
Authors
Department of Mechanical and Aerospace Engineering, The Hong Kong University of Science and Technology, Hong Kong SAR
Department of Mechanical and Aerospace Engineering, The Hong Kong University of Science and Technology, Hong Kong SAR
Department of Mechanical and Aerospace Engineering, The Hong Kong University of Science and Technology, Hong Kong SAR
Department of Mechanical and Aerospace Engineering, The Hong Kong University of Science and Technology, Hong Kong SAR
Editor
Aoife Hughes
Tags
Python Aviation Air traffic management Multi-agent simulation Data visualizationGitHub Events
Total
- Create event: 7
- Release event: 5
- Issues event: 3
- Watch event: 18
- Delete event: 1
- Issue comment event: 7
- Push event: 21
- Pull request event: 3
- Fork event: 1
Last Year
- Create event: 7
- Release event: 5
- Issues event: 3
- Watch event: 18
- Delete event: 1
- Issue comment event: 7
- Push event: 21
- Pull request event: 3
- Fork event: 1
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| kyfrankie | k****e@g****m | 166 |
| Go Nam Lui | 3****5 | 6 |
| chris | c****e@g****m | 1 |
| Chris Nguyen | 5****E | 1 |
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 20
- Total pull requests: 29
- Average time to close issues: 4 months
- Average time to close pull requests: 15 days
- Total issue authors: 7
- Total pull request authors: 3
- Average comments per issue: 0.75
- Average comments per pull request: 0.1
- Merged pull requests: 23
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 5
- Pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: 1 minute
- Issue authors: 4
- Pull request authors: 1
- Average comments per issue: 1.2
- Average comments per pull request: 0.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- gmingas (7)
- kyfrankie (6)
- cathaypacific8747 (2)
- kovar-ursa (2)
- pos-ki (1)
- danhleth (1)
- andrewda (1)
Pull Request Authors
- kyfrankie (19)
- harrylui1995 (8)
- cathaypacific8747 (4)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 58 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 4
- Total maintainers: 1
pypi.org: airtrafficsim
A lightweight collection of tools for air traffic management research.
- Documentation: https://airtrafficsim.readthedocs.io/
- License: MIT License Copyright (c) 2024 Abraham Cheung Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
Latest release: 0.2.0a4
published 11 months ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/upload-artifact v1 composite
- openjournals/openjournals-draft-action master composite
- actions/cache v2 composite
- actions/checkout v3 composite
- conda-incubator/setup-miniconda v2 composite
- peaceiris/actions-gh-pages v3 composite
- actions/cache v2 composite
- actions/checkout v3 composite
- codecov/codecov-action v3 composite
- conda-incubator/setup-miniconda v2 composite
- @capacitor/cli 3.4.2 development
- @capacitor/app 1.1.1
- @capacitor/core 3.4.2
- @capacitor/haptics 1.1.4
- @capacitor/keyboard 1.2.2
- @capacitor/status-bar 1.0.8
- @craco/craco ^6.4.3
- @ionic/react ^6.0.0
- @ionic/react-router ^6.0.0
- @testing-library/jest-dom ^5.11.9
- @testing-library/react ^11.2.5
- @testing-library/user-event ^12.6.3
- @types/jest ^26.0.20
- @types/node ^12.19.15
- @types/react ^16.14.3
- @types/react-dom ^16.9.10
- @types/react-router ^5.1.11
- @types/react-router-dom ^5.1.7
- cesium ^1.91.0
- craco-cesium ^1.2.0
- ionicons ^5.4.0
- plotly.js-gl2d-dist-min ^2.11.1
- react ^17.0.1
- react-dom ^17.0.1
- react-plotly.js ^2.5.1
- react-router ^5.2.0
- react-router-dom ^5.2.0
- react-scripts ^5.0.0
- resium ^1.14.3
- socket.io-client ^4.4.1
- typescript ^4.1.3
- web-vitals ^0.2.4
- workbox-background-sync ^5.1.4
- workbox-broadcast-update ^5.1.4
- workbox-cacheable-response ^5.1.4
- workbox-core ^5.1.4
- workbox-expiration ^5.1.4
- workbox-google-analytics ^5.1.4
- workbox-navigation-preload ^5.1.4
- workbox-precaching ^5.1.4
- workbox-range-requests ^5.1.4
- workbox-routing ^5.1.4
- workbox-strategies ^5.1.4
- workbox-streams ^5.1.4
- docutils >=0.19
- furo *
- myst-parser *
- numpydoc *
- sphinx >=6.1.3
- sphinx-copybutton *
- Eventlet *
- Flask *
- Flask-SocketIO *
- cartopy *
- cdsapi *
- numpy *
- openap *
- pandas *
- xarray *
- cartopy
- cdsapi
- coverage
- eventlet
- flake8
- flake8-docstrings
- flask
- flask-socketio
- furo
- myst-parser
- numpy
- numpydoc
- openap
- pandas
- pytest
- python >=3.7
- sphinx
- sphinx-copybutton
- xarray