Installation and Help

Installation

siibra is available on pypi. To install the latest released version, simply run pip install siibra. The installation typically takes about 2 minutes on a standard computer where Python is already installed. In order to work with the latest version from github, use pip install git+https://github.com/FZJ-INM1-BDA/siibra-python.git@main.

siibra-python should be installable on recent versions of Windows, Linux and Mac OS in a recent Python 3 environment. We run continuous integration tests for versions 3.7 - 3.12 on recent Ubuntu images.

The library requires a couple of open source packages, namely: ` anytree >= 2.12.1 nibabel >= 5.3.2 appdirs >= 1.4.4 scikit-image >= 0.25.0 requests >= 2.32.3 neuroglancer-scripts >= 1.2.0 nilearn >= 0.11.0 filelock >= 3.16.1 ebrains-drive >= 0.6.0 `

You can also install a docker image with all dependencies included: .. code-block:: sh

docker run -dit

-p 10000:8888 –rm –name siibra docker-registry.ebrains.eu/siibra/siibra-python:latest

Documentation & Help

siibra-python’s documentation is hosted on https://siibra-python.readthedocs.io. The documentation includes a catalogue of documented code examples that walk you through the different concepts and functionalities. These examples use real data and include both the code and the produced expected outputs. They can be accessed at https://siibra-python.readthedocs.io/en/latest/examples.html, and are automatically tested and updated whenever a new version of siibra-python is published. As a new user, it is recommended to go through these examples - they are easy and will quickly provide you with the right code snippets that get you started. The documentation on readthedocs further includes introductory explanations and an API reference.

If you run into issues, please open a ticket on EBRAINS support or file bugs and feature requests on github.