| Name | AirTrafficSim JSON |
| Version |
0.2.0a4
JSON |
| download |
| home_page | None |
| Summary | A lightweight collection of tools for air traffic management research. |
| upload_time | 2025-02-05 07:11:08 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| 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. |
| keywords |
air transportation
atm
simulations
visualisation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# AirTrafficSim
[](https://pypi.python.org/pypi/airtrafficsim)
[](https://pypi.python.org/pypi/airtrafficsim)
[](https://pypi.python.org/pypi/airtrafficsim)
[](https://pypi.python.org/pypi/airtrafficsim)
<img src="docs/assets/img/Logo-full.png" width=50% />
AirTrafficSim is a lightweight collection of tools for air traffic management research.
This branch (`v0.2`) contains the rewrite of the older `v0.1`[^1] version.
It aims to be significantly more accessible, with absolutely minimal dependencies by default. Extra features (e.g. full web-based simulation environment) must be enabled manually with feature flags.
## Features
- support for modern automatic differentiation (via JAX)
- support for the [Array API](https://data-apis.org/array-api): Numpy, JAX, PyTorch, CuPy arrays can be passed into functions
- partial support for `polars.Expr` with plugin
- BADA3 ISA atmosphere model
- thermodynamic calculations
## Installation
`v0.2` is currently under heavy development and not considered stable. For the latest alpha version:
```sh
pip install airtrafficsim
```
For the latest bleeding-edge version:
```sh
pip install "https://github.com/HKUST-OCTAD-LAB/AirTrafficSim/archive/dev.zip"
```
### Feature Flags
Using the command above will install a version with very minimal footprint. Depending on your use case, you can select one or more optional dependencies:
- `all`: install all optional dependencies
- `polars`: support for polars DataFrame (used in simulation and postprocessing third party data)
- `networking`: support for downloading data from external third party sources
- `era5`: support for parsing NetCDF for Google ARCO ERA5.
- `jax`: support for automatic differentiation
- `plot`: utils for nicer plotting
For example:
```sh
pip install "airtrafficsim[networking,polars]"
```
## Development
```sh
git clone https://github.com/HKUST-OCTAD-LAB/AirTrafficSim -b dev --depth=1
cd AirTrafficSim
uv venv
uv sync --all-extras --all-groups
```
To run scripts:
```sh
uv run examples/autodiff.py
```
Alternatively, activate your virtualenv:
```sh
source .venv/bin/activate
python3 examples/autodiff.py
```
### Documentation
```sh
uv run mkdocs serve
```
Then, navigate to http://127.0.0.1:8000/AirTrafficSim/.
### Contributing
1. Follow [Black](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html) style.
2. Prefer pure functions over deep inheritance hierarchies.
3. Use typed code whenever possible.
We use the following tools to check the style on each push:
- [Ruff](https://github.com/astral-sh/ruff) for linting,
- [MyPy](https://github.com/python/mypy) for type checking
Locally, run the following before committing:
```sh
chmod +x ./scripts/style-check.sh
./scripts/style-check.sh
```
Recommended VSCode extensions: `charliermarsh.ruff`, `matangover.mypy`, `usernamehw.errorlens`, `ms-toolsai.jupyter`
[^1]: The latest commit can be viewed [here](https://github.com/HKUST-OCTAD-LAB/AirTrafficSim/commit/7a3c3249e602ad17c4b27c7bf900e571d9f7feea). It is considered deprecated and will not receieve futher updates.
## License
Unlike `v0.1` (GPLv3), this branch is licensed under the more permissive [MIT License](./LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "AirTrafficSim",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "air transportation, atm, simulations, visualisation",
"author": null,
"author_email": "Frankie Hui <kyhuiaf@connect.ust.hk>, Abraham Cheung <abraham@ylcheung.com>",
"download_url": "https://files.pythonhosted.org/packages/dd/10/a65c095e34a51cd5de34f5d5cb9511504fab8cd9cd4b964f87beaf74dc1c/airtrafficsim-0.2.0a4.tar.gz",
"platform": null,
"description": "# AirTrafficSim\n\n[](https://pypi.python.org/pypi/airtrafficsim)\n[](https://pypi.python.org/pypi/airtrafficsim)\n[](https://pypi.python.org/pypi/airtrafficsim)\n[](https://pypi.python.org/pypi/airtrafficsim)\n\n<img src=\"docs/assets/img/Logo-full.png\" width=50% />\n\nAirTrafficSim is a lightweight collection of tools for air traffic management research.\n\nThis branch (`v0.2`) contains the rewrite of the older `v0.1`[^1] version.\n\nIt aims to be significantly more accessible, with absolutely minimal dependencies by default. Extra features (e.g. full web-based simulation environment) must be enabled manually with feature flags.\n\n## Features\n\n- support for modern automatic differentiation (via JAX)\n- support for the [Array API](https://data-apis.org/array-api): Numpy, JAX, PyTorch, CuPy arrays can be passed into functions\n - partial support for `polars.Expr` with plugin\n- BADA3 ISA atmosphere model\n- thermodynamic calculations\n\n## Installation\n\n`v0.2` is currently under heavy development and not considered stable. For the latest alpha version:\n\n```sh\npip install airtrafficsim\n```\n\nFor the latest bleeding-edge version:\n\n```sh\npip install \"https://github.com/HKUST-OCTAD-LAB/AirTrafficSim/archive/dev.zip\"\n```\n\n### Feature Flags\n\nUsing the command above will install a version with very minimal footprint. Depending on your use case, you can select one or more optional dependencies:\n\n- `all`: install all optional dependencies\n- `polars`: support for polars DataFrame (used in simulation and postprocessing third party data)\n- `networking`: support for downloading data from external third party sources\n- `era5`: support for parsing NetCDF for Google ARCO ERA5.\n- `jax`: support for automatic differentiation\n- `plot`: utils for nicer plotting\n\nFor example:\n\n```sh\npip install \"airtrafficsim[networking,polars]\"\n```\n\n## Development\n\n```sh\ngit clone https://github.com/HKUST-OCTAD-LAB/AirTrafficSim -b dev --depth=1\ncd AirTrafficSim\nuv venv\nuv sync --all-extras --all-groups\n```\n\nTo run scripts:\n\n```sh\nuv run examples/autodiff.py\n```\n\nAlternatively, activate your virtualenv:\n\n```sh\nsource .venv/bin/activate\npython3 examples/autodiff.py\n```\n\n### Documentation\n\n```sh\nuv run mkdocs serve\n```\n\nThen, navigate to http://127.0.0.1:8000/AirTrafficSim/.\n\n### Contributing\n\n1. Follow [Black](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html) style. \n2. Prefer pure functions over deep inheritance hierarchies.\n3. Use typed code whenever possible.\n\nWe use the following tools to check the style on each push:\n\n- [Ruff](https://github.com/astral-sh/ruff) for linting,\n- [MyPy](https://github.com/python/mypy) for type checking \n\nLocally, run the following before committing:\n\n```sh\nchmod +x ./scripts/style-check.sh\n./scripts/style-check.sh\n```\n\nRecommended VSCode extensions: `charliermarsh.ruff`, `matangover.mypy`, `usernamehw.errorlens`, `ms-toolsai.jupyter`\n\n[^1]: The latest commit can be viewed [here](https://github.com/HKUST-OCTAD-LAB/AirTrafficSim/commit/7a3c3249e602ad17c4b27c7bf900e571d9f7feea). It is considered deprecated and will not receieve futher updates.\n\n## License\n\nUnlike `v0.1` (GPLv3), this branch is licensed under the more permissive [MIT License](./LICENSE).",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2024 Abraham Cheung\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "A lightweight collection of tools for air traffic management research.",
"version": "0.2.0a4",
"project_urls": {
"Repository": "https://github.com/HKUST-OCTAD-LAB/AirTrafficSim"
},
"split_keywords": [
"air transportation",
" atm",
" simulations",
" visualisation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "09ec440208c8d448f92c505a3acaba44436d8d5cb53b5bc1e106b8d9154d685a",
"md5": "85eca501ef455cd314a0659b9c79504a",
"sha256": "a53275f72cbec1c359db2aa66ff3d9fdc056878928b6736df360a2837e6b99e1"
},
"downloads": -1,
"filename": "airtrafficsim-0.2.0a4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "85eca501ef455cd314a0659b9c79504a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 31269,
"upload_time": "2025-02-05T07:11:06",
"upload_time_iso_8601": "2025-02-05T07:11:06.016428Z",
"url": "https://files.pythonhosted.org/packages/09/ec/440208c8d448f92c505a3acaba44436d8d5cb53b5bc1e106b8d9154d685a/airtrafficsim-0.2.0a4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "dd10a65c095e34a51cd5de34f5d5cb9511504fab8cd9cd4b964f87beaf74dc1c",
"md5": "3f37c474e285a8a6170026da0020bdc1",
"sha256": "bce1c06d0f88788e42c13c523917b22dcb8acb90e164714e928e0525b57eea6e"
},
"downloads": -1,
"filename": "airtrafficsim-0.2.0a4.tar.gz",
"has_sig": false,
"md5_digest": "3f37c474e285a8a6170026da0020bdc1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 672811,
"upload_time": "2025-02-05T07:11:08",
"upload_time_iso_8601": "2025-02-05T07:11:08.863443Z",
"url": "https://files.pythonhosted.org/packages/dd/10/a65c095e34a51cd5de34f5d5cb9511504fab8cd9cd4b964f87beaf74dc1c/airtrafficsim-0.2.0a4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-05 07:11:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "HKUST-OCTAD-LAB",
"github_project": "AirTrafficSim",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "airtrafficsim"
}
