clabtoolkit 0.5.1__tar.gz → 0.5.2__tar.gz

{clabtoolkit-0.5.1 → clabtoolkit-0.5.2}/CITATION.cff

@@ -6,9 +6,10 @@ abstract: >-
   A Python toolkit for neuroimaging data processing and analysis, designed for
   brain connectivity data, BIDS datasets and the file formats used in
   neuroimaging.
-version: 0.5.1
-date-released: 2026-10-21
+version: 0.5.2
+date-released: 2026-10-22
 license: Apache-2.0
+doi: "10.5281/zenodo.23540587"  # Zenodo concept DOI: always resolves to the latest version
 repository-code: "https://github.com/connectomicslab/clabtoolkit"
 url: "https://clabtoolkit.readthedocs.io"
 keywords:

{clabtoolkit-0.5.1 → clabtoolkit-0.5.2}/DOCUMENTATION.md

@@ -4,7 +4,7 @@
 
 **clabtoolkit** is a comprehensive Python toolkit designed for neuroimaging data processing and analysis, with specialized focus on brain connectivity data, BIDS datasets, and various neuroimaging formats. Developed by Yasser Alemán-Gómez, this toolkit provides an end-to-end solution for connectomics research and surface-based brain analysis.
 
-**Version**: 0.5.1  
+**Version**: 0.5.2  
 **License**: Apache Software License 2.0  
 **Python Support**: 3.11+  
 **Documentation**: https://clabtoolkit.readthedocs.io  

{clabtoolkit-0.5.1 → clabtoolkit-0.5.2}/HISTORY.rst

@@ -2,6 +2,14 @@
 History
 =======
 
+0.5.2 (2026-10-22)
+------------------
+
+* Updated the README (absolute image URLs so they render on PyPI, new badges and ecosystem figure)
+* Added .zenodo.json so the Zenodo record has a description and complete metadata
+* Added the Zenodo DOI of the toolkit to CITATION.cff and the README
+* Replaced the LICENSE file by the unmodified Apache-2.0 text, so GitHub recognizes the license, and moved the copyright statement to a NOTICE file
+
 0.5.1 (2026-10-21)
 ------------------
 

clabtoolkit-0.5.2/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

{clabtoolkit-0.5.1 → clabtoolkit-0.5.2}/MANIFEST.in

@@ -3,6 +3,7 @@ include CITATION.cff
 include CONTRIBUTING.rst
 include HISTORY.rst
 include LICENSE
+include NOTICE
 include README.rst
 include pyproject.toml
 

clabtoolkit-0.5.2/NOTICE

@@ -0,0 +1,5 @@
+clabtoolkit
+Copyright 2024-2026 Yasser Alemán-Gómez
+
+This product includes software developed at the Connectomics Lab, Radiology
+Department, CHUV - Lausanne University Hospital.

{clabtoolkit-0.5.1/clabtoolkit.egg-info → clabtoolkit-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: clabtoolkit
-Version: 0.5.1
+Version: 0.5.2
 Summary: A comprehensive toolkit for neuroimaging data processing and analysis
 Author-email: Yasser Alemán-Gómez <yasseraleman@protonmail.com>
 Maintainer-email: Yasser Alemán-Gómez <yasseraleman@protonmail.com>
@@ -24,6 +24,7 @@ Classifier: Topic :: Scientific/Engineering :: Image Processing
 Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+License-File: NOTICE
 License-File: AUTHORS.rst
 Requires-Dist: nibabel>=5.3.2
 Requires-Dist: numpy>=1.23.5
@@ -69,7 +70,7 @@ Dynamic: license-file
 Connectomics Lab Toolkit
 ========================
 
-.. image:: docs/source/_static/clabtoolkit_logo.png
+.. image:: https://raw.githubusercontent.com/connectomicslab/clabtoolkit/main/docs/source/_static/clabtoolkit_logo.png
         :alt: clabtoolkit logo
         :align: center
         :width: 400
@@ -77,27 +78,48 @@ Connectomics Lab Toolkit
 
 .. image:: https://img.shields.io/pypi/v/clabtoolkit.svg
         :target: https://pypi.python.org/pypi/clabtoolkit
+        :alt: PyPI version
+
+.. image:: https://img.shields.io/pypi/pyversions/clabtoolkit.svg
+        :target: https://pypi.python.org/pypi/clabtoolkit
+        :alt: Python versions
+
+.. image:: https://img.shields.io/badge/License-Apache_2.0-blue.svg
+        :target: https://opensource.org/licenses/Apache-2.0
+        :alt: License: Apache 2.0
 
 .. image:: https://github.com/connectomicslab/clabtoolkit/actions/workflows/ci.yml/badge.svg
         :target: https://github.com/connectomicslab/clabtoolkit/actions/workflows/ci.yml
+        :alt: CI status
+
+.. image:: https://codecov.io/gh/connectomicslab/clabtoolkit/branch/main/graph/badge.svg
+        :target: https://codecov.io/gh/connectomicslab/clabtoolkit
+        :alt: Code coverage
 
 .. image:: https://readthedocs.org/projects/clabtoolkit/badge/?version=latest
         :target: https://clabtoolkit.readthedocs.io/en/latest/?version=latest
         :alt: Documentation Status
 
-.. image:: https://img.shields.io/pypi/pyversions/clabtoolkit.svg
-        :target: https://pypi.python.org/pypi/clabtoolkit
+.. image:: https://img.shields.io/badge/arXiv-2607.02638-b31b1b.svg
+        :target: https://arxiv.org/abs/2607.02638
+        :alt: arXiv
+
+.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.23540587.svg
+        :target: https://doi.org/10.5281/zenodo.23540587
+        :alt: Zenodo DOI
 
-.. image:: https://codecov.io/gh/connectomicslab/clabtoolkit/branch/main/graph/badge.svg
-        :target: https://codecov.io/gh/connectomicslab/clabtoolkit
 
+**clabtoolkit** (Connectomics Lab Toolkit) is a Python toolkit for neuroimaging data processing
+and analysis, with a focus on brain connectivity, BIDS datasets and common neuroimaging formats.
 
-A comprehensive Python toolkit for neuroimaging data processing and analysis, specifically designed for working with brain connectivity data, BIDS datasets, and various neuroimaging formats.
+It is built around a small set of objects (``Surface``, ``Parcellation``, ``Tractogram`` and
+``Connectome``) that share a common plotting layer (``BrainPlotter``), so surfaces, parcellations,
+streamlines and connectivity matrices can be loaded, processed and visualized with a consistent API.
+It is designed to work alongside libraries such as nibabel, nilearn and DIPY.
 
 * **Free software**: Apache Software License 2.0
 * **Documentation**: https://clabtoolkit.readthedocs.io
-* **Source Code**: https://github.com/connectomicslab/clabtoolkit
-* **Python versions**: 3.11+
+* **Source code**: https://github.com/connectomicslab/clabtoolkit
 
 Installation
 ------------
@@ -106,11 +128,11 @@ Install from PyPI::
 
     pip install clabtoolkit
 
-For development installation::
+For a development installation::
 
     git clone https://github.com/connectomicslab/clabtoolkit.git
     cd clabtoolkit
-    pip install -e .[dev]
+    pip install -e ".[dev]"
 
 Requirements and optional dependencies:
 
@@ -123,13 +145,16 @@ Requirements and optional dependencies:
 Features
 --------
 
-.. image:: docs/source/_static/clabtoolkit_ecosystem.png
+.. image:: https://raw.githubusercontent.com/connectomicslab/clabtoolkit/main/docs/source/_static/clabtoolkit_ecosystem.png
         :alt: clabtoolkit ecosystem
         :align: center
         :width: 700
 
-Each module has a notebook in ``usage_examples`` (``examples-<module>-methods.ipynb``)
-with runnable examples.
+Every module has a notebook with runnable examples in the
+`usage_examples <https://github.com/connectomicslab/clabtoolkit/tree/main/usage_examples>`_ folder
+(``examples-<module>-methods.ipynb``), and
+`clabtoolkit_examples.ipynb <https://github.com/connectomicslab/clabtoolkit/blob/main/usage_examples/clabtoolkit_examples.ipynb>`_
+gives an overview of the whole toolkit.
 
 **Data organization**
 
@@ -181,8 +206,6 @@ Quick Start
 -----------
 
 The examples below are self-contained: they use simulated data, so you can run them as they are.
-More examples for every module are available in the ``usage_examples`` folder
-(see ``usage_examples/clabtoolkit_examples.ipynb``).
 
 **Filter a parcellation by region name** (``keep_by_name``)
 
@@ -202,19 +225,30 @@ More examples for every module are available in the ``usage_examples`` folder
 
 To load your own parcellation, use ``cltparc.Parcellation("parc.nii.gz", color_table="lut.txt")``.
 
+.. note::
+
+   If a file called ``parc.lut`` is in the same directory as the parcellation, it is used as the
+   color table by default, so ``cltparc.Parcellation("parc.nii.gz")`` is enough. As long as they 
+   share the same base name, the LUT file will be automatically detected.
+
 **Sample an image along the streamlines of a tractogram** (``interpolate_on_tractogram``)
 
 .. code-block:: python
 
+    import os
+    import tempfile
+
     import clabtoolkit.imagetools as cltimg
     import clabtoolkit.tracttools as clttract
 
+    image_path = os.path.join(tempfile.gettempdir(), "image.nii.gz")
+
     # Simulate a reference image and a tractogram with 5 bundles
-    cltimg.simulate_image(reference=(100, 100, 70), simulated_image="/tmp/image.nii.gz")
-    tract = clttract.Tractogram.simulate_tractogram(ref_image="/tmp/image.nii.gz")
+    cltimg.simulate_image(reference=(100, 100, 70), simulated_image=image_path)
+    tract = clttract.Tractogram.simulate_tractogram(ref_image=image_path)
 
     # Sample the image at every point of every streamline
-    tract.interpolate_on_tractogram("/tmp/image.nii.gz", map_name="fa",
+    tract.interpolate_on_tractogram(image_path, map_name="fa",
                                     storage_mode="data_per_point", interp_method="linear")
 
     print(tract.list_maps()["maps_per_point"])  # ['fa']
@@ -229,53 +263,67 @@ Use ``storage_mode="data_per_streamline"`` with ``reduction="mean"`` to store a
     import clabtoolkit.surfacetools as cltsurf
     import clabtoolkit.visualizationtools as cltvis
 
+    # On a server without a display, set PYVISTA_OFF_SCREEN=true before running
+
     # Simulate a surface and a thickness map
     surf = cltsurf.Surface.simulate_surface(seed=42, shape="sphere")
     surf.simulate_map(map_name="thickness")
 
-    # Plot two views of the map and save the figure
+    # Option 1 (Surface object): plot the lateral and medial views of the map
+    surf.plot(views=["lateral", "medial"],
+              maps="thickness",
+              colorbar_title="Thickness (mm)")
+
+    # Option 2 (BrainPlotter): the same plot, with more control over colormaps and colorbars
     plotter = cltvis.BrainPlotter()
-    plotter.plot(objs2plot=surf, views=["lateral", "medial"], map_names="thickness",
-                 colormaps="viridis", colorbar=True, save_path="/tmp/thickness.png")
+    plotter.plot(objs2plot=surf,
+                 views=["lateral", "medial"],
+                 map_names="thickness",
+                 colormaps="hot",
+                 colorbar=True,
+                 colorbar_titles="Thickness (mm)")
 
 To plot your own data, load a surface with ``cltsurf.Surface("lh.pial")`` and its map with
 ``surf.load_scalar_maps("lh.thickness", maps_names="thickness")``.
 
-Contributing
-------------
+Citing
+------
 
-Contributions are welcome! Please open an issue first to discuss major changes. See
-`CONTRIBUTING.rst <CONTRIBUTING.rst>`_ for the full guidelines.
+If you use clabtoolkit in your work, please cite the toolkit paper:
 
-Testing
--------
+    Alemán-Gómez, Y., et al. CLABTOOLKIT: An Open-Source Toolkit for Routine Processing, Manipulation, and Visualization of Neuroimaging Data. arXiv:2607.02638.
+    https://arxiv.org/abs/2607.02638
 
-Run tests with::
+.. code-block:: bibtex
 
-    pytest
+    @article{aleman2026clabtoolkit,
+      title   = {CLABTOOLKIT: An Open-Source Toolkit for Routine Processing, Manipulation, and Visualization of Neuroimaging Data},
+      author  = {Alem{\'a}n-G{\'o}mez, Yasser and Herv{\'e} Nino and Hagmann, Patric},
+      journal = {arXiv preprint arXiv:2607.02638},
+      year    = {2026},
+      url     = {https://arxiv.org/abs/2607.02638}
+    }
 
-Run tests with coverage::
+The repository includes a ``CITATION.cff`` file, and every release is archived in Zenodo: the DOI
+`10.5281/zenodo.23540587 <https://doi.org/10.5281/zenodo.23540587>`_ always points to the latest
+version, and each version has its own DOI listed on that page.
+
+Contributing
+------------
 
-    pytest --cov=clabtoolkit
+Contributions are welcome! Please open an issue first to discuss major changes. See
+`CONTRIBUTING.rst <https://github.com/connectomicslab/clabtoolkit/blob/main/CONTRIBUTING.rst>`_
+for the guidelines, including how to run the test suite.
 
 Changelog
 ---------
 
-See `HISTORY.rst <HISTORY.rst>`_ for a detailed changelog.
-
-Citing
-------
-
-If you use clabtoolkit in your work, please cite the toolkit paper::
-
-    Alemán-Gómez, Y., et al. clabtoolkit. arXiv:2607.02638.
-    https://arxiv.org/abs/2607.02638
-
-The repository includes a ``CITATION.cff`` file, so GitHub shows a "Cite this repository" option
-with the same reference. The source code is available at https://github.com/connectomicslab/clabtoolkit.
+See `HISTORY.rst <https://github.com/connectomicslab/clabtoolkit/blob/main/HISTORY.rst>`_ for a
+detailed changelog.
 
 Credits
 -------
 
-Developed by Yasser Alemán-Gómez and collaborators at the Connectomics Lab. See
-`AUTHORS.rst <AUTHORS.rst>`_ for the full list.
+Developed by Yasser Alemán-Gómez and collaborators at the Connectomics Lab (Lausanne University
+Hospital, CHUV). See `AUTHORS.rst <https://github.com/connectomicslab/clabtoolkit/blob/main/AUTHORS.rst>`_
+for the full list.