Metadata-Version: 2.4
Name: malariagen_data
Version: 15.7.0
Summary: A package for accessing and analysing MalariaGEN data.
License: MIT
License-File: LICENSE
Author: Chris Clarkson
Author-email: Chris.Clarkson@lstmed.ac.uk
Requires-Python: >=3.10,<3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: BioPython
Requires-Dist: anjl (>=1.2.0)
Requires-Dist: bed_reader
Requires-Dist: bokeh (>=3.7.0)
Requires-Dist: dash (<3.0.0)
Requires-Dist: dash-cytoscape (>=1.0.0)
Requires-Dist: dask[array]
Requires-Dist: distributed
Requires-Dist: fsspec
Requires-Dist: gcsfs
Requires-Dist: google-auth
Requires-Dist: igv-notebook (>=0.2.3)
Requires-Dist: ipinfo (!=4.4.1)
Requires-Dist: ipyleaflet (>=0.17.0)
Requires-Dist: ipywidgets
Requires-Dist: llvmlite
Requires-Dist: numba (>=0.60.0)
Requires-Dist: numcodecs (>=0.13,<0.16)
Requires-Dist: numpy (>=2.0.2,<2.1)
Requires-Dist: numpydoc_decorator (>=2.1.0)
Requires-Dist: orjson
Requires-Dist: pandas (==2.3.2)
Requires-Dist: plotly
Requires-Dist: protopunica (>=0.14.8.post2)
Requires-Dist: pydantic (>=2.0.0)
Requires-Dist: s3fs
Requires-Dist: scikit-allel (>=1.3.13)
Requires-Dist: scipy
Requires-Dist: statsmodels (>=0.14.2)
Requires-Dist: tqdm
Requires-Dist: typeguard (>=4.0.0)
Requires-Dist: typing_extensions
Requires-Dist: xarray
Requires-Dist: yaspin
Requires-Dist: zarr (>=2.18.3,<3.0.0)
Project-URL: Documentation, https://malariagen.github.io/malariagen-data-python/latest/
Project-URL: Repository, https://github.com/malariagen/malariagen-data-python
Description-Content-Type: text/markdown

# `malariagen_data` - analyse MalariaGEN data from Python

This Python package provides methods for accessing and analysing data from MalariaGEN.

## Installation

The `malariagen_data` Python package is available from the Python
package index (PyPI) and can be installed via `pip`, e.g.:

```bash
pip install malariagen-data
```

## Documentation

Documentation of classes and methods in the public API are available
from the following locations:

-   [Ag3 API
    docs](https://malariagen.github.io/malariagen-data-python/latest/Ag3.html)

-   [Af1 API
    docs](https://malariagen.github.io/malariagen-data-python/latest/Af1.html)

-   [Amin1 API
    docs](https://malariagen.github.io/malariagen-data-python/latest/Amin1.html)

-  [Adir1 API
    docs](https://malariagen.github.io/malariagen-data-python/latest/Adir1.html)

-   [Pf8 API
    docs](https://malariagen.github.io/parasite-data/pf8/api.html)

-   [Pf7 API
    docs](https://malariagen.github.io/parasite-data/pf7/api.html)

-   [Pv4 API
    docs](https://malariagen.github.io/parasite-data/pv4/api.html)

## Release notes (change log)

See [GitHub releases](https://github.com/malariagen/malariagen-data-python/releases)
for release notes.

## Developer setup

To get setup for development, see [this video if you prefer VS Code](https://youtu.be/zddl3n1DCFM), or [this older video if you prefer PyCharm](https://youtu.be/QniQi-Hoo9A).

For detailed setup instructions, see:
- [Linux setup guide](LINUX_SETUP.md)
- [macOS setup guide](MACOS_SETUP.md)
- [Windows setup guide](WINDOWS_SETUP.md)
- [Google Colab (TPU) setup guide](docs/source/colab_tpu_runtime.rst)
Detailed instructions can be found in the [Contributors guide](https://github.com/malariagen/malariagen-data-python/blob/master/CONTRIBUTING.md).

## AI use policy and guidelines

See [AI use policy and guidelines](https://github.com/malariagen/malariagen-data-python/blob/master/AI-POLICY.md) for more details.

## Release process

Create a new GitHub release. That's it. This will automatically
trigger publishing of a new release to PyPI and a new version of
the documentation via GitHub Actions.

The version switcher for the documentation can then be updated by
modifying the `docs/source/_static/switcher.json` file accordingly.

## Citation

If you use the `malariagen_data` package in a publication
or include any of its functions or code in other materials (_e.g._ training resources),
please cite: [doi.org/10.5281/zenodo.11173411](https://doi.org/10.5281/zenodo.11173411)

Some functions may require additional citations to acknowledge specific contributions. These are indicated in the description for each relevant function.

For any questions, please feel free to contact us at: [support@malariagen.net](mailto:support@malariagen.net)


## Sponsorship

This project is currently supported by the following grants:

* [BMGF INV-068808](https://www.gatesfoundation.org/about/committed-grants/2024/04/inv-068808)
* [BMGF INV-062921](https://www.gatesfoundation.org/about/committed-grants/2024/07/inv-062921)

This project was previously supported by the following grants:

* [BMGF INV-001927](https://www.gatesfoundation.org/about/committed-grants/2019/11/inv001927)

