The anomalous diffusion library
================
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
<p align="center">
<img width="150" src="https://raw.githubusercontent.com/AnDiChallenge/andi_datasets/master/source_nbs/figures/logo.png">
</p>
<h3 align="center">
Generate, manage and analyze anomalous diffusion trajectories
</h3>
<p align="center">
<a href="https://doi.org/10.5281/zenodo.4775311"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.4775311.svg" alt="PyPI version"></a>
<a href="https://badge.fury.io/py/andi-datasets"><img src="https://badge.fury.io/py/andi-datasets.svg" alt="PyPI version"></a>
<a href="https://badge.fury.io/py/andi-datasets"><img src="https://img.shields.io/badge/python-3.10-red" alt="Python version"></a>
</p>
<p align="center">
<a href="https://andichallenge.github.io/andi_datasets/">Get started</a>
|
<a href="https://andichallenge.github.io/andi_datasets/lib_nbs/index_docs.html">Documentation</a>
|
<a href="https://andichallenge.github.io/andi_datasets/tutorials/index_tutorials.html">Tutorials</a>
| <a href="#cite-us">Cite us</a>
</p>
This library has been created in the framework of the [**Anomalous
Diffusion (AnDi) Challenge**](http://andi-challenge.org/) and allows to
create trajectories and datasets from various anomalous diffusion
models. You can install the package using:
``` python
pip install andi-datasets
```
You can then import the package in a Python3 environment using:
``` python
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)](https://journals.aps.org/prb/abstract/10.1103/PhysRevB.12.2455),
[fractional Brownian motion (FBM)](https://doi.org/10.1137%2F1010093),
[Lévy walks (LW)](https://doi.org/10.1103%2FPhysRevE.49.4873), [annealed
transit time model
(ATTM)](https://doi.org/10.1103%2FPhysRevLett.112.150603) and [scaled
Brownian motion (SBM)](https://doi.org/10.1103%2FPhysRevE.66.021114).
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](https://github.com/AnDiChallenge/andi_datasets/blob/master/source_nbs/tutorials/challenge_one_datasets.ipynb).
### 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](https://github.com/AnDiChallenge/andi_datasets/blob/master/source_nbs/tutorials/challenge_two_datasets.ipynb).
## 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)](https://doi.org/10.1038/s41467-021-26320-w).
If you want to reproduce the datasets used during the challenge, please
check [this
tutorial](https://github.com/AnDiChallenge/andi_datasets/blob/master/source_nbs/tutorials/challenge_one_submission.ipynb).
You can then test your predictions and compare them with the those of
challenge participants in this [online interactive
tool](http://andi-challenge.org/interactive-tool/).
### 2nd AnDi Challenge (2023)
The second AnDi challenge is [LIVE](https://andi-challenge.org/challenge-2024/). 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](https://github.com/AnDiChallenge/andi_datasets/blob/master/source_nbs/tutorials/challenge_two_datasets.ipynb).
## Version control
Details on each release are presented [here](https://github.com/AnDiChallenge/andi_datasets/blob/master/source_nbs/changes_andi_v2.ipynb).
## 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:
``` python
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**
``` python
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**
``` python
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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/andichallenge/andi_datasets/",
"name": "andi-datasets",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "anomalous diffusion",
"author": "Gorka Munoz-Gil",
"author_email": "munoz.gil.gorka@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/aa/e0/89e922cb7baa19bf99e5c07850dd668ef2adedc2892ee201cde647d41110/andi_datasets-2.1.2.tar.gz",
"platform": null,
"description": "The anomalous diffusion library\n================\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n<p align=\"center\">\n<img width=\"150\" src=\"https://raw.githubusercontent.com/AnDiChallenge/andi_datasets/master/source_nbs/figures/logo.png\">\n</p>\n<h3 align=\"center\">\nGenerate, manage and analyze anomalous diffusion trajectories\n</h3>\n<p align=\"center\">\n<a href=\"https://doi.org/10.5281/zenodo.4775311\"><img src=\"https://zenodo.org/badge/DOI/10.5281/zenodo.4775311.svg\" alt=\"PyPI version\"></a>\n<a href=\"https://badge.fury.io/py/andi-datasets\"><img src=\"https://badge.fury.io/py/andi-datasets.svg\" alt=\"PyPI version\"></a>\n<a href=\"https://badge.fury.io/py/andi-datasets\"><img src=\"https://img.shields.io/badge/python-3.10-red\" alt=\"Python version\"></a>\n</p>\n<p align=\"center\">\n<a href=\"https://andichallenge.github.io/andi_datasets/\">Get started</a>\n|\n<a href=\"https://andichallenge.github.io/andi_datasets/lib_nbs/index_docs.html\">Documentation</a>\n|\n<a href=\"https://andichallenge.github.io/andi_datasets/tutorials/index_tutorials.html\">Tutorials</a>\n| <a href=\"#cite-us\">Cite us</a>\n</p>\n\nThis library has been created in the framework of the [**Anomalous\nDiffusion (AnDi) Challenge**](http://andi-challenge.org/) and allows to\ncreate trajectories and datasets from various anomalous diffusion\nmodels. You can install the package using:\n\n``` python\npip install andi-datasets\n```\n\nYou can then import the package in a Python3 environment using:\n\n``` python\nimport andi_datasets\n```\n\n## Library organization\n\nThe `andi_datasets` class allows to generate, transform, analyse, save\nand load diffusion trajectories from a plethora of diffusion models and\nexperimental generated with various diffusion models. The library is\nstructured in two main blocks, containing either theoretical or\nphenomenological models. Here is a scheme of the library\u2019s content:\n\n\n\n### Theoretical models\n\nThe library allows to generate trajectories from various anomalous\ndiffusion models: [continuous-time random walk\n(CTRW)](https://journals.aps.org/prb/abstract/10.1103/PhysRevB.12.2455),\n[fractional Brownian motion (FBM)](https://doi.org/10.1137%2F1010093),\n[L\u00e9vy walks (LW)](https://doi.org/10.1103%2FPhysRevE.49.4873), [annealed\ntransit time model\n(ATTM)](https://doi.org/10.1103%2FPhysRevLett.112.150603) and [scaled\nBrownian motion (SBM)](https://doi.org/10.1103%2FPhysRevE.66.021114).\nYou can generate trajectories with the desired anomalous exponent in\neither one, two or three dimensions.\n\nExamples of their use and properties can be found in [this\ntutorial](https://github.com/AnDiChallenge/andi_datasets/blob/master/source_nbs/tutorials/challenge_one_datasets.ipynb).\n\n### Phenomenological models\n\nWe have also included models specifically developed to simulate\nrealistic physical systems, in which random events alter the diffusion\nbehaviour of the particle. The sources of these changes can be very\nbroad, from the presence of heterogeneities either in space or time, the\npossibility of creating dimers and condensates or the presence of\nimmobile traps in the environment.\n\nExamples of their use and properties can be found in [this\ntutorial](https://github.com/AnDiChallenge/andi_datasets/blob/master/source_nbs/tutorials/challenge_two_datasets.ipynb).\n\n## The AnDi Challenges\n\n### 1st AnDi Challenge (2020)\n\n\n\nThe first AnDi challenge was held between March and November 2020 and\nfocused on the characterization of trajectories arising from different\ntheoretical diffusion models under various experimental conditions. The\nresults of the challenge are published in this article: [Mu\u00f1oz-Gil et\nal., Nat Commun **12**, 6253\n(2021)](https://doi.org/10.1038/s41467-021-26320-w).\n\nIf you want to reproduce the datasets used during the challenge, please\ncheck [this\ntutorial](https://github.com/AnDiChallenge/andi_datasets/blob/master/source_nbs/tutorials/challenge_one_submission.ipynb).\nYou can then test your predictions and compare them with the those of\nchallenge participants in this [online interactive\ntool](http://andi-challenge.org/interactive-tool/).\n\n### 2nd AnDi Challenge (2023)\n\nThe second AnDi challenge is [LIVE](https://andi-challenge.org/challenge-2024/). 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](https://github.com/AnDiChallenge/andi_datasets/blob/master/source_nbs/tutorials/challenge_two_datasets.ipynb).\n\n## Version control\n\nDetails on each release are presented [here](https://github.com/AnDiChallenge/andi_datasets/blob/master/source_nbs/changes_andi_v2.ipynb).\n\n## Contributing\n\nThe AnDi challenge is a community effort, hence any contribution to this\nlibrary is more than welcome. If you think we should include a new model\nto the library, you can contact us in this mail:\n<andi.challenge@gmail.com>. You can also perform pull-requests and open\nissues with any feedback or comments you may have.\n\n## Cite us\n\nIf you found this package useful and used it in your projects, you can\nuse the following to directly cite the package:\n\n``` python\nMu\u00f1oz-Gil, G., Requena B., Volpe G., Garcia-March M.A. and Manzo C.\nAnDiChallenge/ANDI_datasets: Challenge 2020 release (v.1.0). Zenodo (2021). \nhttps://doi.org/10.5281/zenodo.4775311\n```\n\nOr you can cite the paper this package was developed for:\n\n**- AnDi Challenge 1**\n\n``` python\nG. Mu\u00f1oz-Gil, G. Volpe ... C. Manzo \nObjective comparison of methods to decode anomalous diffusion. \nNat Commun 12, 6253 (2021). \nhttps://doi.org/10.1038/s41467-021-26320-w\n```\n\n**- AnDi Challenge 2**\n\n``` python\nG. Mu\u00f1oz-Gil, H. Bachimanchi ... C. Manzo\nIn-principle accepted at Nature Communications (Registered Report Phase 1)\narXiv:2311.18100\nhttps://doi.org/10.48550/arXiv.2311.18100\n```\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "Generate, manage and analyze anomalous diffusion trajectories.",
"version": "2.1.2",
"project_urls": {
"Homepage": "https://github.com/andichallenge/andi_datasets/"
},
"split_keywords": [
"anomalous",
"diffusion"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20a6662c6561f09971e03876858f667df095898ea05d36363c5f4e6e35ada3cb",
"md5": "464cc9ae24b9e7a8293adfda8a5c26ae",
"sha256": "bdfcae857cf61d7038c7e80eebd5f161bd187b6e3cbcba2b4baaef3f01383eb7"
},
"downloads": -1,
"filename": "andi_datasets-2.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "464cc9ae24b9e7a8293adfda8a5c26ae",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 70961,
"upload_time": "2023-12-11T17:30:02",
"upload_time_iso_8601": "2023-12-11T17:30:02.140172Z",
"url": "https://files.pythonhosted.org/packages/20/a6/662c6561f09971e03876858f667df095898ea05d36363c5f4e6e35ada3cb/andi_datasets-2.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "aae089e922cb7baa19bf99e5c07850dd668ef2adedc2892ee201cde647d41110",
"md5": "442fad75e71258419d4b3ef91257ed1b",
"sha256": "37ef6850463735da50275a95ec2a6d0bd14be601a1536ddba6e774d7616e4de7"
},
"downloads": -1,
"filename": "andi_datasets-2.1.2.tar.gz",
"has_sig": false,
"md5_digest": "442fad75e71258419d4b3ef91257ed1b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 68700,
"upload_time": "2023-12-11T17:30:04",
"upload_time_iso_8601": "2023-12-11T17:30:04.702910Z",
"url": "https://files.pythonhosted.org/packages/aa/e0/89e922cb7baa19bf99e5c07850dd668ef2adedc2892ee201cde647d41110/andi_datasets-2.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-11 17:30:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "andichallenge",
"github_project": "andi_datasets",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "andi-datasets"
}
JSON
