dmipy

Diffusion Microstructure Imaging in Python — the umbrella over the two engines, and the home of the documentation at dmipy.org.

dmipy-sim — JAX Monte-Carlo forward simulator (arbitrary G(t), restricted diffusion, surface relaxivity, permeability, T2).
dmipy-fit — analytical multi-compartment fitting + JAX GPU (T2 + surface-relaxivity factors, CSD, NNLS myelin-water fraction).

One free-waveform substrate interface, fit → sim.

pip install dmipy            # dmipy-sim + dmipy-fit
pip install "dmipy[cuda12]"  # + JAX GPU

import dmipy_sim, dmipy_fit   # no importable `dmipy`; import the engines directly

Upgrading from dmipy 1.x? dmipy 2.0 is a ground-up rewrite with a different architecture and API. The 1.x line (the original 2019 toolbox, Fick–Wassermann–Deriche) was a single importable dmipy package; 2.x is a meta-package with no importable dmipy module — you import dmipy_sim / dmipy_fit. Old import dmipy code will not run under 2.x. To stay on the original toolbox, pin pip install "dmipy<2" (it remains available on PyPI).

This repo

pyproject.toml — the thin dmipy meta-package (installs the two engines).
docs/ + mkdocs.yml — the dmipy.org site (MkDocs Material; built and deployed by .github/workflows/docs.yml).
papers/ — reproducible manuscripts (source + PDF + rerunnable figures); currently papers/surface_relaxivity_bias/ — "Surface relaxivity biases diffusion and relaxometry microstructure estimates." See papers/README.md.

Build the docs locally:

pip install ".[docs]"
mkdocs serve

License

Dual-licensed: GNU AGPL-3.0 for open-source use, or a commercial license for proprietary/closed use — the same terms apply to both engines. See LICENSE and LICENSING.md (commercial: rutger.fick@dmrai-lab.org).

The lab and its philosophy: dmrai-lab.org.

Development Status
- 4 - Beta
Intended Audience
- Science/Research
License
- OSI Approved :: GNU Affero General Public License v3
Operating System
- OS Independent
Programming Language
- Python :: 3
Topic
- Scientific/Engineering

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dmipy-2.0.0.tar.gz (14.8 kB view details)

Uploaded Jul 10, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

dmipy-2.0.0-py3-none-any.whl (14.5 kB view details)

Uploaded Jul 10, 2026 Python 3

File details

Details for the file dmipy-2.0.0.tar.gz.

File metadata

Download URL: dmipy-2.0.0.tar.gz
Upload date: Jul 10, 2026
Size: 14.8 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dmipy-2.0.0.tar.gz
Algorithm	Hash digest
SHA256	`a506183bcb6ce16827872131052c99e6056a8e82ac277019ebf00611a6c61e21`
MD5	`3c4d20f99eaf2cfe12cc8faf1c247783`
BLAKE2b-256	`bb88d59cf25e5aed60974eb3a4dc61a649dc4f272d94fc511b85246ac7990bc1`

See more details on using hashes here.

Provenance

The following attestation bundles were made for dmipy-2.0.0.tar.gz:

Publisher: publish.yml on dmrai-lab/dmipy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: dmipy-2.0.0.tar.gz
- Subject digest: a506183bcb6ce16827872131052c99e6056a8e82ac277019ebf00611a6c61e21
- Sigstore transparency entry: 2138427838
- Sigstore integration time: Jul 10, 2026
Source repository:
- Permalink: dmrai-lab/dmipy@55cbb0fb978160f308df579a37d0fe09b571a336
- Branch / Tag: refs/tags/v2.0.0
- Owner: https://github.com/dmrai-lab
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@55cbb0fb978160f308df579a37d0fe09b571a336
- Trigger Event: release