Skip to main content

Installation

Install from GitHub

neuroboros is under active development, so install the latest version directly from the GitHub repository:

pip install git+https://github.com/neuroboros/neuroboros.git

Run the same command again to upgrade to the latest version. It depends on NumPy, SciPy, nibabel, pandas, matplotlib, joblib, Pillow, and requests, which pip installs automatically. Python 3.8 or newer is recommended.

Optional packages

Hyperalignment analyses use the separate hyperalignment package, also installed from GitHub:

pip install git+https://github.com/feilong/hyperalignment.git

Check the installation

import neuroboros as nb

print(nb.__version__)

Where data is stored

Brain templates and datasets are downloaded on first use and cached under ~/.neuroboros-data. To use a different location, for example a shared directory on a cluster, set the NEUROBOROS_DATA_DIR environment variable before starting Python:

export NEUROBOROS_DATA_DIR=/path/to/neuroboros-data

Downloads work over plain HTTPS and need no extra software. Using DataLad for faster or partial downloads, and pointing neuroboros at local copies of datasets, are covered in a later guide page.