siibra - Software interfaces for interacting with brain atlases
Project description
siibra - Python interface for interacting with brain atlases
Authors: Big Data Analytics Group, Institute of Neuroscience and Medicine (INM-1), Forschungszentrum Jülich GmbH
Copyright 2020-2021, Forschungszentrum Jülich GmbH
:warning:
siibra-pythonis still at an experimental stage. The API of the library is not stable, and the software is not yet fully tested. You are welcome to install and test it, but be aware that you will likely encounter bugs.
Overview
siibra is a Python client for interacting with "multilevel" brain atlases, which combine multiple brain parcellations, reference coordinate spaces and modalities.
siibra is designed to allow safe and convenient interaction with brain definitions from different parcellations, to provide streamlined access to multimodal data features linked to brain regions, and to facilitate reproducible implementation of basic analyses with region-specific data features.
In particular, siibra aims to unify access to regional data features at the millimeter and micrometer scale of the human brain.
siibra is largely developed inside the Human Brain Project for accessing the EBRAINS human brain atlas.
It stores most of its configuration and data features in the EBRAINS Knowledge Graph, and is designed to support the OpenMINDS metadata standards.
The functionality of siibra-python matches common actions known from browsing the siibra explorer hosted on EBRAINS:
Selecting different parcellations, browsing and searching brain region hierarchies, downloading maps, selecting regions, and accessing multimodal data features associated with brain regions.
A key feature is a streamlined implementation of performing structured data queries for selected brain regions.
siibra implements a hierarchy of features, which unifies handling of
- spatial data features (which are linked to atlas regions via coordinates; like contact points of physiological electrodes),
- regional data features (which are linked to atlases via a brain region specifications, like cell densities or neurotransmitter distributions), and
- global data features (linked to an atlas via the whole brain or parcellation, like connectivity matrices or activation maps).
As a result, all forms of data features can be queried using the same mechanism (get_features()) which accepts the specification of a data modality, and considers the selected parcellation and regions in the atlas.
Currently available data features include neurotransmitter densities, regional connectivity profiles, connectivity matrices, gene expressions, and spatial properties of brain regions.
Additional features, including distributions of neuronal cells, functional activation maps and electrophysiologal recordings, will become available soon.
Stay tuned!
siibra hides much of the complexity that would be required to interact with the individual data repositories that host the associated data.
By encapsulating many aspects of interacting with different maps and reference templates spaces, it also minimizes common risks like misinterpretation of coordinates from different reference spaces, or utilisation of inconsistent versions of parcellation maps.
It aims to provide a safe way of using maps defined across multiple spatial scales.
Documentation
The main place for siibra-python's documentation is at https://siibra-python.readthedocs.io.
Usage examples
To get familiar with siibra, we recommend to checkout the jupyter notebooks in the examples/ subfolder of this repository.
Installation and setup
siibra is available on pypi.
To install the latest version, simply run pip install siibra.
siibra retrieves much of its data from the EBRAINS Knowledge Graph, which requires authentication.
Therefore you have to provide an EBRAINS authentication token for using all features provided by siibra.
Please make sure that you have a valid EBRAINS user account by registering to EBRAINS.
Then follow the instructions for obtaining EBRAINS API auth tokens.
As a last step, you need to fetch a recent token from the authorization endpoint, and make it known to siibra.
There are two ways to do so:
-
Set an environment variable
HBP_AUTH_TOKENwith the token before loading thesiibramodule. -
Set the token explicitly as follows:
from siibra.authentication import Authentication auth = Authentication.instance() auth.set_token(TOKEN)
Note that as of now, you need to get a new token approximately every day to
perform EBRAINS data queries. However, siibra implements a local cache on
your harddisk, so once retrieved, your data will become usable and accessible
without refreshing the token.
Acknowledgements
This software code is funded from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Specific Grant Agreement No. 945539 (Human Brain Project SGA3).
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file siibra-0.0.8.9.dev2.tar.gz.
File metadata
- Download URL: siibra-0.0.8.9.dev2.tar.gz
- Upload date:
- Size: 464.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 044c82d7ee9128dabf1015a8125e909708f84380172804a847e5528b625529d2 |
|
| MD5 | dd3bd2ca2220a5726709fd0a52edeada |
|
| BLAKE2b-256 | 01ce563b9c84b0345798812f8e5b771370c71d5be8bdccc8fd57c54ffd0ecf61 |
File details
Details for the file siibra-0.0.8.9.dev2-py3-none-any.whl.
File metadata
- Download URL: siibra-0.0.8.9.dev2-py3-none-any.whl
- Upload date:
- Size: 479.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1dfca0ef71a38843ff7021d6fc929d46be3e6f9506884f40305df4f0f21ff41c |
|
| MD5 | e7d5d247b2a9357eeca910e5e390806f |
|
| BLAKE2b-256 | d83709831f1a8a3efc4adbb5ec33bee710cc459bc7c53f253bc606cd0f2d9613 |
