Metadata-Version: 2.4
Name: aerocore
Version: 0.2.1
Summary: A lightweight collection of tools for air traffic management research.
Project-URL: Repository, https://github.com/abc8747/aerocore
Author-email: Abraham Cheung <abraham@ylcheung.com>
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.
License-File: LICENSE
Keywords: air transportation,atm,visualisation
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: isqx>=0.1.2
Requires-Dist: numpy>=2
Provides-Extra: all
Requires-Dist: httpx[http2]>=0.28.1; extra == 'all'
Requires-Dist: jax>=0.5.0; extra == 'all'
Requires-Dist: matplotlib>=3.10.0; extra == 'all'
Requires-Dist: polars[calamine]>=1.18.0; extra == 'all'
Requires-Dist: rich>=14.0.0; extra == 'all'
Requires-Dist: xarray>=2024.11.0; extra == 'all'
Provides-Extra: httpx
Requires-Dist: httpx[http2]>=0.28.1; extra == 'httpx'
Provides-Extra: jax
Requires-Dist: jax>=0.5.0; extra == 'jax'
Provides-Extra: matplotlib
Requires-Dist: matplotlib>=3.10.0; extra == 'matplotlib'
Provides-Extra: polars
Requires-Dist: polars[calamine]>=1.18.0; extra == 'polars'
Provides-Extra: rich
Requires-Dist: rich>=14.0.0; extra == 'rich'
Provides-Extra: xarray
Requires-Dist: xarray>=2024.11.0; extra == 'xarray'
Description-Content-Type: text/markdown

# aerocore

[![image](https://img.shields.io/pypi/v/aerocore.svg)](https://pypi.python.org/pypi/aerocore)
[![image](https://img.shields.io/pypi/l/aerocore.svg)](https://pypi.python.org/pypi/aerocore)
[![image](https://img.shields.io/pypi/pyversions/aerocore.svg)](https://pypi.python.org/pypi/aerocore)
[![image](https://img.shields.io/pypi/status/aerocore)](https://pypi.python.org/pypi/aerocore)

`aerocore` is a lightweight toolbox for air traffic management research. It only has two dependencies: [`numpy`](https://numpy.org/) and [`isqx` (a units library)](https://github.com/abc8747/isqx). Additional features are available when optional dependencies are installed.

It supports multiple numerical backends through the [Array API](https://data-apis.org/array-api), including JAX arrays and PyTorch tensors.

## Installation

`aerocore` is currently under heavy development and **not considered stable**. For the latest version:

```sh
# with pip
pip install aerocore
# with uv
uv add aerocore
```

Depending on your use case, you can pick the optional dependencies you need:

- `all`: install all optional dependencies
- `polars`: support for [polars](https://github.com/pola-rs/polars) and its Array API shim (postprocessing third party data)
- `httpx`: support for [httpx](https://github.com/encode/httpx) (downloading data from external sources)
- `xarray`: support for [xarray](https://github.com/pydata/xarray) (ARCO-ERA5 weather grids, working with NetCDF)
- `jax`: support for [JAX](https://github.com/jax-ml/jax) (automatic differentiation support)
- `matplotlib`: plotting

For example:

```sh
pip install "aerocore[httpx,polars]"
```

## Development

```sh
git clone https://github.com/abc8747/aerocore --depth=1
cd aerocore
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/aerocore/>.

### Contributing

PRs or issues are very welcome!

We use [Ruff](https://github.com/astral-sh/ruff) for linting and [MyPy](https://github.com/python/mypy) for type checking. Locally, run the following before committing:

```sh
just fmt
just check
```

License: MIT
