VRE_RUNNER

class VRE_RUNNER.Wrapper(configuration=None)[source]

Bases: object

Functions for wrapping the tool set up and execution.

Methods Summary

`__init__`([configuration])	Initialise the tool with its configuration.
`run`(input_files, input_metadata, ...)	Main run function for running <myTool> tool.

Methods Documentation

__init__(configuration=None)[source]

Initialise the tool with its configuration.

Parameters: configuration (dict) – A dictionary containing parameters that define how the operation should be carried out, which are specific to <myTool> tool.

run(input_files, input_metadata, output_files, output_metadata)[source]

Main run function for running <myTool> tool.

Parameters

input_files (dict) – Dictionary of input files locations.
input_metadata (dict) – Dictionary of input files metadata.
output_files (dict) – Dictionary of output files locations expected to be generated.
output_metadata (list) – List of output files metadata expected to be generated.

Returns

Generated output files and their metadata.

Return type

dict, dict

VRE_RUNNER.main_wrapper(config_path, in_metadata_path, out_metadata_path)[source]

Main function.

This function launches the tool using configuration written in two json files: config.json and in_metadata.json.

Parameters

config_path (str) – Path to a valid VRE JSON file containing information on how the tool should be executed.
in_metadata_path (str) – Path to a valid VRE JSON file containing information on tool inputs.
out_metadata_path (str) – Path to write the VRE JSON file containing information on tool outputs.

Returns

If result is True, execution finished successfully. False, otherwise.

Return type

bool