Installation

The recommended way to install Neuroscout-CLI is using containers (i.e. Docker or Singularity) to facilitate dependency managment.

For demonstration, it is possible to run Neuroscout-CLI in the cloud (for free!) using Google Colab.

Containerized Execution

Docker

DockerPulls

For most systems, we recommend using Docker. First, follow the instructions for installing Docker on your system.

Next, follow the Portable Docker Execution guide in the Neuroscout Docs.

Singularity

Singularity containers are a great solution for High Performance Computing (HPC) environments, where Docker cannot typically be used due to more tightly controlled user privileges.

First, check with your HPC administrator that Singularity is available for use. If so, follow our guide on Singularity for HPCs in the offical Neuroscout Docs.

Google Colab

To try Neuroscout without using any local resources, follow our interactive guide to Cloud execution on Google Colab.

Google Colab allows you to execute Jupyer Notebooks for free, using two CPUs for several hours. This should be sufficient for individual Neuroscout analyses. A small demonstration can be run live in ~15 mins.

Manually prepared environment using pip

Danger

Manually installing neuroscout-cli can be difficult due to complex dependencies in the SciPy stack, or fMRI-specific tooling. Proceed only if you know what you’re doing.

Use pip to install neuroscout-cli from PyPI:

pip install neuroscout-cli