Installation

Requires Python 3.10-3.14.

Standard Installation

pip install neurocaps

Windows Users: Enable long paths and use:

pip install neurocaps[windows]

Development Version

git clone --depth 1 https://github.com/donishadsmith/neurocaps/
cd neurocaps
pip install -e .

# For windows
# pip install -e .[windows]

# Clone with submodules to include test data ~140 MB
git submodule update --init

Docker

A Docker image is available with demos and headless VTK display configured:

# Pull image
docker pull donishadsmith/neurocaps && docker tag donishadsmith/neurocaps neurocaps

# Run interactive bash
docker run -it neurocaps

# Run Jupyter Notebook
docker run -it -p 9999:9999 neurocaps notebook