Installation

This guide helps you to get py-capellambse installed. There are a few ways to get it done:

Install from PyPI

Installing py-capellambse from Python Package Index via pip is the quickest way to get started.

pip install capellambse

Windows

If you intend to use py-capellambse’s PNG export functionality, you need a working installation of cairosvg. Unfortunately, the Windows wheels on PyPI do not ship with all necessary libraries. However, they can be manually installed with the GTK for Windows Runtime Environment Installer.

This should give you a fully functioning py-capellambse.

Install as a package from Github

If you want to have a comfortable playground with examples / Jupyter notebooks / export to excel demo and test models you may clone the repository directly from Github, create a virtual environment and install all the extras:

git clone https://github.com/DSD-DBS/py-capellambse.git
cd py-capellambse
python3 -m venv .venv
source .venv/bin/activate
pip install .
pip install jupyter
cd examples
jupyter-notebook

Install for development

In case you’d like to contribute to the development or improve documentation, sample models or examples collection please follow the contribution guide.