inm_rspace.workflow module

Examples

A fully outomated workflow that takes RSpace documents with attached CSV files and plots them:

The Input fields in the RSpace document look like this:

The automatically generated Output field looks like this:

The code for this example can be found here.

API documentation

class inm_rspace.workflow.Workflow(document: dict, path='/home/runner')

Bases: object

check_args(fun)

check_completed()

Check if the requested workflow has already been completed.

check_workflow()

Check if the requested workflow matches this one.

define()

Define the properties of the Workflow.

This function should be redefined for every subclass of Workflow.

download_files(files)

Download files from the Rspace Gallery into this workflow’s working directory.

Parameters:

files (list<dict>) – List of Rspace file objects

get_args()

Read the keyword arguments from the kwargs field of the Rspace document.

get_input_files()

Check if all expected input files have been provided in the request. If yes, download them.

init_members()

prepare()

Prepare for workflow execution:

• check if request has already been completed

• check if the requested workflow matches this one

• create a working directory for the workflow

• try to download files from the request

reset_document()

Reset the request document to an empty ‘output’ field and ‘completed’ field ‘no’.

run()

Run the entire Workflow.

This function should be redefined for every subclass of Workflow.

summary()

Summarize the success of the workflow based on generated error codes.

update_document()

Update the request document with the results of the workflow.

workflow()

The actual workflow to be executed

inm_rspace.workflow.get_file_paths(field)

Not yet working!