Skip to main content

Workflow Description Language (WDL) local runner & developer toolkit

Project description

miniwdl

Workflow Description Language local runner & developer toolkit for Python 3.8+

Project Status MIT license CI Coverage Status Docs Status

Install miniwdl

Installation requires Python 3.8+, pip (or conda) and Docker (or Podman/Singularity/udocker). Linux preferred; macOS compatible with extra steps. More detail in full documentation.

  • Install with pip PyPI version : run pip3 install miniwdl
  • Install with conda Anaconda-Server Badge : setup conda-forge and run conda install miniwdl
  • Verify your miniwdl installation: miniwdl run_self_test
  • Install from source code for development: see CONTRIBUTING.md

Use miniwdl

Run an example bioinformatics WDL pipeline using miniwdl, or learn more abut miniwdl via a short course (screencast examples). If you are new to the WDL language, see the open source learn-wdl course.

Documentation

The online documentation includes a user tutorial, reference manual, and Python development codelabs: Docs Status

See the Releases for change logs. The Project board shows the current prioritization of issues.

Scaling up

The miniwdl runner schedules WDL tasks in parallel up to the CPUs & memory available on the local host; so a more-powerful host enables larger workloads. Separately-maintained projects can distribute tasks to cloud & HPC backends with a shared filesystem:

Getting Help

Contributing

Feedback and contributions to miniwdl are welcome, via issues and pull requests on this repository. See CONTRIBUTING.md for guidelines, instructions to set up your development environment, and a codebase overview.

Security

Please disclose security issues responsibly by contacting security@chanzuckerberg.com.

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

miniwdl-1.13.0.tar.gz (480.0 kB view details)

Uploaded Source

Built Distribution

miniwdl-1.13.0-py3-none-any.whl (196.4 kB view details)

Uploaded Python 3

File details

Details for the file miniwdl-1.13.0.tar.gz.

File metadata

  • Download URL: miniwdl-1.13.0.tar.gz
  • Upload date:
  • Size: 480.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for miniwdl-1.13.0.tar.gz
Algorithm Hash digest
SHA256 b062583de1fdf6ede2fd7d324444f1f82450edfaca95ee8a0bb03248055793e9
MD5 35ff8b441f699e55cea7d9cddb85267d
BLAKE2b-256 583a9725a3c3bc3da19d39a0f0a94d94986aad444361c7cb34a751b6e9ee089c

See more details on using hashes here.

File details

Details for the file miniwdl-1.13.0-py3-none-any.whl.

File metadata

  • Download URL: miniwdl-1.13.0-py3-none-any.whl
  • Upload date:
  • Size: 196.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for miniwdl-1.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 53b4c7cf3c756b52c757e38aa761f51df9f20cecccff2b78fa95c5e201ae02ad
MD5 e74463cc22edd91b17133c0cf5909454
BLAKE2b-256 db61b6546c6f42e5386ed3e5bf847a04b7a68e173816c58e1fd903652789db96

See more details on using hashes here.

Supported by

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