Welcome to plumpy’s documentation!

A python workflows library that supports writing Processes with a well defined set of inputs and outputs that can be strung together.

RabbitMQ is used to queue up, control and monitor running processes via the kiwipy library.

Features:

• Process can be remotely controlled by sending messages over RabbitMQ all from a simple interface

• Process can be saved between steps and continued later

• Optional explicit specification of inputs and outputs including their types, validation functions, help strings, etc.

• To install plumpy follow the instructions in the installation section

• After you have successfully installed plumpy, you can find some tips in the user guide section to help you on your way

• The design concepts behind plumpy can be found in concepts section

• If you want to develop your process and workchain, you’ll find Develop Process section and Develop WorkChain section useful.

• Use the complete API documentation, the Module Index or the Index to find code you’re looking for

Getting Started

• Installation
  • Preparing Your Python Runtime Environment
  • Basic Installation
  • Building from Source
• Quickstart Examples
  • Creating and running basis Process
  • Creating and running basis WorkChain

Basic

• Introduction
• Concepts
  • Process
  • Workchain
• Process
  • Persistence
  • State machine
  • How state transition
  • Remote Controller
• WorkChain
  • Context
  • Strung processes or workchains in a WorkChain
  • Control flow statement in workchain
• Controller

Advanced

• Writing Process
• Writing WorkChain
• API Reference
  • Process
  • Finite State Machine
  • WorkChain
  • Controller

Indices and tables

• Index

• Search Page

Versioning

This software follows Semantic Versioning