Installation#

To install NeuroCAPs, follow the instructions below using your preferred terminal.

Standard Installation from PyPi#

pip install neurocaps

Windows Users#

To avoid installation errors related to long paths not being enabled, PyBIDS will not be installed by default. Refer to official Microsoft documentation to enable long paths.

To include PyBIDS in your installation, use:

pip install neurocaps[windows]

Alternatively, you can install PyBIDS separately:

pip install pybids

Installation from Source (Development Version)#

To install the latest development version from the source, there are two options:

  1. Install directly via pip:

pip install git+https://github.com/donishadsmith/neurocaps.git

  1. Clone the repository and install locally:

git clone --depth 1 https://github.com/donishadsmith/neurocaps/
cd neurocaps
pip install -e .
# Clone with submodules to include test dataset ~140 MB
git submodule update --init

Windows Users#

To include PyBIDS when installing the development version on Windows, use:

git clone --depth 1 https://github.com/donishadsmith/neurocaps/
cd neurocaps
pip install -e .[windows]
# Clone with submodules to include test dataset ~140 MB
git submodule update --init

Docker#

If Docker is available on your system, you can use the NeuroCAPs Docker image, which includes the demos and configures a headless display for VTK.

To pull the Docker image:

docker pull donishadsmith/neurocaps && docker tag donishadsmith/neurocaps neurocaps

The image can be run as:

  1. An interactive bash session (default):

docker run -it neurocaps

  1. A Jupyter Notebook with port forwarding:

docker run -it -p 9999:9999 neurocaps notebook