Metadata-Version: 2.4
Name: SUITPy
Version: 2.1.1
Summary: Analysis toolbox for cerebellar fMRI data in Python
Home-page: https://github.com/DiedrichsenLab/SUITPy
Download-URL: https://github.com/DiedrichsenLab/SUITPy/archive/refs/tags/v.2.1.1.tar.gz
Maintainer: Jorn Diedrichsen
Maintainer-email: joern.diedrichsen@googlemail.com
License: MIT
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development
Classifier: Topic :: Scientific/Engineering
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: numpy>=1.22.0
Requires-Dist: nibabel>=3.2.1
Requires-Dist: neuroimagingtools>=1.1.1
Requires-Dist: requests>=2
Requires-Dist: scipy>=1.9.0
Requires-Dist: matplotlib>=3.5.0
Requires-Dist: plotly>=5.3.1
Requires-Dist: pandas>=2.0.0
Requires-Dist: joblib>=1.2.0
Requires-Dist: antspyx>=0.6.3
Dynamic: classifier
Dynamic: description
Dynamic: download-url
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: maintainer
Dynamic: maintainer-email
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

SUITPy: Analysis and visualization of cerebellar imaging data.
==============================================================

The package provides some basic functionality of the original SUIT toolbox for Matlab (https://github.com/jdiedrichsen/suit).
Currently, only mapping of volume data to the flatmap and display of the flatmap are implemented.

Important links
---------------

- SUIT website: http://diedrichsenlab.org/imaging/suit.htm
- Official source code repository: https://github.com/SUITPy/
- HTML documentation (latest release): https://suitpy.readthedocs.io/

Dependencies
------------

The required dependencies to use the software are:

* python >= 3.10,
* setuptools
* numpy >= 1.22.0
* nibabel >= 3.2.1
* pandas >= 2.0.0
* matplotlib >= 3.5.0
* plotly >= 5.10.0
* scipy >= 1.9.0
* neuroimagingtools >= 1.1.1
* antspyx >= 0.6.1

Install
-------

First make sure you have installed all the dependencies listed above.
Then you can install SUITPy by running the following command in
a command prompt::

    pip install -U --user SUITPy

More detailed instructions are available at
https://suitpy.readthedocs.io/en/latest/install.html


Licence and Acknowledgements
----------------------------
The Python version of the SUIT toolbox has been developed by the Diedrichsenlab including J. Diedrichsen, C. Hernandez-Castillo, M. King, Y. Wang, Y. Li, D. Zhi and others. It is distributed under MIT License, meaning that it can be freely used and re-used, as long as proper attribution in form of acknowledgments and links (for online use) or citations (in publications) are given. The relevant references are:

SUIT normalisation and template:

- Diedrichsen, J. (2006). A spatially unbiased atlas template of the human cerebellum. Neuroimage. 33(1), 127-138. doi: 10.1016/j.neuroimage.2006.05.056

Surface-based representation and flatmap

- Diedrichsen, J. & Zotow, E. (2015). Surface-based display of volume-averaged cerebellar data. PLOSOne. doi: 10.1371/journal.pone.0133402
