DatomaWorkflow

class datoma.DatomaWorkflow(path_yaml=None, path_json=None, official_name=None, import_json=None)[source]

This class represents a workflow to be executed on Datoma’s infrastructure.

__init__(path_yaml=None, path_json=None, official_name=None, import_json=None)[source]

Initializes a DatomaWorkflow object.

Parameters:

  • path_yaml (str, optional) – Path where the .yml file is located, defaults to None.

  • path_json (str, optional) – Path where the .json file is located, defaults to None.

  • official_name (str, optional) – Official name of the workflow, defaults to None.

  • import_json (str, optional) – Path to a JSON file with the workflow information, defaults to None.

Raises:

  • Exception – If two or more parameters are specified at the same time, besides path_yaml and path_json.

  • FileNotFoundError – If the file could not be found.

  • Exception – If the official workflow could not be retrieved.

Methods

__init__([path_yaml, path_json, ...])

Initializes a DatomaWorkflow object.

set_params(job_id, params_dictionary[, ...])

Sets the parameters of a job.

add_job(job_id, job)

Adds a job to the workflow.

set_input(job_id, input_dictionary[, ...])

Sets the input of a job.

set_global_input(input_dictionary[, ...])

Sets the global input of the workflow.

set_global_params(dictionary)

Changes the value to the specified global parameters of the workflow.

submit([name])

Submits the workflow to Datoma's infrastructure.

download([output_path])

Downloads the output files of the workflow.

list_outputs([regex])

Lists the output files of the workflow filtered (if specified) by a regex.

export_json([path])

Exports the workflow information to a JSON file.

To see usage examples of the Datomaworkflow module, refer to Submitting an unofficial workflow.