Metadata-Version: 2.4
Name: avl-aero-tables
Version: 1.0.1
Summary: Generate aerodynamic lookup tables using AVL (Athena Vortex Lattice)
Author: Brian Borra
License: MIT
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: matplotlib
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pandas-stubs; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=7; extra == "docs"
Requires-Dist: sphinx-book-theme; extra == "docs"
Requires-Dist: myst-parser; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinxcontrib-mermaid; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: sphinx-autobuild; extra == "docs"
Dynamic: license-file

# Python AVL Wrapper

![Tests](https://github.com/brio50/avl-aero-tables/actions/workflows/test.yml/badge.svg)

A Python wrapper for [AVL](https://web.mit.edu/drela/Public/web/avl/) (Athena Vortex Lattice) by Mark Drela and Harold Youngren (MIT). Drives AVL via stdin command scripts, parses its `.st` output, and returns structured Python data — no manual file editing required.

## Install

```bash
pip install avl-aero-tables
```

Requires Python 3.12+ and the AVL binary installed at `~/bin/avl`.

## Documentation

Full installation guide, walkthrough, API reference, and more at the [docs site](https://brio50.github.io/AVL-Aero-Tables/).

## Quick look

```python
from avl_aero_tables import avl_fileread, avl_fileplot, avl, aero_filewrite, aero_fileplot

geom    = avl_fileread("examples/bd.avl")          # parse geometry
fig     = avl_fileplot(geom)                        # four-view plot
results = avl("examples/bd.avl", alpha, beta)       # run AVL sweep
aero    = aero_filewrite(results)                   # build lookup tables
figs    = aero_fileplot(aero)                       # plot aero database
```

## References

- [AVL homepage](https://web.mit.edu/drela/Public/web/avl/)
- [AVL User Primer](https://web.mit.edu/drela/Public/web/avl/AVL_User_Primer.pdf)
