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/simexp/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.1.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.1-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: airoh-0.3.1.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.1.tar.gz
Algorithm Hash digest
SHA256 abe6475c04064ddcc21ca5cc78ed61ac6f8ec38542eaba364d1a44b489d7e64e
MD5 8bdf207bca4365467b60d407a4b7cfef
BLAKE2b-256 34f1df48080eb429ccd1bd2bd7a0b56888e232f9b6c1a100575eaa7fa52e31e7

See more details on using hashes here.

Provenance

The following attestation bundles were made for airoh-0.3.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: airoh-0.3.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8c7475e5d81fb3c255e996dbcca9114f6e304040432e8186be7653d44f8155b4
MD5 d2ba81736a1fca39ac19cf6298dfd8b2
BLAKE2b-256 955de808b2a237c7f863cb81676cadd9e42fb8586f3a3af1ea2f4f08acf0cb0f

See more details on using hashes here.

Provenance

The following attestation bundles were made for airoh-0.3.1-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