Skip to main content

The anomalous diffusion library

Generate, manage and analyze anomalous diffusion trajectories

PyPI version PyPI version Python version

Get started \| Documentation \| Tutorials \| Cite us

This library has been created in the framework of the Anomalous Diffusion (AnDi) Challenge and allows to create trajectories and datasets from various anomalous diffusion models. You can install the package using:

pip install andi-datasets

You can then import the package in a Python3 environment using:

import andi_datasets

Library organization

The andi_datasets class allows to generate, transform, analyse, save and load diffusion trajectories from a plethora of diffusion models and experimental generated with various diffusion models. The library is structured in two main blocks, containing either theoretical or phenomenological models. Here is a scheme of the library’s content:

Theoretical models

The library allows to generate trajectories from various anomalous diffusion models: continuous-time random walk (CTRW), fractional Brownian motion (FBM), Lévy walks (LW), annealed transit time model (ATTM) and scaled Brownian motion (SBM). You can generate trajectories with the desired anomalous exponent in either one, two or three dimensions.

Examples of their use and properties can be found in this tutorial.

Phenomenological models

We have also included models specifically developed to simulate realistic physical systems, in which random events alter the diffusion behaviour of the particle. The sources of these changes can be very broad, from the presence of heterogeneities either in space or time, the possibility of creating dimers and condensates or the presence of immobile traps in the environment.

Examples of their use and properties can be found in this tutorial.

The AnDi Challenges

1st AnDi Challenge (2020)

The first AnDi challenge was held between March and November 2020 and focused on the characterization of trajectories arising from different theoretical diffusion models under various experimental conditions. The results of the challenge are published in this article: Muñoz-Gil et al., Nat Commun 12, 6253 (2021).

If you want to reproduce the datasets used during the challenge, please check this tutorial. You can then test your predictions and compare them with the those of challenge participants in this online interactive tool.

2nd AnDi Challenge (2023 / 2024)

The second AnDi challenge is LIVE. Follow the previous link to keep updated on all news. If you want to learn more about the data we will use, you can check this tutorial.

We have officialy released the Benchark dataset of the 2nd AnDi Challenge. You can find all details on we created it in this tutorial.

Version control

Details on each release are presented here.

Contributing

The AnDi challenge is a community effort, hence any contribution to this library is more than welcome. If you think we should include a new model to the library, you can contact us in this mail: andi.challenge@gmail.com. You can also perform pull-requests and open issues with any feedback or comments you may have.

Cite us

If you found this package useful and used it in your projects, you can use the following to directly cite the package:

Muñoz-Gil, G., Requena B., Volpe G., Garcia-March M.A. and Manzo C.
AnDiChallenge/ANDI_datasets: Challenge 2020 release (v.1.0). Zenodo (2021). 
https://doi.org/10.5281/zenodo.4775311

Or you can cite the paper this package was developed for:

- AnDi Challenge 1

G. Muñoz-Gil, G. Volpe ... C. Manzo 
Objective comparison of methods to decode anomalous diffusion. 
Nat Commun 12, 6253 (2021). 
https://doi.org/10.1038/s41467-021-26320-w

- AnDi Challenge 2

G. Muñoz-Gil, H. Bachimanchi ...  C. Manzo
In-principle accepted at Nature Communications (Registered Report Phase 1)
arXiv:2311.18100
https://doi.org/10.48550/arXiv.2311.18100

Metadata

Release files for andi-datasets 2.1.13

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for andi-datasets 2.1.13
File Size Uploaded Provenance Actions
andi_datasets-2.1.13.tar.gz 75.3 kB Without provenance Details for andi_datasets-2.1.13.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for andi-datasets 2.1.13
File Interpreter ABI Platform Actions
andi_datasets-2.1.13-py3-none-any.whl Python 3 none any Details for andi_datasets-2.1.13-py3-none-any.whl

Total release size: 151.8 kB

Release files / andi_datasets-2.1.13.tar.gz

Download URL andi_datasets-2.1.13.tar.gz
Size 75.3 kB
Tags Source
SHA-256 checksum
How to use checksums
3f7d77be52c900d00847d14853f45dd1c3b036da360778b0252c2895fa95bc77
BLAKE2b-256 checksum
How to use checksums
420f0056c218bcf9cdc31966090e82f4d7e1bc5f5fb2ac2ecbd403c7accd3562
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.8

Release files / andi_datasets-2.1.13-py3-none-any.whl

Download URL andi_datasets-2.1.13-py3-none-any.whl
Size 76.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
98156ba4ec68450fd8f2f9ccbb6d9fe9c623c70e494d64791dd843e536c1779c
BLAKE2b-256 checksum
How to use checksums
373969efcf85e9c029395d5a15b21874fced4731d10a0056477ecea559d5c920
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.10.8

Security for andi-datasets 2.1.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page