Installation#

Base requirements#

NeurIO requires Python 3.6 or higher. It is recommended to use a virtual environment to install NeurIO.

This library is available as a preview, installation from pip is not yet available.

You can also install NeurIO from source, by cloning the repository and running the setup script:

git clone https://github.com/csem/NeurIO
cd NeurIO
python setup.py install

NeurIO has several dependencies, which are automatically installed when using pip. To install them manually, run the following command:

pip install -r requirements.txt

To check the version of NeurIO installed, access the __version__ attribute of the package:

import neurio
print(neurio.__version__)python

The NeurIO documentation is based on Sphinx and can be built using the following command:

cd docs
make html

Once built, the documentation can be placed in neurio\docs\html. Open index.html in a web browser to start using the documentation.