ao-compensation-model 0.1.0

A GRU model that improves the performance of adaptive oscillators in stop-go and go-stop situations.

ao_compensation_model

Simple README.md for a Python project template.

Install

To install the library from PyPI:

uv pip install ao_compensation_model==latest

OR

uv add git+https://github.com/TUM-Aries-Lab/ao_compensation_model.git@<specific-tag>  # needs credentials

Development

0. Install uv from Astral.
1. git clone [e-mail]: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:

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

"""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

uv run python -m ao_compensation_model

Structure

The following tree shows the important permanent files. Run make tree to update.

├── 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