Skip to content

Installation

Requirements

  • Python 3.12+
  • uv (recommended) or pip

Install with pip

pip install synamine

Optional dependencies

# Visualization (Graphviz + Matplotlib)
pip install "synamine[viz]"

# Machine learning
pip install "synamine[ml]"

# LLM integration
pip install "synamine[llm]"

# Everything
pip install "synamine[all]"

Install with uv (from source)

git clone https://github.com/captain-red-baron/synamine-core.git
cd synamine-core
uv sync

Optional dependencies with uv

uv sync --extra viz    # visualization
uv sync --extra ml     # machine learning
uv sync --extra all    # everything

System dependencies

Graphviz binary

For DFG, Petri Net, and Process Tree visualization, you need the Graphviz system binary installed:

brew install graphviz

sudo apt install graphviz

Download the installer from graphviz.org.

Development setup

git clone https://github.com/captain-red-baron/synamine-core.git
cd synamine-core
uv sync --extra viz       # install all deps including viz
uv run pre-commit install # set up pre-commit hooks