siibra 1.0.1a11__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (87) hide show
  1. siibra-1.0.1a11/LICENSE +201 -0
  2. siibra-1.0.1a11/MANIFEST.in +4 -0
  3. siibra-1.0.1a11/PKG-INFO +189 -0
  4. siibra-1.0.1a11/README.rst +149 -0
  5. siibra-1.0.1a11/setup.cfg +4 -0
  6. siibra-1.0.1a11/setup.py +59 -0
  7. siibra-1.0.1a11/siibra/VERSION +1 -0
  8. siibra-1.0.1a11/siibra/__init__.py +155 -0
  9. siibra-1.0.1a11/siibra/commons.py +835 -0
  10. siibra-1.0.1a11/siibra/configuration/__init__.py +17 -0
  11. siibra-1.0.1a11/siibra/configuration/configuration.py +188 -0
  12. siibra-1.0.1a11/siibra/configuration/factory.py +609 -0
  13. siibra-1.0.1a11/siibra/core/__init__.py +16 -0
  14. siibra-1.0.1a11/siibra/core/assignment.py +122 -0
  15. siibra-1.0.1a11/siibra/core/atlas.py +239 -0
  16. siibra-1.0.1a11/siibra/core/concept.py +313 -0
  17. siibra-1.0.1a11/siibra/core/parcellation.py +387 -0
  18. siibra-1.0.1a11/siibra/core/region.py +1233 -0
  19. siibra-1.0.1a11/siibra/core/space.py +129 -0
  20. siibra-1.0.1a11/siibra/core/structure.py +111 -0
  21. siibra-1.0.1a11/siibra/exceptions.py +67 -0
  22. siibra-1.0.1a11/siibra/explorer/__init__.py +17 -0
  23. siibra-1.0.1a11/siibra/explorer/url.py +223 -0
  24. siibra-1.0.1a11/siibra/explorer/util.py +87 -0
  25. siibra-1.0.1a11/siibra/features/__init__.py +117 -0
  26. siibra-1.0.1a11/siibra/features/anchor.py +220 -0
  27. siibra-1.0.1a11/siibra/features/connectivity/__init__.py +33 -0
  28. siibra-1.0.1a11/siibra/features/connectivity/functional_connectivity.py +57 -0
  29. siibra-1.0.1a11/siibra/features/connectivity/regional_connectivity.py +505 -0
  30. siibra-1.0.1a11/siibra/features/connectivity/streamline_counts.py +27 -0
  31. siibra-1.0.1a11/siibra/features/connectivity/streamline_lengths.py +27 -0
  32. siibra-1.0.1a11/siibra/features/connectivity/tracing_connectivity.py +30 -0
  33. siibra-1.0.1a11/siibra/features/dataset/__init__.py +17 -0
  34. siibra-1.0.1a11/siibra/features/dataset/ebrains.py +90 -0
  35. siibra-1.0.1a11/siibra/features/feature.py +988 -0
  36. siibra-1.0.1a11/siibra/features/image/__init__.py +30 -0
  37. siibra-1.0.1a11/siibra/features/image/image.py +118 -0
  38. siibra-1.0.1a11/siibra/features/image/sections.py +105 -0
  39. siibra-1.0.1a11/siibra/features/image/volume_of_interest.py +89 -0
  40. siibra-1.0.1a11/siibra/features/tabular/__init__.py +24 -0
  41. siibra-1.0.1a11/siibra/features/tabular/bigbrain_intensity_profile.py +78 -0
  42. siibra-1.0.1a11/siibra/features/tabular/cell_density_profile.py +297 -0
  43. siibra-1.0.1a11/siibra/features/tabular/cortical_profile.py +327 -0
  44. siibra-1.0.1a11/siibra/features/tabular/gene_expression.py +275 -0
  45. siibra-1.0.1a11/siibra/features/tabular/layerwise_bigbrain_intensities.py +63 -0
  46. siibra-1.0.1a11/siibra/features/tabular/layerwise_cell_density.py +157 -0
  47. siibra-1.0.1a11/siibra/features/tabular/receptor_density_fingerprint.py +219 -0
  48. siibra-1.0.1a11/siibra/features/tabular/receptor_density_profile.py +109 -0
  49. siibra-1.0.1a11/siibra/features/tabular/regional_timeseries_activity.py +294 -0
  50. siibra-1.0.1a11/siibra/features/tabular/tabular.py +157 -0
  51. siibra-1.0.1a11/siibra/livequeries/__init__.py +19 -0
  52. siibra-1.0.1a11/siibra/livequeries/allen.py +359 -0
  53. siibra-1.0.1a11/siibra/livequeries/bigbrain.py +394 -0
  54. siibra-1.0.1a11/siibra/livequeries/ebrains.py +148 -0
  55. siibra-1.0.1a11/siibra/livequeries/query.py +49 -0
  56. siibra-1.0.1a11/siibra/locations/__init__.py +100 -0
  57. siibra-1.0.1a11/siibra/locations/boundingbox.py +452 -0
  58. siibra-1.0.1a11/siibra/locations/experimental.py +351 -0
  59. siibra-1.0.1a11/siibra/locations/location.py +120 -0
  60. siibra-1.0.1a11/siibra/locations/point.py +339 -0
  61. siibra-1.0.1a11/siibra/locations/pointcloud.py +389 -0
  62. siibra-1.0.1a11/siibra/retrieval/__init__.py +27 -0
  63. siibra-1.0.1a11/siibra/retrieval/cache.py +234 -0
  64. siibra-1.0.1a11/siibra/retrieval/datasets.py +395 -0
  65. siibra-1.0.1a11/siibra/retrieval/exceptions/__init__.py +27 -0
  66. siibra-1.0.1a11/siibra/retrieval/repositories.py +768 -0
  67. siibra-1.0.1a11/siibra/retrieval/requests.py +661 -0
  68. siibra-1.0.1a11/siibra/vocabularies/__init__.py +44 -0
  69. siibra-1.0.1a11/siibra/vocabularies/gene_names.json +29176 -0
  70. siibra-1.0.1a11/siibra/vocabularies/receptor_symbols.json +210 -0
  71. siibra-1.0.1a11/siibra/vocabularies/region_aliases.json +460 -0
  72. siibra-1.0.1a11/siibra/volumes/__init__.py +24 -0
  73. siibra-1.0.1a11/siibra/volumes/parcellationmap.py +1328 -0
  74. siibra-1.0.1a11/siibra/volumes/providers/__init__.py +20 -0
  75. siibra-1.0.1a11/siibra/volumes/providers/freesurfer.py +113 -0
  76. siibra-1.0.1a11/siibra/volumes/providers/gifti.py +165 -0
  77. siibra-1.0.1a11/siibra/volumes/providers/neuroglancer.py +755 -0
  78. siibra-1.0.1a11/siibra/volumes/providers/nifti.py +266 -0
  79. siibra-1.0.1a11/siibra/volumes/providers/provider.py +108 -0
  80. siibra-1.0.1a11/siibra/volumes/sparsemap.py +461 -0
  81. siibra-1.0.1a11/siibra/volumes/volume.py +982 -0
  82. siibra-1.0.1a11/siibra.egg-info/PKG-INFO +189 -0
  83. siibra-1.0.1a11/siibra.egg-info/SOURCES.txt +85 -0
  84. siibra-1.0.1a11/siibra.egg-info/dependency_links.txt +1 -0
  85. siibra-1.0.1a11/siibra.egg-info/requires.txt +12 -0
  86. siibra-1.0.1a11/siibra.egg-info/top_level.txt +1 -0
  87. siibra-1.0.1a11/test/test_siibra.py +23 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,4 @@
1
+ include VERSION
2
+ include siibra/vocabularies/gene_names.json
3
+ include siibra/vocabularies/receptor_symbols.json
4
+ include siibra/vocabularies/region_aliases.json
@@ -0,0 +1,189 @@
1
+ Metadata-Version: 2.4
2
+ Name: siibra
3
+ Version: 1.0.1a11
4
+ Summary: siibra - Software interfaces for interacting with brain atlases
5
+ Home-page: https://github.com/FZJ-INM1-BDA/siibra-python
6
+ Author: Big Data Analytics Group, Forschungszentrum Juelich, Institute of Neuroscience and Medicine (INM-1)
7
+ Author-email: inm1-bda@fz-juelich.de
8
+ Classifier: Development Status :: 2 - Pre-Alpha
9
+ Classifier: Programming Language :: Python :: 3.7
10
+ Classifier: Programming Language :: Python :: 3.8
11
+ Classifier: Programming Language :: Python :: 3.9
12
+ Classifier: Programming Language :: Python :: 3.10
13
+ Classifier: Programming Language :: Python :: 3.11
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Intended Audience :: Developers
17
+ Requires-Python: >=3.7
18
+ Description-Content-Type: text/x-rst
19
+ License-File: LICENSE
20
+ Requires-Dist: anytree
21
+ Requires-Dist: nibabel
22
+ Requires-Dist: appdirs
23
+ Requires-Dist: scikit-image
24
+ Requires-Dist: requests
25
+ Requires-Dist: neuroglancer-scripts
26
+ Requires-Dist: nilearn
27
+ Requires-Dist: typing-extensions; python_version < "3.8"
28
+ Requires-Dist: filelock
29
+ Requires-Dist: ebrains-drive>=0.6.0
30
+ Dynamic: author
31
+ Dynamic: author-email
32
+ Dynamic: classifier
33
+ Dynamic: description
34
+ Dynamic: description-content-type
35
+ Dynamic: home-page
36
+ Dynamic: license-file
37
+ Dynamic: requires-dist
38
+ Dynamic: requires-python
39
+ Dynamic: summary
40
+
41
+ |License| |PyPI version| |doi| |Python versions| |Documentation Status|
42
+
43
+ ==============================================================
44
+ siibra - Software interface for interacting with brain atlases
45
+ ==============================================================
46
+
47
+ Copyright 2018-2025, Forschungszentrum Jülich GmbH
48
+
49
+ *Authors: Big Data Analytics Group, Institute of Neuroscience and
50
+ Medicine (INM-1), Forschungszentrum Jülich GmbH*
51
+
52
+ .. intro-start
53
+
54
+ ``siibra-python`` is a Python client to a brain atlas framework that integrates brain parcellations and reference spaces at different spatial scales, and connects them with a broad range of multimodal regional data features.
55
+ It aims to facilitate programmatic and reproducible incorporation of brain parcellations and brain region features from different sources into neuroscience workflows.
56
+
57
+ ``siibra`` provides structured access to parcellation schemes in different brain reference spaces, including volumetric reference templates at macroscopic and microscopic resolutions as well as surface representations.
58
+ It supports both discretely labelled and statistical (probabilistic) parcellation maps, which can be used to assign brain regions to spatial locations and image signals, to retrieve region-specific neuroscience datasets from multiple online repositories, and to sample information from high-resolution image data.
59
+ The datasets anchored to brain regions address features of molecular, cellular and architecture as well as connectivity, and are complemented with live queries to external repositories as well as dynamic extraction from "big" image volumes such as the 20 micrometer BigBrain model.
60
+
61
+ ``siibra`` hides much of the complexity that would be required to collect and interact with the individual parcellations, templates and data repositories.
62
+ By encapsulating many aspects of interacting with different maps and reference templates spaces, it also minimizes common errors like misinterpretation of coordinates from different reference spaces, confusing label indices of brain regions, or using inconsistent versions of parcellation maps.
63
+ It aims to provide a safe way of using maps defined across multiple spatial scales for reproducible analysis.
64
+
65
+ .. intro-end
66
+
67
+ .. about-start
68
+
69
+ ``siibra`` was developed in the frame of the `Human Brain Project <https://humanbrainproject.eu>`__ for accessing the `EBRAINS
70
+ human brain atlas <https://ebrains.eu/service/human-brain-atlas>`__.
71
+ It stores most of its contents as sustainable and open datasets in the `EBRAINS Knowledge Graph <https://kg.ebrains.eu>`__, and is designed to support the `OpenMINDS metadata standards <https://github.com/HumanBrainProject/openMINDS_SANDS>`__.
72
+ Its functionalities include common actions known from the interactive viewer ``siibra-explorer`` `hosted at EBRAINS <https://atlases.ebrains.eu/viewer>`__.
73
+ In fact, the viewer is a good resource for exploring ``siibra``\ ’s core functionalities interactively: Selecting different parcellations, browsing and searching brain region hierarchies, downloading maps, identifying brain regions, and accessing multimodal features and connectivity information associated with brain regions.
74
+ Feature queries in ``siibra`` are parameterized by data modality and anatomical location, while the latter could be a brain region, brain parcellation, or location in reference space.
75
+ Beyond the explorative focus of ``siibra-explorer``, the Python library supports a range of data analysis functions suitable for typical neuroscience workflows.
76
+
77
+ .. about-end
78
+
79
+ .. getting-started-start
80
+
81
+ Installation
82
+ ============
83
+
84
+ ``siibra`` is available on pypi.
85
+ To install the latest released version, simply run ``pip install siibra``.
86
+ The installation typically takes about 2 minutes on a standard computer where Python is already installed.
87
+ In order to work with the latest version from github, use ``pip install git+https://github.com/FZJ-INM1-BDA/siibra-python.git@main``.
88
+
89
+ ``siibra-python`` should be installable on recent versions of Windows, Linux and Mac OS in a recent Python 3 environment.
90
+ We run continuous integration tests for versions 3.7 - 3.12 on recent Ubuntu images.
91
+
92
+ The library requires a couple of open source packages, namely:
93
+ ```
94
+ anytree >= 2.12.1
95
+ nibabel >= 5.3.2
96
+ appdirs >= 1.4.4
97
+ scikit-image >= 0.25.0
98
+ requests >= 2.32.3
99
+ neuroglancer-scripts >= 1.2.0
100
+ nilearn >= 0.11.0
101
+ filelock >= 3.16.1
102
+ ebrains-drive >= 0.6.0
103
+ ```
104
+
105
+ You can also install a docker image with all dependencies included:
106
+ .. code-block:: sh
107
+
108
+ docker run -dit \
109
+ -p 10000:8888 \
110
+ --rm \
111
+ --name siibra \
112
+ docker-registry.ebrains.eu/siibra/siibra-python:latest
113
+
114
+
115
+
116
+ Documentation & Help
117
+ ====================
118
+
119
+ ``siibra-python``\ ’s documentation is hosted on https://siibra-python.readthedocs.io.
120
+ The documentation includes a catalogue of documented code examples that walk you through the different concepts and functionalities.
121
+ These examples use real data and include both the code and the produced expected outputs.
122
+ They can be accessed at https://siibra-python.readthedocs.io/en/latest/examples.html, and are
123
+ automatically tested and updated whenever a new version of ``siibra-python`` is published.
124
+ 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.
125
+ The documentation on readthedocs further includes introductory explanations and an API reference.
126
+
127
+ If you run into issues, please open a ticket on `EBRAINS support <https://ebrains.eu/support/>`__ or file bugs and
128
+ feature requests on `github <https://github.com/FZJ-INM1-BDA/siibra-python/issues>`__.
129
+
130
+ .. getting-started-end
131
+
132
+ .. contribute-start
133
+
134
+ How to contribute
135
+ =================
136
+
137
+ If you want to contribute to ``siibra``, feel free to fork it and open a pull request with your changes.
138
+ You are also welcome to contribute to discussions in the issue tracker and of course to report issues you are facing.
139
+ If you find the software useful, please reference this repository URL in publications and derived work.
140
+ You can also star the project to show us that you are using it.
141
+
142
+ .. contribute-end
143
+
144
+ .. acknowledgments-start
145
+
146
+ Acknowledgements
147
+ ================
148
+
149
+ 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).
150
+
151
+ .. acknowledgments-end
152
+
153
+ .. howtocite-start
154
+
155
+ How to cite
156
+ ===========
157
+ Please cite the version used according to the citation file
158
+ or all versions by
159
+ `Timo Dickscheid, Xiayun Gui, Ahmet Nihat Simsek, Vadim Marcenko,
160
+ Louisa Köhnen, Sebastian Bludau, & Katrin Amunts. (2023). siibra-python -
161
+ Software interface for interacting with brain atlases. Zenodo.
162
+ https://doi.org/10.5281/zenodo.7885728`.
163
+
164
+ .. howtocite-ends
165
+
166
+
167
+ .. |License| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
168
+ :target: https://opensource.org/licenses/Apache-2.0
169
+ .. |PyPI version| image:: https://badge.fury.io/py/siibra.svg
170
+ :target: https://pypi.org/project/siibra/
171
+ .. |Python versions| image:: https://img.shields.io/pypi/pyversions/siibra.svg
172
+ :target: https://pypi.python.org/pypi/siibra
173
+ .. |Documentation Status| image:: https://readthedocs.org/projects/siibra-python/badge/?version=latest
174
+ :target: https://siibra-python.readthedocs.io/en/latest/?badge=latest
175
+ .. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7885728.svg
176
+ :target: https://doi.org/10.5281/zenodo.7885728
177
+
178
+
179
+ Versioning
180
+ ==========
181
+ Given a version number MAJOR.MINOR.PATCH, increments imply:
182
+ - MAJOR: incompatible API changes
183
+ - MINOR: a functionality in a backward compatible manner is added
184
+ - PATCH: backward compatible bug fixes and new configuration added such as new maps or features
185
+
186
+ Pre-release
187
+ -----------
188
+ For x.y.z, a full release,
189
+ - `x.y.z-alpha.t` is the development prerelease. By changing `t`, different siibra-configurations are targeted.
@@ -0,0 +1,149 @@
1
+ |License| |PyPI version| |doi| |Python versions| |Documentation Status|
2
+
3
+ ==============================================================
4
+ siibra - Software interface for interacting with brain atlases
5
+ ==============================================================
6
+
7
+ Copyright 2018-2025, Forschungszentrum Jülich GmbH
8
+
9
+ *Authors: Big Data Analytics Group, Institute of Neuroscience and
10
+ Medicine (INM-1), Forschungszentrum Jülich GmbH*
11
+
12
+ .. intro-start
13
+
14
+ ``siibra-python`` is a Python client to a brain atlas framework that integrates brain parcellations and reference spaces at different spatial scales, and connects them with a broad range of multimodal regional data features.
15
+ It aims to facilitate programmatic and reproducible incorporation of brain parcellations and brain region features from different sources into neuroscience workflows.
16
+
17
+ ``siibra`` provides structured access to parcellation schemes in different brain reference spaces, including volumetric reference templates at macroscopic and microscopic resolutions as well as surface representations.
18
+ It supports both discretely labelled and statistical (probabilistic) parcellation maps, which can be used to assign brain regions to spatial locations and image signals, to retrieve region-specific neuroscience datasets from multiple online repositories, and to sample information from high-resolution image data.
19
+ The datasets anchored to brain regions address features of molecular, cellular and architecture as well as connectivity, and are complemented with live queries to external repositories as well as dynamic extraction from "big" image volumes such as the 20 micrometer BigBrain model.
20
+
21
+ ``siibra`` hides much of the complexity that would be required to collect and interact with the individual parcellations, templates and data repositories.
22
+ By encapsulating many aspects of interacting with different maps and reference templates spaces, it also minimizes common errors like misinterpretation of coordinates from different reference spaces, confusing label indices of brain regions, or using inconsistent versions of parcellation maps.
23
+ It aims to provide a safe way of using maps defined across multiple spatial scales for reproducible analysis.
24
+
25
+ .. intro-end
26
+
27
+ .. about-start
28
+
29
+ ``siibra`` was developed in the frame of the `Human Brain Project <https://humanbrainproject.eu>`__ for accessing the `EBRAINS
30
+ human brain atlas <https://ebrains.eu/service/human-brain-atlas>`__.
31
+ It stores most of its contents as sustainable and open datasets in the `EBRAINS Knowledge Graph <https://kg.ebrains.eu>`__, and is designed to support the `OpenMINDS metadata standards <https://github.com/HumanBrainProject/openMINDS_SANDS>`__.
32
+ Its functionalities include common actions known from the interactive viewer ``siibra-explorer`` `hosted at EBRAINS <https://atlases.ebrains.eu/viewer>`__.
33
+ In fact, the viewer is a good resource for exploring ``siibra``\ ’s core functionalities interactively: Selecting different parcellations, browsing and searching brain region hierarchies, downloading maps, identifying brain regions, and accessing multimodal features and connectivity information associated with brain regions.
34
+ Feature queries in ``siibra`` are parameterized by data modality and anatomical location, while the latter could be a brain region, brain parcellation, or location in reference space.
35
+ Beyond the explorative focus of ``siibra-explorer``, the Python library supports a range of data analysis functions suitable for typical neuroscience workflows.
36
+
37
+ .. about-end
38
+
39
+ .. getting-started-start
40
+
41
+ Installation
42
+ ============
43
+
44
+ ``siibra`` is available on pypi.
45
+ To install the latest released version, simply run ``pip install siibra``.
46
+ The installation typically takes about 2 minutes on a standard computer where Python is already installed.
47
+ In order to work with the latest version from github, use ``pip install git+https://github.com/FZJ-INM1-BDA/siibra-python.git@main``.
48
+
49
+ ``siibra-python`` should be installable on recent versions of Windows, Linux and Mac OS in a recent Python 3 environment.
50
+ We run continuous integration tests for versions 3.7 - 3.12 on recent Ubuntu images.
51
+
52
+ The library requires a couple of open source packages, namely:
53
+ ```
54
+ anytree >= 2.12.1
55
+ nibabel >= 5.3.2
56
+ appdirs >= 1.4.4
57
+ scikit-image >= 0.25.0
58
+ requests >= 2.32.3
59
+ neuroglancer-scripts >= 1.2.0
60
+ nilearn >= 0.11.0
61
+ filelock >= 3.16.1
62
+ ebrains-drive >= 0.6.0
63
+ ```
64
+
65
+ You can also install a docker image with all dependencies included:
66
+ .. code-block:: sh
67
+
68
+ docker run -dit \
69
+ -p 10000:8888 \
70
+ --rm \
71
+ --name siibra \
72
+ docker-registry.ebrains.eu/siibra/siibra-python:latest
73
+
74
+
75
+
76
+ Documentation & Help
77
+ ====================
78
+
79
+ ``siibra-python``\ ’s documentation is hosted on https://siibra-python.readthedocs.io.
80
+ The documentation includes a catalogue of documented code examples that walk you through the different concepts and functionalities.
81
+ These examples use real data and include both the code and the produced expected outputs.
82
+ They can be accessed at https://siibra-python.readthedocs.io/en/latest/examples.html, and are
83
+ automatically tested and updated whenever a new version of ``siibra-python`` is published.
84
+ 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.
85
+ The documentation on readthedocs further includes introductory explanations and an API reference.
86
+
87
+ If you run into issues, please open a ticket on `EBRAINS support <https://ebrains.eu/support/>`__ or file bugs and
88
+ feature requests on `github <https://github.com/FZJ-INM1-BDA/siibra-python/issues>`__.
89
+
90
+ .. getting-started-end
91
+
92
+ .. contribute-start
93
+
94
+ How to contribute
95
+ =================
96
+
97
+ If you want to contribute to ``siibra``, feel free to fork it and open a pull request with your changes.
98
+ You are also welcome to contribute to discussions in the issue tracker and of course to report issues you are facing.
99
+ If you find the software useful, please reference this repository URL in publications and derived work.
100
+ You can also star the project to show us that you are using it.
101
+
102
+ .. contribute-end
103
+
104
+ .. acknowledgments-start
105
+
106
+ Acknowledgements
107
+ ================
108
+
109
+ 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).
110
+
111
+ .. acknowledgments-end
112
+
113
+ .. howtocite-start
114
+
115
+ How to cite
116
+ ===========
117
+ Please cite the version used according to the citation file
118
+ or all versions by
119
+ `Timo Dickscheid, Xiayun Gui, Ahmet Nihat Simsek, Vadim Marcenko,
120
+ Louisa Köhnen, Sebastian Bludau, & Katrin Amunts. (2023). siibra-python -
121
+ Software interface for interacting with brain atlases. Zenodo.
122
+ https://doi.org/10.5281/zenodo.7885728`.
123
+
124
+ .. howtocite-ends
125
+
126
+
127
+ .. |License| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
128
+ :target: https://opensource.org/licenses/Apache-2.0
129
+ .. |PyPI version| image:: https://badge.fury.io/py/siibra.svg
130
+ :target: https://pypi.org/project/siibra/
131
+ .. |Python versions| image:: https://img.shields.io/pypi/pyversions/siibra.svg
132
+ :target: https://pypi.python.org/pypi/siibra
133
+ .. |Documentation Status| image:: https://readthedocs.org/projects/siibra-python/badge/?version=latest
134
+ :target: https://siibra-python.readthedocs.io/en/latest/?badge=latest
135
+ .. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7885728.svg
136
+ :target: https://doi.org/10.5281/zenodo.7885728
137
+
138
+
139
+ Versioning
140
+ ==========
141
+ Given a version number MAJOR.MINOR.PATCH, increments imply:
142
+ - MAJOR: incompatible API changes
143
+ - MINOR: a functionality in a backward compatible manner is added
144
+ - PATCH: backward compatible bug fixes and new configuration added such as new maps or features
145
+
146
+ Pre-release
147
+ -----------
148
+ For x.y.z, a full release,
149
+ - `x.y.z-alpha.t` is the development prerelease. By changing `t`, different siibra-configurations are targeted.
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,59 @@
1
+ from setuptools import setup, find_packages
2
+ import os
3
+
4
+ ROOT_DIR = os.path.dirname(os.path.abspath(__file__))
5
+
6
+
7
+ def find_version():
8
+ path_to_version = os.path.join(ROOT_DIR, "siibra", "VERSION")
9
+ with open(path_to_version, "r", encoding="utf-8") as f:
10
+ return f.read()
11
+
12
+
13
+ with open(os.path.join(ROOT_DIR, "README.rst"), "r", encoding="utf-8") as f:
14
+ long_description = f.read()
15
+
16
+ setup(
17
+ name="siibra",
18
+ version=find_version(),
19
+ author="Big Data Analytics Group, Forschungszentrum Juelich, Institute of Neuroscience and Medicine (INM-1)",
20
+ author_email="inm1-bda@fz-juelich.de",
21
+ description="siibra - Software interfaces for interacting with brain atlases",
22
+ long_description=long_description,
23
+ long_description_content_type="text/x-rst",
24
+ url="https://github.com/FZJ-INM1-BDA/siibra-python",
25
+ packages=find_packages(include=["siibra", "siibra.*"]),
26
+ include_package_data=True,
27
+ package_data={
28
+ 'siibra': [
29
+ 'VERSION',
30
+ 'vocabularies/gene_names.json',
31
+ 'vocabularies/receptor_symbols.json',
32
+ 'vocabularies/region_aliases.json'
33
+ ]
34
+ },
35
+ classifiers=[
36
+ "Development Status :: 2 - Pre-Alpha",
37
+ "Programming Language :: Python :: 3.7",
38
+ "Programming Language :: Python :: 3.8",
39
+ "Programming Language :: Python :: 3.9",
40
+ "Programming Language :: Python :: 3.10",
41
+ "Programming Language :: Python :: 3.11",
42
+ "Programming Language :: Python :: 3.12",
43
+ "Operating System :: OS Independent",
44
+ "Intended Audience :: Developers",
45
+ ],
46
+ python_requires=">=3.7",
47
+ install_requires=[
48
+ "anytree",
49
+ "nibabel",
50
+ "appdirs",
51
+ "scikit-image",
52
+ "requests",
53
+ "neuroglancer-scripts",
54
+ "nilearn",
55
+ 'typing-extensions; python_version < "3.8"',
56
+ "filelock",
57
+ "ebrains-drive >= 0.6.0",
58
+ ],
59
+ )
@@ -0,0 +1 @@
1
+ 1.0.1-alpha.11