Metadata-Version: 2.3
Name: ADeT
Version: 0.0.1rc0
Summary: Autodiff DEsigner for Turbomachinery
Author: Francesco Vaccari
Author-email: Francesco Vaccari <f.vaccari@tudelft.nl>
Requires-Dist: ambiance>=1.3.1
Requires-Dist: art>=6.5
Requires-Dist: casadi>=3.7.2
Requires-Dist: coolprop>=7.1.0
Requires-Dist: jax>=0.9.2
Requires-Dist: matplotlib>=3.10.7
Requires-Dist: pint>=0.25
Requires-Dist: sympy>=1.14.0
Requires-Dist: tabulate>=0.9.0
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# ADeT
**A**utodiff **De**signer for **T**urbomachinery

A Python library for equation-oriented modeling, with a focus on turbomachinery problems.

<!-- <p align="center"> -->
<!--     <img src="docs/sphinx/images/repeated_meridional.svg"  style="width: 65%"> -->
<!-- </p> -->

## Features

- **Flexible**: Model turbines and compressors of axial, mixed-flow or radial type 
- **Equation-oriented**: Define physics symbolically with residual equations
- **CoolProp**: Integration of real gas properties
- **Automatic differentiation**: Fully differentiable formulation through [CasaDi](https://web.casadi.org/)
- **Unit-aware**: [Pint](https://github.com/hgrecco/pint) integration for automatic unit checking and conversion
- **Modular**: Define your own components and assemble them


## Getting Started

- Check out the **[DOCUMENTATION](https://fvaccari1.bitbucket.io/index.html)**
- Check out the **[REPOSITORY](https://github.com/Propulsion-Power-TU-Delft/adet)**

<!---->
<!-- ### Installation -->
<!-- This project uses [uv](https://docs.astral.sh/uv) for packaging and dependency management. -->
<!---->
<!-- 1. Clone this repository -->
<!-- 2. [Install `uv`](https://docs.astral.sh/uv/getting-started/installation/) -->
<!-- 3. Navigate to the project root directory -->
<!-- 4. Install dependencies: -->
<!--    ```bash -->
<!--    uv sync                    # Install base dependencies -->
<!--    uv sync --all-groups       # Install dev and docs dependencies -->
<!--    ``` -->
<!-- > **Note**: To access [REFPROP](https://www.nist.gov/srd/refprop) through CoolProp, see the [integration guide](https://coolprop.org/coolprop/REFPROP.html). -->
<!---->
<!-- ## Development -->
<!---->
<!-- We use the following development tools: -->
<!---->
<!-- - **[Ruff](https://docs.astral.sh/ruff)**: Linting and formatting -->
<!-- - **[ty](https://github.com/bnemetis/ty)**: Static type checking -->
<!---->
<!-- Rules are included in `pyproject.toml` and should be read automatically.  -->
<!-- These tools can be used via CLI or integrated directly into your IDE. -->
