Skip to main content

A lightweight task library for reproducible workflows

Project description

Because reproducible science takes clean tasks. And why don't you have a cup of relaxing jasmin tea?

airoh is a lightweight Python task library built with invoke, designed for reproducible research workflows. It provides pre-written, modular task definitions that can be easily reused in your own tasks.py file — no boilerplate, just useful automation. Access the documentation of the library on the airoh docs website for a list of available airoh tasks.

Installation

Installation through PIP:

pip install airoh

For local deployment:

git clone https://github.com/airoh-pipeline/airoh.git
cd airoh
pip install -e .

Usage

You can use airoh in your project simply by importing tasks in your tasks.py file.

Minimal Example

# tasks.py
from airoh.utils import run_notebooks, setup_env_python

Now you can call:

invoke run-notebooks
invoke setup-env-python

Requirements

  • Python ≥ 3.8
  • invoke ≥ 2.0
  • Docker (for container tasks)
  • Apptainer (optional, for .sif support)
  • jupyter (if using run-notebooks)

Note that a few more requirements are required for development, in particular pdoc which is used to generate the documentation website.

Philosophy

Inspired by Uncle Iroh from Avatar: The Last Airbender, airoh aims to bring simplicity, reusability, and clarity to research infrastructure — one well-structured task at a time. It is meant to support a concrete implementation of the YODA principles.

License

MIT © airoh contributors

Project details


Download files

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

Source Distribution

airoh-0.3.2.tar.gz (16.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

airoh-0.3.2-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file airoh-0.3.2.tar.gz.

File metadata

  • Download URL: airoh-0.3.2.tar.gz
  • Upload date:
  • Size: 16.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for airoh-0.3.2.tar.gz
Algorithm Hash digest
SHA256 f46072d98e69a9ca1fe19d6f45e2b8478145458db8b56994ba7ebe467141f0ea
MD5 5517459e3a5437c97a30d0e5eedd5f74
BLAKE2b-256 48e18e8c93232adf704502c8fec87c7ddd90ff446df605377a9dafd0d31267fa

See more details on using hashes here.

Provenance

The following attestation bundles were made for airoh-0.3.2.tar.gz:

Publisher: publish.yml on airoh-pipeline/airoh

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file airoh-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: airoh-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for airoh-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 571de3b4fceb9a7260f95762ffeaec69c2f6271947579a09a093ccf517b8a284
MD5 6b54c5d9a98b91f15cf7500006d3c499
BLAKE2b-256 445d37d4cfb65f8d4d8a17da7c0b89b5a4c4056dfad941cf10eaaa54b21d064d

See more details on using hashes here.

Provenance

The following attestation bundles were made for airoh-0.3.2-py3-none-any.whl:

Publisher: publish.yml on airoh-pipeline/airoh

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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