DeltaTwin® run module uses models stored into DeltaTwin® component repository. The objective of this service is to allow edition and run of the models stored into the DeltaTwin® component. The run can be done remotely and locally when possible. Run results shall be stored into the artifact folder of the DeltaTwin® drive environment.
deltatwin run start
Start the DeltaTwin component execution with the expected inputs. TWIN_NAME : Name of the DeltaTwin component [MANDATORY]
deltatwin run start [OPTIONS] TWIN_NAME
Options
- -c, --conf <conf>
Path to the conf file
- -I, --input-file <input_file>
Inputs of run in json format, example: /mypath/inputs.json the json is defined like [{“name”: “angle”, “value”: “45”},{“name”: “image”, “value”: “http/myimg/$value”}]
- -f, --format-output <format_output>
format of the output json/text default is text
- -i, --input_run <input_run>
Define each input of a run, example: bandName B1
- -h, --help
Show this message and exit.
Arguments
- TWIN_NAME
Required argument
deltatwin run start <DELTATWIN_NAME> -i image "http://img/\\$value" -i angle 45
deltatwin run start_local
Launch DeltaTwin run locally
deltatwin run start_local [OPTIONS]
Options
- -c, --conf <conf>
Path to the conf file
- -I, --input-file <input_file>
Inputs of run in json format, example: /mypath/inputs.json the json is defined like [{“name”: “angle”, “value”: “45”},{“name”: “image”, “value”: “http/myimg/$value”}]
- --deltatwin-dir <deltatwin_dir>
Directory of deltatwin to run (default: current working directory)
- --debug
If enabled keep Docker containers, instead of deleting them
deltatwin run start_local <DELTATWIN_NAME> -i image "http://img/\\$value" -i angle 45
deltatwin run list
List DeltaTwin component run history. TWIN_NAME : Name of the DeltaTwin component [MANDATORY]
deltatwin run list [OPTIONS] TWIN_NAME
Options
- -c, --conf <conf>
Path to the conf file
- -f, --format-output <format_output>
Format of the output (json/text). Default is text
- -l, --limit <limit>
Maximal number of run entries to return default : 15
- -o, --offset <offset>
Number of runs entries to “skip” default 0 (no offset)
- -s, --status <status>
Filter runs by a status: “CREATED”, “RUNNING”, “SUCCEEDED”, “ERROR”
- -h, --help
Show this message and exit.
Arguments
- TWIN_NAME
Required argument
deltatwin run list <DELTATWIN_NAME>
deltatwin run get
Get a run of a DeltaTwin component.
RUN_ID: the id of the run to retrieve [MANDATORY]
Example:
deltatwin run get 5e8f6a4f-3a83-4f41-ae28-99ce831a9861
deltatwin run get 5e8f6a4f-3a83-4f41-ae28-99ce831a9861 –output-name out –download
deltatwin run get [OPTIONS] RUN_ID
Options
- -h, --help
Show this message and exit.
- -c, --conf <conf>
Path to the conf file
- -f, --format-output <format_output>
Format of the output (json/text). Default is text
- -o, --output-name <output_name>
Name of the output
- -F, --file <file>
Path of the file to save output. By default it is the basename of output in current directory
- -d, --download
Arguments
- RUN_ID
Required argument
deltatwin run get <RUN_ID>
deltatwin run delete
Delete a run of a DeltaTwin.
RUN_ID: the id of the run to retrieve
Example:
deltatwin run delete 5e8f6a4f-3a83-4f41-ae28-99ce831a9861
deltatwin run delete [OPTIONS] RUN_ID
Options
- -c, --conf <conf>
Path to the conf file
- -h, --help
Show this message and exit.
Arguments
- RUN_ID
Required argument
deltatwin run delete <RUN_ID>