DeltaTwin Documentation

Manifest Description

The complete description of the fields of the manifest is available below.

Manifest

Key	Type	Required	Description
name	string	✓	DeltaTwin® component identifier
description	string	✓	DeltaTwin® component description
short_description	string	✓	DeltaTwin® component short description
license	License	✓	DeltaTwin® component license
owner	string	✓	DeltaTwin® component owner
inputs	`Record<name, InputParam>`	–	Input parameters must be provided at each run
outputs	`Record<name, OutputParam>`	–	Output parameters generated at each run
resources	`Record<name, Resource>`	–	Constant and data which not change between runs
models	`Record<name, Model>`	–	Processes definition section
dependencies	`Record<name, Dependency>`	–	Section to define dependencies to other DeltaTwin® components

Licence

Key	Type	Required	Description
name	string	✓	License name
url	string	✓	License URL
copyrights	`array<Copyright>`	✓	License copyrights

Copyright

Key	Type	Required	Description
years	`array<number>`	✓	Copyright application years
company	string	✓	Company applying the copyright

Parameter

Key	Type	Required	Description
name	string	✓	Parameter name
description	string	–	Parameter description

InputParameter

Inherits from Parameter

Key	Type	Required	Description
value	string	–	Allowing to define a default value

Resource

Inherits from Parameter

Key	Type	Required	Description
value	string	✓	Allowing to define a default value

OutputParameter

Inherits from Parameter

InputModelParameter

Inherits from InputParameter

Key	Type	Required	Description
prefix	string	–	Pattern to retrieve generated data during process execution

OutputModelParameter

Inherits from OutputParameter

Key	Type	Required	Description
glob	string	–	Pattern to retrieve generated data during process execution

Model

Key	Type	Required	Description
name	string	✓	Process name
type	string	✓	Process type (currently only `python` is supported)
path	string	✓	Relative path to the process directory
parameters	string	✓	Pattern to retrieve generated data during process execution
inputs	`Record<string, InputModelParameter>`	✓	Process inputs definition
outputs	`Record<string, OutputModelParameter>`	✓	Pattern to retrieve generated data during process execution

ModelParameters

Key	Type	Required	Description
aptRequirements	`array<SoftwareRequirement>`	–	Libraries, packages and software need to perform the process
hardwareRequirements	HardwareRequirements	–	Hardware requirement need to execute the process
environment	`object<string, string>`	–	Defines environment variables to inject to the process
command	string	✓	Command to perform the process

HardwareRequirements

Please see Kubernetes documentation for more details

Key	Type	Required	Description
cpu	string	–	Define CPU usage (default: 500m)
ram	string	–	Define memory usage (default: 2Gi)

Command

Model inputs can be injected in the command using the pattern $(parameter)


{
    "parameters": {
        "command": "python script.py $(uppercase) $(message)"
    },
    "inputs": {
        "uppercase": {
            "type": "boolean",
            "prefix": "--my-flag"
        },
        "message": {
            "type": "string",
            "prefix": "--message"
        }
    }
}

Parameter injection works those following rules:

string: add prefix and the string to the command line
integer / number: add prefix and decimal representation to the command line
boolean: if true, add prefix; if false, add nothing
Data: add prefix and the value of Data.path
null: add nothing

SoftwareRequirement

Key	Type	Required	Description
name	string	✓	Software/Package name
version	string	✓	Software/Package version

PythonModelParameters

Key	Type	Required	Description
pythonVersion	string	✓	Python version
pipRequirements	`array<SoftwareRequirement>`	–	Python package to install from Pypi

Dependency

Key	Type	Required	Description
name	string	✓	Dependence identifier
id	string	✓	Deltatwin® component identifier
version	string	✓	Deltatwin® component version