malariagen_data 15.8.0

A package for accessing and analysing MalariaGEN data.

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.:

pip install malariagen-data

Documentation

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

• Ag3 API docs

• Af1 API docs

• Amin1 API docs

• Adir1 API docs

• Pf8 API docs

• Pf7 API docs

• Pv4 API docs

Release notes (change log)

See GitHub releases for release notes.

Developer setup

To get setup for development, see this video if you prefer VS Code, or this older video if you prefer PyCharm.

For detailed setup instructions, see:

• Linux setup guide
• macOS setup guide
• Windows setup guide
• Google Colab (TPU) setup guide Detailed instructions can be found in the Contributors guide.

AI use policy and guidelines

See AI use policy and guidelines 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

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: [e-mail]

Sponsorship

This project is currently supported by the following grants:

• BMGF INV-068808
• BMGF INV-062921

This project was previously supported by the following grants:

• BMGF INV-001927