Metadata-Version: 2.1
Name: dipy
Version: 1.11.0
Summary: Diffusion MRI Imaging in Python
Keywords: dipy,diffusionimaging,dti,tracking,tractography,diffusionmri,mri,tractometry,connectomics,brain,dipymri,microstructure,deeplearning,registration,segmentations,simulation,medical,imaging,brain,machinelearning,signalprocessing
Author-Email: DIPY developers <dipy@python.org>
Maintainer-Email: Eleftherios Garyfallidis <neuroimaging@python.org>, Ariel Rokem <neuroimaging@python.org>, Serge Koudoro <neuroimaging@python.org>
License: Unless otherwise specified by LICENSE.txt files in individual
         directories, or within individual files or functions, all code is:
         
         Copyright (c) 2008-2025, dipy developers
         All rights reserved.
         
         Redistribution and use in source and binary forms, with or without
         modification, are permitted provided that the following conditions are
         met:
         
             * Redistributions of source code must retain the above copyright
                notice, this list of conditions and the following disclaimer.
         
             * Redistributions in binary form must reproduce the above
                copyright notice, this list of conditions and the following
                disclaimer in the documentation and/or other materials provided
                with the distribution.
         
             * Neither the name of the dipy developers nor the names of any
                contributors may be used to endorse or promote products derived
                from this software without specific prior written permission.
         
         THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
         "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
         LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
         A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
         OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
         SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
         LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
         DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
         THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
         (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
         OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
         
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
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 :: Only
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Scientific/Engineering
Classifier: Operating System :: OS Independent
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Project-URL: homepage, https://dipy.org
Project-URL: documentation, https://docs.dipy.org/stable/
Project-URL: source, https://github.com/dipy/dipy
Project-URL: download, https://pypi.org/project/dipy/#files
Project-URL: tracker, https://github.com/dipy/dipy/issues
Requires-Python: >=3.10
Requires-Dist: numpy>=1.22.4
Requires-Dist: scipy>=1.8
Requires-Dist: nibabel>=3.0.0
Requires-Dist: h5py>=3.1.0
Requires-Dist: packaging>=21
Requires-Dist: tqdm>=4.30.0
Requires-Dist: trx-python>=0.3.0
Provides-Extra: all
Requires-Dist: dipy[benchmark,dev,doc,extra,ml,style,test,viz]; extra == "all"
Provides-Extra: style
Requires-Dist: ruff; extra == "style"
Requires-Dist: pre-commit; extra == "style"
Provides-Extra: viz
Requires-Dist: fury>=0.10.0; extra == "viz"
Requires-Dist: matplotlib; extra == "viz"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: coverage; extra == "test"
Requires-Dist: coveralls; extra == "test"
Requires-Dist: codecov; extra == "test"
Provides-Extra: ml
Requires-Dist: scikit_learn; extra == "ml"
Requires-Dist: pandas; extra == "ml"
Requires-Dist: statsmodels>=0.14.0; extra == "ml"
Requires-Dist: tables; extra == "ml"
Requires-Dist: tensorflow>=2.18.0; extra == "ml"
Requires-Dist: torch; extra == "ml"
Provides-Extra: dev
Requires-Dist: meson-python>=0.13; extra == "dev"
Requires-Dist: wheel; extra == "dev"
Requires-Dist: setuptools~=69.5; extra == "dev"
Requires-Dist: packaging>=21; extra == "dev"
Requires-Dist: ninja; extra == "dev"
Requires-Dist: Cython>=0.29.35; extra == "dev"
Requires-Dist: numpy>=1.22.4; extra == "dev"
Requires-Dist: spin>=0.5; extra == "dev"
Requires-Dist: build; extra == "dev"
Provides-Extra: extra
Requires-Dist: dipy[ml,viz]; extra == "extra"
Requires-Dist: cvxpy; extra == "extra"
Requires-Dist: scikit-image; extra == "extra"
Requires-Dist: boto3; extra == "extra"
Requires-Dist: numexpr; extra == "extra"
Provides-Extra: doc
Requires-Dist: numpydoc; extra == "doc"
Requires-Dist: sphinx>=7.2.6; extra == "doc"
Requires-Dist: texext; extra == "doc"
Requires-Dist: tomli; python_version < "3.11" and extra == "doc"
Requires-Dist: sphinxcontrib-bibtex; extra == "doc"
Requires-Dist: sphinx_design; extra == "doc"
Requires-Dist: sphinx-gallery>=0.10.0; extra == "doc"
Requires-Dist: tomli>=2.0.1; extra == "doc"
Requires-Dist: grg-sphinx-theme>=0.4.0; extra == "doc"
Requires-Dist: Jinja2; extra == "doc"
Provides-Extra: benchmark
Requires-Dist: asv; extra == "benchmark"
Requires-Dist: pyperf; extra == "benchmark"
Requires-Dist: virtualenv; extra == "benchmark"
Description-Content-Type: text/x-rst

.. image:: doc/_static/images/logos/dipy-logo.png
  :height: 180px
  :target: http://dipy.org
  :alt: DIPY - Diffusion Imaging in Python

|

.. image:: https://github.com/dipy/dipy/actions/workflows/test.yml/badge.svg?branch=master
  :target: https://github.com/dipy/dipy/actions/workflows/test.yml

.. image:: https://github.com/dipy/dipy/actions/workflows/build_docs.yml/badge.svg?branch=master
  :target: https://github.com/dipy/dipy/actions/workflows/build_docs.yml

.. image:: https://codecov.io/gh/dipy/dipy/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/dipy/dipy

.. image:: https://img.shields.io/pypi/v/dipy.svg
  :target: https://pypi.python.org/pypi/dipy

.. image:: https://anaconda.org/conda-forge/dipy/badges/platforms.svg
  :target: https://anaconda.org/conda-forge/dipy

.. image:: https://anaconda.org/conda-forge/dipy/badges/downloads.svg
  :target: https://anaconda.org/conda-forge/dipy

.. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
  :target: https://github.com/dipy/dipy/blob/master/LICENSE


DIPY [DIPYREF]_ is a python library for the analysis of MR diffusion imaging.

DIPY is for research only; please contact admins@dipy.org if you plan to deploy
in clinical settings.

Website
=======

Current information can always be found from the DIPY website - http://dipy.org

Mailing Lists
=============

Please see the DIPY community list at
https://mail.python.org/mailman3/lists/dipy.python.org/

Please see the users' forum at
https://github.com/dipy/dipy/discussions

Please join the gitter chatroom `here <https://gitter.im/dipy/dipy>`_.

Code
====

You can find our sources and single-click downloads:

* `Main repository`_ on Github.
* Documentation_ for all releases and current development tree.
* Download as a tar/zip file the `current trunk`_.

.. _main repository: http://github.com/dipy/dipy
.. _Documentation: http://dipy.org
.. _current trunk: http://github.com/dipy/dipy/archives/master


Installing DIPY
===============

DIPY can be installed using `pip`::

    pip install dipy

or using `conda`::

    conda install -c conda-forge dipy

For detailed installation instructions, including instructions for installing
from source, please read our `installation documentation <https://docs.dipy.org/stable/user_guide/installation.html>`_.

Python versions and dependencies
--------------------------------

DIPY follows the `Scientific Python`_ `SPEC 0 — Minimum Supported Versions`_
recommendation as closely as possible, including the supported Python and
dependencies versions.

Further information can be found in `Toolchain Roadmap <https://docs.dipy.org/stable/devel/toolchain.html>`_.

License
=======

DIPY is licensed under the terms of the BSD license.
Please see the `LICENSE file <https://github.com/dipy/dipy/blob/master/LICENSE>`_.

Contributing
============

We welcome contributions from the community. Please read our `Contributing guidelines <https://github.com/dipy/dipy/blob/master/.github/CONTRIBUTING.md>`_.

Reference
=========

.. [DIPYREF] E. Garyfallidis, M. Brett, B. Amirbekian, A. Rokem,
    S. Van Der Walt, M. Descoteaux, I. Nimmo-Smith and DIPY contributors,
    "DIPY, a library for the analysis of diffusion MRI data",
    Frontiers in Neuroinformatics, vol. 8, p. 8, Frontiers, 2014.


.. _`Scientific Python`: https://scientific-python.org/
.. _`SPEC 0 — Minimum Supported Versions`: https://scientific-python.org/specs/spec-0000/
