Skip to main content

Community Framework for Enabling Scientific Workflow Research and Education

Project description

Build PyPI version License: LGPL v3 CodeFactor Documentation Status


A Community 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; and
  • Generating synthetic realistic workflow instances.

Installation

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

Requirements

Graphviz

WfCommons uses pygraphviz and thus needs the graphviz package installed (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

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 .

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.

@inproceedings{ferreiradasilva2020works,
  title = {WorkflowHub: Community Framework for Enabling Scientific Workflow Research and Development},
  author = {Ferreira da Silva, Rafael and Pottier, Lo\"ic and Coleman, Tain\~a and Deelman, Ewa and Casanova, Henri},
  booktitle = {2020 IEEE/ACM Workflows in Support of Large-Scale Science (WORKS)},
  year = {2020},
  pages = {49--56},
  doi = {10.1109/WORKS51914.2020.00012}
}

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-0.5.tar.gz (44.6 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: wfcommons-0.5.tar.gz
  • Upload date:
  • Size: 44.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/49.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.7

File hashes

Hashes for wfcommons-0.5.tar.gz
Algorithm Hash digest
SHA256 97ae067f877f195be5747612c769b7390502f419c76387abc05b00aade643515
MD5 41f70cf2b7eed3a7a7d4d54068f6eaab
BLAKE2b-256 873f1fee70df1db08589f6d2a3d5498e208e8da0d03ca79ddb61746e9ba4cb0f

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