hip-controller

Simple README.md for a Python project template.

Install

To install the library from PyPI:

uv pip install hip-controller==latest

OR

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

Development

0. Install uv from Astral.
1. git clone git@github.com:TUM-Aries-Lab/hip-controller.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/hip-controller

Module Usage

"""Basic docstring for my module."""

from loguru import logger

from hip_controller import definitions

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

if __name__ == "__main__":
    main()

Program Usage

uv run python -m hip_controller

Structure

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

├── data
│   ├── logs
│   └── sensor_data
│       └── raw_data
│           ├── data_input_2025_12_17.csv
│           ├── data_input_2026_01_09.csv
│           └── data_raw_2025_12_17.xlsx
├── docs
│   └── paper.pdf
├── src
│   └── hip_controller
│       ├── control
│       │   ├── __init__.py
│       │   ├── high_level.py
│       │   ├── kalman.py
│       │   ├── low_level.py
│       │   └── state_space.py
│       ├── __init__.py
│       ├── __main__.py
│       ├── app.py
│       ├── definitions.py
│       ├── math_utils.py
│       └── utils.py
├── tests
│   ├── controller_test
│   │   ├── high_level_controller
│   │   │   ├── high_level_testing_data
│   │   │   │   ├── ang_ss_2026_01_26.csv
│   │   │   │   ├── extrema_2026_01_26.csv
│   │   │   │   ├── gait_phase_left_2026_01_21.csv
│   │   │   │   ├── sinusoidal_behavior_left_2026_01_29.csv
│   │   │   │   ├── valid_trigger_left_2026_01_15.csv
│   │   │   │   ├── vel_ss_2026_01_26.csv
│   │   │   │   └── zero_crossing_left_2026_01_09.csv
│   │   │   └── high_level_test.py
│   │   └── kalman_test.py
│   ├── __init__.py
│   ├── app_test.py
│   ├── conftest.py
│   ├── math_utils_test.py
│   └── utils_test.py
├── .darglint
├── .dockerignore
├── .gitignore
├── .pre-commit-config.yaml
├── .python-version
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── pyproject.toml
├── repo_tree.py
└── uv.lock