Installation

neurodesign-plus is the install distribution. neurodesign is the import package.

End-User Installation From PyPI

python -m pip install --upgrade pip
python -m pip install neurodesign-plus

Use it as:

from neurodesign import Experiment, Design, Optimisation

The base install already includes report-generation dependencies. No separate report extra exists in pyproject.toml.

Local Source Installation

Clone the repository and create a virtual environment:

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

Activate the environment:

macOS / Linux:

source .venv/bin/activate

Windows PowerShell:

.\.venv\Scripts\Activate.ps1

Install the local checkout:

python -m pip install .

Editable Development Installation

Install the editable package plus the declared development extras:

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

The dev extra includes the maintained doc and test extras plus pre-commit and tox.

Test And Notebook Dependencies

Install the package plus the declared testing and notebook execution dependencies:

python -m pip install -e ".[test]"

Documentation Dependencies

Install the package plus the maintained Sphinx toolchain:

python -m pip install -e ".[doc]"

Version-2 Migration

Version 2.0 is a clean breaking API release. Use the migration guide for version-1 name mapping and workflow changes instead of trying to preserve removed timing aliases in-place.