Installation

py_neuromodulation requires at least python 3.11. For installation you can use pip:

pip install py-neuromodulation

We recommend, however, using the package manager uv, and setting up a clean virtual environment:

git clone https://github.com/neuromodulation/py_neuromodulation.git
uv python install 3.11
uv venv

And then activating the virtual environment e.g. in Windows using:

.\.venv\Scripts\activate

or in unix-based systems:

source .venv/bin/activate

Then install the packages listed in the pyproject.toml:

uv sync

The GUI can then simply be started by running:

run_gui

If needed, install the documentation dependencies:

uv pip install -e .[docs]

Alternatively, you can also install the package in a conda environment:

conda create -n pynm-test python=3.11 conda activate pynm-test

Then install the packages listed in the pyproject.toml:

pip install .