Metadata-Version: 2.1
Name: andi-datasets
Version: 0.0.5
Summary: The Anomalous Diffusion Challenge package
Home-page: https://github.com/AnDiChallenge/ANDI_datasets
Author: Gorka Munoz-Gil
Author-email: munoz.gil.gorka@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# The Anomalous Diffusion (AnDi) Challenge Package

This package contains the necessary functions to generate datasets of trajectories for the [**Anomalous Diffusion (AnDi) Challenge**](www.andi-challenge.org). 

## Getting started

- Install the package using:

```
pip install andi-datasets
```

- Import the package in a Python3 environment using:

```python
import andi
```


## Available tools

There are two main classes in the ANDI package:

1. `andi_datasets`: creates and manages trajectory datasets.

2. `diffusion_models`: contains various diffusion models from which create trajectories for various parameters in one, two and three dimensions.

For more details, please visit the [hosting repository](https://github.com/AnDiChallenge/ANDI_datasets) where you can find an [example of use](https://github.com/AnDiChallenge/ANDI_datasets/blob/master/examples_andi.ipynb).



