resolwe 10.0.0

Open source enterprise dataflow engine in Django

Resolwe is an open source dataflow package for Django framework. We envision Resolwe to follow the Common Workflow Language specification, but the current implementation does not yet fully support it. Resolwe offers a complete RESTful API to connect with external resources. A collection of bioinformatics pipelines is available in Resolwe Bioinformatics.

Docs & Help

Read about architecture, getting started, how to write processes, RESTful API details, and API Reference in the documentation.

To chat with developers or ask for help, join us on Slack.

Install

Prerequisites

Make sure you have Python 3.6 installed on your system. If you don’t have it yet, follow these instructions.

Resolwe requires PostgreSQL (9.4+). Many Linux distributions already include the required version of PostgreSQL (e.g. Fedora 22+, Debian 8+, Ubuntu 15.04+) and you can simply install it via distribution’s package manager. Otherwise, follow these instructions.

Additionally, installing some (indirect) dependencies from PyPI will require having a C compiler (e.g. GCC) as well as Python development files installed on the system.

Note

The preferred way to install the C compiler and Python development files is to use your distribution’s packages, if they exist. For example, on a Fedora/RHEL-based system, that would mean installing gcc and python3-devel packages.

Using PyPI

pip install resolwe

Using source on GitHub

pip install https://github.com/genialis/resolwe/archive/<git-tree-ish>.tar.gz

where <git-tree-ish> can represent any commit SHA, branch name, tag name, etc. in Resolwe’s GitHub repository. For example, to install the latest Resolwe from the master branch, use:

pip install https://github.com/genialis/resolwe/archive/master.tar.gz

Contribute

We welcome new contributors. To learn more, read Contributing section of our documentation.