Metadata-Version: 2.4
Name: ao_compensation_model
Version: 0.1.0
Summary: A GRU model that improves the performance of adaptive oscillators in stop-go and go-stop situations.
Project-URL: homepage, https://github.com/TUM-Aries-Lab/ao_compensation_model
Author-email: Tony Smoragiewicz <tony.smoragiewicz@tum.de>, Liuhan Huang <liuhan.huang@tum.de>
License-File: LICENSE
Requires-Python: <3.14,>=3.11
Requires-Dist: joblib>=1.4
Requires-Dist: loguru>=0.7.3
Requires-Dist: matplotlib>=3.9
Requires-Dist: numpy>=2.2.3
Requires-Dist: pandas>=2.2
Requires-Dist: scikit-learn>=1.6
Requires-Dist: scipy>=1.14
Requires-Dist: tensorflow>=2.18
Provides-Extra: dev
Requires-Dist: coveralls>=4.0.1; extra == 'dev'
Requires-Dist: pre-commit>=4.1.0; extra == 'dev'
Requires-Dist: pyright>=1.1.407; extra == 'dev'
Requires-Dist: pytest-cov>=6.0; extra == 'dev'
Requires-Dist: pytest>=8.3; extra == 'dev'
Requires-Dist: ruff>=0.6.9; extra == 'dev'
Provides-Extra: hw
Requires-Dist: ai-edge-litert>=1.2; extra == 'hw'
Provides-Extra: no-hw
Description-Content-Type: text/markdown

# ao_compensation_model

[![Coverage Status](https://coveralls.io/repos/github/TUM-Aries-Lab/ao_compensation_model/badge.svg?branch=main)](https://coveralls.io/github/TUM-Aries-Lab/ao_compensation_model?branch=main)
![Docker Image CI](https://github.com/TUM-Aries-Lab/ao_compensation_model/actions/workflows/ci.yml/badge.svg)

Simple README.md for a Python project template.

## Install

To install the library from PyPI:

```bash
uv pip install ao_compensation_model==latest
```
OR
```bash
uv add git+https://github.com/TUM-Aries-Lab/ao_compensation_model.git@<specific-tag>  # needs credentials
```

## Development
0. Install [uv](https://docs.astral.sh/uv/getting-started/installation/) from Astral.
1. `git clone git@github.com:TUM-Aries-Lab/ao_compensation_model.git`
2. `make init` to create the virtual environment and install dependencies
3. `make format` to format the code and check for errors
4. `make test` to run the test suite
5. `make clean` to delete the temporary files and directories


## Publishing
It's super easy to publish your own packages on PyPI. To build and publish this package run:

```bash
uv build
uv publish  # make sure your version in pyproject.toml is updated
```
The package can then be found at: https://pypi.org/project/ao_compensation_model

## Module Usage
```python
"""Basic docstring for my module."""

from loguru import logger

from ao_compensation_model import definitions

def main() -> None:
    """Run a simple demonstration."""
    logger.info("Hello World!")

if __name__ == "__main__":
    main()
```

## Program Usage
```bash
uv run python -m ao_compensation_model
```

## Structure
The following tree shows the important permanent files. Run `make tree` to update.
<!-- TREE-START -->
```
├── src
│   └── ao_compensation_model
│       ├── __init__.py
│       ├── __main__.py
│       ├── app.py
│       ├── definitions.py
│       └── utils.py
├── tests
│   ├── __init__.py
│   ├── conftest.py
│   ├── app_test.py
│   └── utils_test.py
├── .dockerignore
├── .gitignore
├── .pre-commit-config.yaml
├── .python-version
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── pyproject.toml
├── repo_tree.py
└── uv.lock
```
<!-- TREE-END -->
