Skip to main content

A Framework for Enabling Scientific Workflow Research and Education

Project description

Build  PyPI version  License: LGPL v3  CodeFactor  Documentation Status  Codecov  Downloads


A Framework for Enabling Scientific Workflow Research and Development

This Python package provides a collection of tools for:

  • Analyzing instances of actual workflow executions;
  • Producing recipes structures for creating workflow recipes for workflow generation;
  • Generating synthetic realistic workflow instances; and
  • Generating realistic workflow benchmark specifications.

Open In Gitpod

Installation

WfCommons is available on PyPI. WfCommons requires Python3.9+ and has been tested on Linux and macOS.

Installation using pip

While pip can be used to install WfCommons, we suggest the following approach for reliable installation when many Python environments are available:

$ python3 -m pip install wfcommons

Retrieving the latest unstable version

If you want to use the latest WfCommons unstable version, that will contain brand new features (but also contain bugs as the stabilization work is still underway), you may consider retrieving the latest unstable version.

Cloning from WfCommons's GitHub repository:

$ git clone https://github.com/wfcommons/wfcommons
$ cd wfcommons
$ pip install .

Optional Requirements

Graphviz

WfCommons uses pygraphviz for generating visualizations for the workflow task graph. If you want to enable this feature, you will have to install the graphviz package (version 2.16 or later). You can install graphviz easily on Linux with your favorite package manager, for example for Debian-based distributions:

sudo apt-get install graphviz libgraphviz-dev

and for RedHat-based distributions:

sudo yum install python-devel graphviz-devel

On macOS you can use brew package manager:

brew install graphviz

Then you can install pygraphviz by running:

python3 -m pip install pygraphviz

pydot

WfCommons uses pydot for reading and writing DOT files. If you want to enable this feature, you will have to install the pydot package:

python3 -m pip install pydot

Get in Touch

The main channel to reach the WfCommons team is via the support email: support@wfcommons.org.

Bug Report / Feature Request: our preferred channel to report a bug or request a feature is via
WfCommons's Github Issues Track.

Citing WfCommons

When citing WfCommons, please use the following paper. You should also actually read that paper, as it provides a recent and general overview on the framework.

@article{wfcommons,
    title = {{WfCommons: A Framework for Enabling Scientific Workflow Research and Development}},
    author = {Coleman, Taina and Casanova, Henri and Pottier, Loic and Kaushik, Manav and Deelman, Ewa and Ferreira da Silva, Rafael},
    journal = {Future Generation Computer Systems},
    volume = {128},
    number = {},
    pages = {16--27},
    doi = {10.1016/j.future.2021.09.043},
    year = {2022},
}

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

wfcommons-1.2.tar.gz (5.8 MB view details)

Uploaded Source

Built Distribution

wfcommons-1.2-cp312-cp312-macosx_11_0_arm64.whl (6.2 MB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

File details

Details for the file wfcommons-1.2.tar.gz.

File metadata

  • Download URL: wfcommons-1.2.tar.gz
  • Upload date:
  • Size: 5.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for wfcommons-1.2.tar.gz
Algorithm Hash digest
SHA256 9796fa81fe85f2116f679156ad7496530172f81f560542a87a82e3914ff2d4df
MD5 71595e195daa739a8c958f587b1a9d27
BLAKE2b-256 64db395527b6624d6dc228c725887fbac5355b50d15014c7179d880f36052107

See more details on using hashes here.

File details

Details for the file wfcommons-1.2-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for wfcommons-1.2-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 456482183fe515c2e0f47e2bc45c89aa0a3f0f66f3f9b7fe931f10b5c26cf8f5
MD5 d9f11d87f621b902a057cf964e901e6b
BLAKE2b-256 5401db92ad9d4c47c13e500be81d0d42e2de5d633431aab476a27973cbee09f9

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