Installation

This page describes how to install Topolib for both users and developers.

Basic installation (recommended):

pip install topolib

Development installation:

Clone the repository and install in editable mode with development dependencies:

git clone https://gitlab.com/DaniloBorquez/topolib.git
cd topolib
python -m venv .venv
source .venv/bin/activate
pip install -U pip
pip install -e .
pip install -r dev-requirements.txt

Requirements:

Python >= 3.10
See pyproject.toml for all dependencies

Note

Optional: PNG Export

To export visualizations as PNG images, you need selenium and a webdriver (chromedriver or geckodriver):

pip install selenium

Then install chromedriver or geckodriver for your system. This is only required for PNG export; HTML visualization works without it.

For more details, see the README or the [examples](../../examples/) folder.