Installation¶

From PyPI (recommended)¶

pip install neurodesign-plus

This installs the package and all required dependencies. You can then use it as:

from neurodesign import Experiment, Design, Optimisation

Note

The PyPI package is called neurodesign-plus, but the Python import remains neurodesign. This fork replaces the upstream neurodesign package – do not install both.

From Source (development)¶

For development or to access the latest unreleased changes:

1. Clone the repository¶

git clone https://github.com/SLDlab/neurodesign-plus.git
cd neurodesign-plus

2. Create a virtual environment¶

python -m venv .venv

3. Activate the virtual environment¶

macOS / Linux:

source .venv/bin/activate

Windows (PowerShell):

.venv\Scripts\Activate.ps1

4. Install in editable mode¶

pip install -e ".[dev]"

This installs the package in editable mode along with all development dependencies (testing, linting, documentation).

5. (Optional) Jupyter kernel¶

If you are working with the tutorial notebooks, register the environment as a Jupyter kernel:

python -m ipykernel install --user --name=neurodesign-plus --display-name "Python (neurodesign-plus)"