Skip to content

Installation¤

Quick Start¤

Create Virtual Environment¤

python -m venv venv

Activate Virtual Environment¤

On macOS/Linux:

source venv/bin/activate

On Windows:

venv\Scripts\activate

Install KymFlow with GUI¤

pip install kymflow[gui]

Run the GUI¤

kymflow-gui

The GUI will open in your default web browser at http://localhost:8080 (or the next available port).

Installation Options¤

GUI Application Only¤

pip install kymflow[gui]

Python API Only (No GUI)¤

pip install kymflow

Development Installation¤

For development, install in editable mode with all extras:

git clone https://github.com/mapmanager/kymflow.git
cd kymflow
pip install -e ".[gui,test,notebook]"

Requirements¤

  • Python 3.11 or higher
  • See pyproject.toml for full dependency list
All material is Copyright 2011-2023 Robert H. Cudmore