Installation

Minimal

To install hetero, follow these steps. You need to have uv and `git` installed on your machine.

git clone https://gitlab.gwdg.de/golmohammadi/hetero.git
cd hetero
uv venv --python 3.13
source .venv/bin/activate
uv pip install -e .

With local documentation

If you want to create this documentation locally, replace the last line with the following lines:

uv pip install -e .[docs]
cd docs
sphinx-build -a -b html . build/html

which creates the documentation file at docs/build/html/index.html.

With demos

If you want to be able to run demos as well, run the following instead:

uv pip install -e .[demo]

Maximal

Nice! Run this:

uv pip install -e .[dev,docs,demo]
cd docs
sphinx-build -a -b html . build/html