Installation¶

Homeostat needs Python 3.11 or newer. Its dependencies are NumPy, pandas, Pydantic and PyYAML.

Install from GitHub¶

Homeostat is not yet publicly released; when it is, it will be published on PyPI. With access to its repository, install it from GitHub:

uv add git+https://github.com/kausalflow/homeostat

pip install git+https://github.com/kausalflow/homeostat

Check the installation:

python -c "import homeostat; print(homeostat.__version__)"

Work on the source¶

To run the examples and the tests, or to change Homeostat itself, clone the repository (with access to it) and let uv create the environment:

git clone https://github.com/kausalflow/homeostat
cd homeostat
uv sync
uv run pytest

The examples in examples/ then run with uv run python examples/<name>.py. See Development for the tests, the documentation and the conventions.

Reproducibility¶

The same scenario, seed, Homeostat version and NumPy version give identical data. Every run records all four in run.meta["reproducibility"], so keep NumPy pinned (for example with a lock file) when you need to regenerate a dataset exactly.