Installation

User install

With pipx (recommended)

Use pipx to install chaste-sbml into its own isolated environment and put the command on your PATH, without touching other Python packages:

pipx install git+https://github.com/Chaste/chaste-sbml@0.0.1

Note

Replace @0.0.1 with @x.y.z to install a specific released version, or omit it to install the latest development version.

Verify the installation:

chaste-sbml --version

With pip

Create and activate a virtual environment (optional):

python3 -m venv .venv
source .venv/bin/activate

Install the package:

python3 -m pip install git+https://github.com/Chaste/chaste-sbml@0.0.1

Note

Replace @0.0.1 with @x.y.z to install a specific released version, or omit it to install the latest development version.

Verify the installation:

chaste-sbml --version

Developer install

Clone the repository:

git clone https://github.com/Chaste/chaste-sbml
cd chaste-sbml

Create and activate a virtual environment:

python3 -m venv .venv
source .venv/bin/activate

Install the local copy in editable mode with the dev dependencies:

python3 -m pip install -e ."[dev]"

Run the test suite:

python3 -m pytest

To build the documentation locally, install the docs extra and run make:

python3 -m pip install -e ."[docs]"
make -C doc livehtml      # live-reloading preview (full rebuilds)
make -C doc clean html    # one-off clean build

Note

Incremental documentation builds can leave stale HTML behind in some cases. If there are problems with rendering after updating markdown, try doing a clean rebuild.