Installation¶

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

PyPI Availability

FlooGen is currently not published on PyPI. You must clone the repository and install it locally from the source.

Prerequisites¶

Python: Version 3.10 or higher.
Git: To clone the repository.

First, clone the FlooNoC repository:

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

Then install FlooGen using with either uv or pip. We recommend using uv for installation. It is significantly faster than pip and automatically manages virtual environments and dependencies for you, keeping your system Python clean. However, if you prefer the standard Python workflow, pip works just as well.

uvpip

Install uv (if you haven't already):

curl -LsSf https://astral.sh/uv/install.sh | sh

Run with uv: You can run FlooGen directly in an ephemeral environment without manual installation:
```
uv run floogen --help
```

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

Verification¶

To verify that the installation was successful, try running the help command. You should see the CLI usage information.

uvpip

uv run floogen --help

floogen --help

Development & Documentation¶

If you plan to contribute to FlooGen or build the documentation locally, you should install the optional dependencies.

uvpip

# Nothing to do, `uv run --groups dev|docs` will download dependencies automatically

pip install .[dev,docs]

The documentation is built using Zensical. To build the documentation locally, run:

uvpip

uv run --group docs zensical build

zensical build

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

uvpip

uv run --group docs zensical serve -o

zensical serve -o