Installation¶

FlooGen is distributed as a standard Python package available on PyPI. It provides the floogen command-line interface (CLI) to generate your networks.

Prerequisites¶

Python: Version 3.10 or higher.
Git: To clone the repository (only required for source installation).

Install from PyPI¶

If you just want to use the tool to generate networks, install it directly from PyPI with either uv (recommended) or pip.

uvpip

To install globally (recommended): This makes the floogen command available everywhere in your terminal.

uv tool install floogen
# and verify installation
floogen --help

To run without installing (ephemeral): You can run FlooGen instantly without cluttering your system:

uvx floogen --help

Create and activate a virtual environment (recommended):
```
python3 -m venv .venv
source .venv/bin/activate
```
Install the package:
```
pip install floogen
```
Verify installation:
```
floogen --help
```

Install from Source¶

Use this method if you need to modify FlooGen, contribute to the project, or if you are working with the full FlooNoC hardware repository.

First, clone the FlooNoC repository:

git clone https://github.com/pulp-platform/FlooNoC.git && cd FlooNoC

uvpip

When using uv inside the repository, no manual installation step is strictly necessary. uv will automatically detect the project configuration.

uv run floogen --help

This command will automatically set up the environment and install dependencies defined in pyproject.toml.

Create and activate a virtual environment:

python3 -m venv .venv
source .venv/bin/activate

Install in editable mode:
```
pip install -e .
```

Documentation¶

The documentation is built using zensical, which is defined as a development dependency. To build it you can run:

uvpip

uv run zensical build

The development dependencies are implicit in uv i.e. uv run --group dev is not necessary.

Create and activate a virtual environment (if not already done):
```
python3 -m venv .venv
source .venv/bin/activate
```
Install the development dependencies:
```
pip install .[dev]
```

If you want to serve the documentation locally for easier browsing, run:

uvpip

uv run zensical serve -o

zensical serve -o