Skip to main content

A package for accessing and analysing MalariaGEN data.

Project description

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:

Release notes (change log)

See GitHub releases for release notes.

Developer setup

To get setup for development, see this video and the instructions below.

Fork and clone this repo:

git clone git@github.com:[username]/malariagen-data-python.git

Install Python, e.g.:

sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt install python3.9 python3.9-venv

Install pipx, e.g.:

python3.9 -m pip install --user pipx
python3.9 -m pipx ensurepath

Install poetry, e.g.:

pipx install poetry==1.8.2 --python=/usr/bin/python3.9

Create development environment:

cd malariagen-data-python
poetry use 3.9
poetry install

Activate development environment:

poetry shell

Install pre-commit and pre-commit hooks:

pipx install pre-commit --python=/usr/bin/python3.9
pre-commit install

Run pre-commit checks (isort, black, blackdoc, flake8, ...) manually:

pre-commit run --all-files

Run fast unit tests using simulated data:

poetry run pytest -v tests/anoph

To run legacy tests which read data from GCS, you'll need to install the Google Cloud CLI. E.g., if on Linux:

./install_gcloud.sh

You'll then need to obtain application-default credentials, e.g.:

./google-cloud-sdk/bin/gcloud auth application-default login

Once this is done, you can run legacy tests:

poetry run pytest --ignore=tests/anoph -v tests

Tests will run slowly the first time, as data required for testing will be read from GCS. Subsequent runs will be faster as data will be cached locally in the "gcs_cache" folder.

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

malariagen_data-9.0.0.tar.gz (132.6 kB view details)

Uploaded Source

Built Distribution

malariagen_data-9.0.0-py3-none-any.whl (159.9 kB view details)

Uploaded Python 3

File details

Details for the file malariagen_data-9.0.0.tar.gz.

File metadata

  • Download URL: malariagen_data-9.0.0.tar.gz
  • Upload date:
  • Size: 132.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.12 Linux/6.5.0-1018-azure

File hashes

Hashes for malariagen_data-9.0.0.tar.gz
Algorithm Hash digest
SHA256 c3410e1603216d717e286c61294b51ef8c35f0869ff8746388952bd2ceb7a552
MD5 a64785a218f87e011802bbfc1df33750
BLAKE2b-256 48cfdbf62cca9c39cf43ea74039b04331c748333ae6a6d7afecf3c4bbdab9094

See more details on using hashes here.

Provenance

File details

Details for the file malariagen_data-9.0.0-py3-none-any.whl.

File metadata

  • Download URL: malariagen_data-9.0.0-py3-none-any.whl
  • Upload date:
  • Size: 159.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.12 Linux/6.5.0-1018-azure

File hashes

Hashes for malariagen_data-9.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c895acb6d2c0d208345446ecf1310604e224613bcc9aaa64650b43116a189aee
MD5 700b010796e99fe3c7044ad9284fcdf6
BLAKE2b-256 7ff7d1b6c4aa4b655393e9577671c2c2474947f0157f312b4f1c292f76de6b8d

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page