Metadata-Version: 2.4
Name: splora
Version: 0.0.3
Summary: Low-rank and sparse paradigm free mapping for fMRI deconvolution
Project-URL: Homepage, https://github.com/Paradigm-Free-Mapping/splora
Project-URL: Documentation, https://github.com/Paradigm-Free-Mapping/splora#readme
Project-URL: Repository, https://github.com/Paradigm-Free-Mapping/splora
Project-URL: Issues, https://github.com/Paradigm-Free-Mapping/splora/issues
Author-email: Eneko Uruñuela <eneko.urunuela@ucalgary.ca>
Maintainer-email: Eneko Uruñuela <eneko.urunuela@ucalgary.ca>
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: deconvolution,fMRI,low-rank,neuroimaging,paradigm-free mapping,sparse
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Requires-Python: >=3.10
Requires-Dist: dask>=2023.1.0
Requires-Dist: nibabel>=4.0.0
Requires-Dist: nilearn>=0.10.0
Requires-Dist: numpy>=1.23.0
Requires-Dist: pyspfm>=0.1.0
Requires-Dist: scipy>=1.9.0
Requires-Dist: tqdm>=4.60.0
Provides-Extra: all
Requires-Dist: pre-commit>=3.0.0; extra == 'all'
Requires-Dist: pytest-cov>=4.0; extra == 'all'
Requires-Dist: pytest>=7.0; extra == 'all'
Requires-Dist: ruff>=0.1.0; extra == 'all'
Requires-Dist: sphinx-argparse>=0.4.0; extra == 'all'
Requires-Dist: sphinx-rtd-theme>=1.0; extra == 'all'
Requires-Dist: sphinx>=6.0; extra == 'all'
Provides-Extra: dev
Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
Requires-Dist: ruff>=0.1.0; extra == 'dev'
Provides-Extra: doc
Requires-Dist: sphinx-argparse>=0.4.0; extra == 'doc'
Requires-Dist: sphinx-rtd-theme>=1.0; extra == 'doc'
Requires-Dist: sphinx>=6.0; extra == 'doc'
Provides-Extra: test
Requires-Dist: pytest-cov>=4.0; extra == 'test'
Requires-Dist: pytest>=7.0; extra == 'test'
Description-Content-Type: text/markdown

# Sparse and Low-Rank Paradigm Free Mapping

[![Latest Version](https://img.shields.io/pypi/v/splora.svg)](https://pypi.python.org/pypi/splora/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/splora.svg)](https://pypi.python.org/pypi/splora/)
[![DOI](https://zenodo.org/badge/291096007.svg)](https://zenodo.org/badge/latestdoi/291096007)
[![License](https://img.shields.io/badge/License-LGPL%202.1-blue.svg)](https://opensource.org/licenses/LGPL-2.1)
[![CircleCI](https://circleci.com/gh/Paradigm-Free-Mapping/splora.svg?style=shield)](https://circleci.com/gh/Paradigm-Free-Mapping/splora)
[![Documentation Status](https://readthedocs.org/projects/splora/badge/?version=latest)](http://splora.readthedocs.io/en/latest/?badge=latest)
[![Codecov](https://codecov.io/gh/Paradigm-Free-Mapping/splora/branch/main/graph/badge.svg)](https://codecov.io/gh/Paradigm-Free-Mapping/splora)

Repository for SPLORA PFM.

How to install:

`pip install .`

How to use:

`splora -i data.nii.gz -m mask.nii.gz -tr 2`

To see all options available, type: `splora -h`

You can also use the package by importing to your own Python script.
