VRE_Tool

class tool.VRE_Tool.myTool(configuration=None)

Bases: Tool

This class define <myTool> Tool.

Attributes Summary

DEFAULT_KEYS	config.json default keys
PYTHON_SCRIPT_PATH	<myApplication>

Methods Summary

__init__([configuration])	Init function.
run(input_files, input_metadata, ...)	The main function to run the <myTool> tool.
toolExecution(input_files)	The main function to run the <myTool> tool.

Attributes Documentation

DEFAULT_KEYS = ['execution', 'project', 'description']

config.json default keys

PYTHON_SCRIPT_PATH = '/example/hello.py'

<myApplication>

Methods Documentation

__init__(configuration=None)

Init function.

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)

The main function to run the <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

toolExecution(input_files)

The main function to run the <myTool> tool.

Parameters

input_files (dict) – Dictionary of input files locations.