Install

Requirements

  • Python 3.11+

From PyPI

pip install unitflow

For NumPy-backed array quantities and ufunc integration:

pip install unitflow[numpy]

The core library has no required dependencies. NumPy is optional.

Verify

python -c "import unitflow; print('ok')"

Documentation

Project and ecosystem documentation: thundergraph.ai.

Develop from a clone

From the repository root (the folder that contains pyproject.toml and unitflow/):

uv sync
uv run pytest tests/ -q

For building this Sphinx site, also sync the docs group:

uv sync --group docs
uv run sphinx-build -b html docs/user_docs docs/user_docs/_build/html