Metadata-Version: 2.1
Name: SUITPy
Version: 1.3.0
Summary: Mapping and plotting cerebellar fMRI data in Python
Home-page: https://github.com/DiedrichsenLab/SUITPy
Download-URL: https://github.com/DiedrichsenLab/SUITPy/archive/refs/tags/v.1.3.0.tar.gz
Maintainer: Jorn Diedrichsen
Maintainer-email: jdiedric@uwo.ca
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.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: numpy>=1.16
Requires-Dist: nibabel>=2.5
Requires-Dist: requests>=2
Requires-Dist: scipy>=1.0
Requires-Dist: plotly>=5.3.1

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.6
* setuptools
* numpy >= 1.16
* nibabel >= 2.5
* pandas >= 0.24
* matplotlib >= 1.5.1
* scipy >=1.0

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, M. King, D. Zhi, C. Hernandez-Castillo, S. Witt 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.

Surface-based representation and flatmap

- Diedrichsen, J. & Zotow, E. (2015). Surface-based display of volume-averaged cerebellar data. PLOSOne.
