kiara_model_types

instance.module_config

type_name	instance.module_config	The registered name for this item type.
documentation	description Base class that describes the configuration a [``KiaraModule``][kiara.module.KiaraModule] class accepts. Short description of the item. doc This is stored in the ``_config_cls`` class attribute in each ``KiaraModule`` class. There are two config options every ``KiaraModule`` supports: - ``constants``, and - ``defaults`` Constants are pre-set inputs, and users can't change them and an error is thrown if they try. Defaults are default values that override the schema defaults, and those can be overwritten by users. If both a constant and a default value is set for an input field, an error is thrown. Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name KiaraModuleConfig The name of the Python class. python_module_name kiara.models.module The name of the Python module this class lives in. full_name kiara.models.module.KiaraModuleConfig The full class namespace.	The python class that implements this module type.
metadata_schema	title KiaraModuleConfig description Base class that describes the configuration a [``KiaraModule``][kiara.module.KiaraModule] class accepts. This is stored in the ``_config_cls`` class attribute in each ``KiaraModule`` class. There are two config options every ``KiaraModule`` supports: - ``constants``, and - ``defaults`` Constants are pre-set inputs, and users can't change them and an error is thrown if they try. Defaults are default values that override the schema defaults, and those can be overwritten by users. If both a constant and a default value is set for an input field, an error is thrown. type object properties constants title Constants description Value constants for this module. type object defaults title Defaults description Value defaults for this module. type object additionalProperties False	The (json) schema for this model data.

instance.module_config.pipeline

type_name	instance.module_config.pipeline	The registered name for this item type.
documentation	description A class to hold the configuration for a [PipelineModule][kiara.pipeline.module.PipelineModule]. Short description of the item. doc If you want to control the pipeline input and output names, you need to have to provide a map that uses the autogenerated field name ([step_id]__[alias] -- 2 underscores!!) as key, and the desired field name as value. The reason that schema for the autogenerated field names exist is that it's hard to ensure the uniqueness of each field; some steps can have the same input field names, but will need different input values. In some cases, some inputs of different steps need the same input. Those sorts of things. So, to make sure that we always use the right values, I chose to implement a conservative default approach, accepting that in some cases the user will be prompted for duplicate inputs for the same value. To remedy that, the pipeline creator has the option to manually specify a mapping to rename some or all of the input/output fields. Further, because in a lot of cases there won't be any overlapping fields, the creator can specify ``auto``, in which case *Kiara* will automatically create a mapping that tries to map autogenerated field names to the shortest possible names for each case. Examples: -------- Configuration for a pipeline module that functions as a ``nand`` logic gate (in Python): ``` python and_step = PipelineStepConfig(module_type="and", step_id="and") not_step = PipelineStepConfig(module_type="not", step_id="not", input_links={"a": ["and.y"]} nand_p_conf = PipelineConfig(doc="Returns 'False' if both inputs are 'True'.", steps=[and_step, not_step], input_aliases={ "and.a": "a", "and.b": "b" }, output_aliases={ "not.y": "y" }} ``` Or, the same thing in json: ``` json { "module_type_name": "nand", "doc": "Returns 'False' if both inputs are 'True'.", "steps": [ { "module_type": "and", "step_id": "and" }, { "module_type": "not", "step_id": "not", "input_links": { "a": "and.y" } } ], "input_aliases": { "and.a": "a", "and.b": "b" }, "output_aliases": { "not.y": "y" } } ``` Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name PipelineConfig The name of the Python class. python_module_name kiara.models.module.pipeline The name of the Python module this class lives in. full_name kiara.models.module.pipeline.PipelineConfig The full class namespace.	The python class that implements this module type.
metadata_schema	title PipelineConfig description A class to hold the configuration for a [PipelineModule][kiara.pipeline.module.PipelineModule]. If you want to control the pipeline input and output names, you need to have to provide a map that uses the autogenerated field name ([step_id]__[alias] -- 2 underscores!!) as key, and the desired field name as value. The reason that schema for the autogenerated field names exist is that it's hard to ensure the uniqueness of each field; some steps can have the same input field names, but will need different input values. In some cases, some inputs of different steps need the same input. Those sorts of things. So, to make sure that we always use the right values, I chose to implement a conservative default approach, accepting that in some cases the user will be prompted for duplicate inputs for the same value. To remedy that, the pipeline creator has the option to manually specify a mapping to rename some or all of the input/output fields. Further, because in a lot of cases there won't be any overlapping fields, the creator can specify ``auto``, in which case *Kiara* will automatically create a mapping that tries to map autogenerated field names to the shortest possible names for each case. Examples: -------- Configuration for a pipeline module that functions as a ``nand`` logic gate (in Python): ``` python and_step = PipelineStepConfig(module_type="and", step_id="and") not_step = PipelineStepConfig(module_type="not", step_id="not", input_links={"a": ["and.y"]} nand_p_conf = PipelineConfig(doc="Returns 'False' if both inputs are 'True'.", steps=[and_step, not_step], input_aliases={ "and.a": "a", "and.b": "b" }, output_aliases={ "not.y": "y" }} ``` Or, the same thing in json: ``` json { "module_type_name": "nand", "doc": "Returns 'False' if both inputs are 'True'.", "steps": [ { "module_type": "and", "step_id": "and" }, { "module_type": "not", "step_id": "not", "input_links": { "a": "and.y" } } ], "input_aliases": { "and.a": "a", "and.b": "b" }, "output_aliases": { "not.y": "y" } } ``` type object properties constants title Constants description Value constants for this module. type object defaults title Defaults description Value defaults for this module. type object pipeline_name title Pipeline Name description The name of this pipeline. type string steps title Steps description A list of steps/modules of this pipeline, and their connections. type array items $ref #/definitions/PipelineStep input_aliases title Input Aliases description A map of input aliases, with the location of the input (in the format '[step_id].[input_field]') as key, and the pipeline input field name as value. type object additionalProperties type string output_aliases title Output Aliases description A map of output aliases, with the location of the output (in the format '[step_id].[output_field]') as key, and the pipeline output field name as value. type object additionalProperties type string doc title Doc description Documentation about what the pipeline does. default -- n/a -- allOf $ref #/definitions/DocumentationMetadataModel context title Context description Metadata for this workflow. type object required pipeline_name steps input_aliases output_aliases definitions Manifest title Manifest description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean required module_type additionalProperties False StepValueAddress title StepValueAddress description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. type object properties step_id title Step Id description The id of a step within a pipeline. type string value_name title Value Name description The name of the value (output name or pipeline input name). type string sub_value title Sub Value description A reference to a subitem of a value (e.g. column, list item) type object required step_id value_name additionalProperties False DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False KiaraModuleInstance title KiaraModuleInstance description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string module_config title Module Config description The module config. type object inputs_schema title Inputs Schema description The schema for the module input(s). type object additionalProperties $ref #/definitions/ValueSchema outputs_schema title Outputs Schema description The schema for the module output(s). type object additionalProperties $ref #/definitions/ValueSchema required python_class_name python_module_name full_name module_config inputs_schema outputs_schema additionalProperties False PipelineStep title PipelineStep description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The module config. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean step_id title Step Id description Locally unique id (within a pipeline) of this step. type string manifest_src title Manifest Src description The original manfifest provided by the user. allOf $ref #/definitions/Manifest input_links title Input Links description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. type object additionalProperties type array items $ref #/definitions/StepValueAddress module_details title Module Details description The class of the underlying module. allOf $ref #/definitions/KiaraModuleInstance doc title Doc description A description what this step does. allOf $ref #/definitions/DocumentationMetadataModel required module_type step_id manifest_src module_details doc additionalProperties False	The (json) schema for this model data.

instance.manifest

type_name	instance.manifest	The registered name for this item type.
documentation	description A class to hold the type and configuration for a module instance. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name Manifest The name of the Python class. python_module_name kiara.models.module.manifest The name of the Python module this class lives in. full_name kiara.models.module.manifest.Manifest The full class namespace.	The python class that implements this module type.
metadata_schema	title Manifest description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean required module_type additionalProperties False	The (json) schema for this model data.

instance.manifest_with_inputs

type_name	instance.manifest_with_inputs	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name InputsManifest The name of the Python class. python_module_name kiara.models.module.manifest The name of the Python module this class lives in. full_name kiara.models.module.manifest.InputsManifest The full class namespace.	The python class that implements this module type.
metadata_schema	title InputsManifest description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean inputs title Inputs description A map of all the input fields and value references. type object additionalProperties type string format uuid required module_type inputs additionalProperties False	The (json) schema for this model data.

instance.job_config

type_name	instance.job_config	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name JobConfig The name of the Python class. python_module_name kiara.models.module.jobs The name of the Python module this class lives in. full_name kiara.models.module.jobs.JobConfig The full class namespace.	The python class that implements this module type.
metadata_schema	title JobConfig description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean inputs title Inputs description A map of all the input fields and value references. type object additionalProperties type string format uuid required module_type inputs additionalProperties False	The (json) schema for this model data.

instance.job_record

type_name	instance.job_record	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name JobRecord The name of the Python class. python_module_name kiara.models.module.jobs The name of the Python module this class lives in. full_name kiara.models.module.jobs.JobRecord The full class namespace.	The python class that implements this module type.
metadata_schema	title JobRecord description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean inputs title Inputs description A map of all the input fields and value references. type object additionalProperties type string format uuid job_id title Job Id description The globally unique id for this job. type string format uuid environment_hashes title Environment Hashes description Hashes for the environments this value was created in. type object additionalProperties type object additionalProperties type string enviroments title Enviroments description Information about the environments this value was created in. type object additionalProperties type object inputs_data_hash title Inputs Data Hash description A map of the hashes of this jobs inputs. type string outputs title Outputs description References to the job outputs. type object additionalProperties type string format uuid runtime_details title Runtime Details description Runtime details for the job. allOf $ref #/definitions/JobRuntimeDetails job_metadata title Job Metadata description Optional metadata for this job. type object required module_type inputs job_id environment_hashes outputs additionalProperties False definitions LogMessage title LogMessage type object properties timestamp title Timestamp description The time the message was logged. type string format date-time log_level title Log Level description The log level. type integer msg title Msg description The log message type string required log_level msg JobLog title JobLog type object properties log title Log description The logs for this job. type array items $ref #/definitions/LogMessage percent_finished title Percent Finished description Describes how much of the job is finished. A negative number means the module does not support progress tracking. default -1 type integer JobRuntimeDetails title JobRuntimeDetails type object properties job_log title Job Log description The lob jog. allOf $ref #/definitions/JobLog submitted title Submitted description When the job was submitted. type string format date-time started title Started description When the job was started. type string format date-time finished title Finished description When the job was finished. type string format date-time runtime title Runtime description The duration of the job. type number required job_log submitted started finished runtime	The (json) schema for this model data.

instance.value_pedigree

type_name	instance.value_pedigree	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ValuePedigree The name of the Python class. python_module_name kiara.models.values.value The name of the Python module this class lives in. full_name kiara.models.values.value.ValuePedigree The full class namespace.	The python class that implements this module type.
metadata_schema	title ValuePedigree description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean inputs title Inputs description A map of all the input fields and value references. type object additionalProperties type string format uuid kiara_id title Kiara Id description The id of the kiara context a value was created in. type string format uuid environments title Environments description References to the runtime environment details a value was created in. type object additionalProperties type string required module_type inputs kiara_id environments additionalProperties False	The (json) schema for this model data.

instance.pipeline_step

type_name	instance.pipeline_step	The registered name for this item type.
documentation	description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name PipelineStep The name of the Python class. python_module_name kiara.models.module.pipeline The name of the Python module this class lives in. full_name kiara.models.module.pipeline.PipelineStep The full class namespace.	The python class that implements this module type.
metadata_schema	title PipelineStep description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The module config. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean step_id title Step Id description Locally unique id (within a pipeline) of this step. type string manifest_src title Manifest Src description The original manfifest provided by the user. allOf $ref #/definitions/Manifest input_links title Input Links description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. type object additionalProperties type array items $ref #/definitions/StepValueAddress module_details title Module Details description The class of the underlying module. allOf $ref #/definitions/KiaraModuleInstance doc title Doc description A description what this step does. allOf $ref #/definitions/DocumentationMetadataModel required module_type step_id manifest_src module_details doc additionalProperties False definitions Manifest title Manifest description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean required module_type additionalProperties False StepValueAddress title StepValueAddress description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. type object properties step_id title Step Id description The id of a step within a pipeline. type string value_name title Value Name description The name of the value (output name or pipeline input name). type string sub_value title Sub Value description A reference to a subitem of a value (e.g. column, list item) type object required step_id value_name additionalProperties False DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False KiaraModuleInstance title KiaraModuleInstance description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string module_config title Module Config description The module config. type object inputs_schema title Inputs Schema description The schema for the module input(s). type object additionalProperties $ref #/definitions/ValueSchema outputs_schema title Outputs Schema description The schema for the module output(s). type object additionalProperties $ref #/definitions/ValueSchema required python_class_name python_module_name full_name module_config inputs_schema outputs_schema additionalProperties False	The (json) schema for this model data.

instance.operation

type_name	instance.operation	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name Operation The name of the Python class. python_module_name kiara.models.module.operation The name of the Python module this class lives in. full_name kiara.models.module.operation.Operation The full class namespace.	The python class that implements this module type.
metadata_schema	title Operation description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean operation_id title Operation Id description The (unique) id of this operation. type string operation_details title Operation Details description The operation specific details of this operation. allOf $ref #/definitions/OperationDetails doc title Doc description Documentation for this operation. allOf $ref #/definitions/DocumentationMetadataModel module_details title Module Details description The class of the underlying module. allOf $ref #/definitions/KiaraModuleInstance metadata title Metadata description Additional metadata for this operation. type object required module_type operation_id operation_details doc module_details additionalProperties False definitions OperationDetails title OperationDetails description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties operation_id title Operation Id description The id of the operation. type string is_internal_operation title Is Internal Operation description Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). default False type boolean required operation_id additionalProperties False DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False KiaraModuleInstance title KiaraModuleInstance description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string module_config title Module Config description The module config. type object inputs_schema title Inputs Schema description The schema for the module input(s). type object additionalProperties $ref #/definitions/ValueSchema outputs_schema title Outputs Schema description The schema for the module output(s). type object additionalProperties $ref #/definitions/ValueSchema required python_class_name python_module_name full_name module_config inputs_schema outputs_schema additionalProperties False	The (json) schema for this model data.

instance.destiny

type_name	instance.destiny	The registered name for this item type.
documentation	description A destiny is basically a link to a potential future transformation result involving one or several values as input. Short description of the item. doc It is immutable, once executed, each of the input values can only have one destiny with a specific alias. This is similar to what is usually called a 'future' in programming languages, but more deterministic, sorta. Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name Destiny The name of the Python class. python_module_name kiara.models.module.destiny The name of the Python module this class lives in. full_name kiara.models.module.destiny.Destiny The full class namespace.	The python class that implements this module type.
metadata_schema	title Destiny description A destiny is basically a link to a potential future transformation result involving one or several values as input. It is immutable, once executed, each of the input values can only have one destiny with a specific alias. This is similar to what is usually called a 'future' in programming languages, but more deterministic, sorta. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean destiny_id title Destiny Id description The id of this destiny. type string format uuid destiny_alias title Destiny Alias description The path to (the) destiny. type string module_details title Module Details description The class of the underlying module. allOf $ref #/definitions/KiaraModuleInstance fixed_inputs title Fixed Inputs description Inputs that are known in advance. type object additionalProperties type string format uuid inputs_schema title Inputs Schema description The schemas of all deferred input fields. type object additionalProperties $ref #/definitions/ValueSchema deferred_inputs title Deferred Inputs description Potentially required external inputs that are needed for this destiny to materialize. type object additionalProperties type string format uuid result_field_name title Result Field Name description The name of the result field. type string result_schema title Result Schema description The value schema of the result. allOf $ref #/definitions/ValueSchema result_value_id title Result Value Id description The value id of the result. type string format uuid required module_type destiny_id destiny_alias module_details fixed_inputs inputs_schema deferred_inputs result_field_name result_schema additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False KiaraModuleInstance title KiaraModuleInstance description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string module_config title Module Config description The module config. type object inputs_schema title Inputs Schema description The schema for the module input(s). type object additionalProperties $ref #/definitions/ValueSchema outputs_schema title Outputs Schema description The schema for the module output(s). type object additionalProperties $ref #/definitions/ValueSchema required python_class_name python_module_name full_name module_config inputs_schema outputs_schema additionalProperties False	The (json) schema for this model data.

metadata.authors

type_name	metadata.authors	The registered name for this item type.
documentation	description Information about all authors of a resource. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name AuthorsMetadataModel The name of the Python class. python_module_name kiara.models.documentation The name of the Python module this class lives in. full_name kiara.models.documentation.AuthorsMetadataModel The full class namespace.	The python class that implements this module type.
metadata_schema	title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel definitions AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name	The (json) schema for this model data.

metadata.context

type_name	metadata.context	The registered name for this item type.
documentation	description Information about the context of a resource. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ContextMetadataModel The name of the Python class. python_module_name kiara.models.documentation The name of the Python module this class lives in. full_name kiara.models.documentation.ContextMetadataModel The full class namespace.	The python class that implements this module type.
metadata_schema	title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string definitions LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url	The (json) schema for this model data.

metadata.documentation

type_name	metadata.documentation	The registered name for this item type.
documentation	description Documentation about a resource. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name DocumentationMetadataModel The name of the Python class. python_module_name kiara.models.documentation The name of the Python module this class lives in. full_name kiara.models.documentation.DocumentationMetadataModel The full class namespace.	The python class that implements this module type.
metadata_schema	title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False	The (json) schema for this model data.

instance.value_schema

type_name	instance.value_schema	The registered name for this item type.
documentation	description The schema of a value. Short description of the item. doc The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ValueSchema The name of the Python class. python_module_name kiara.models.values.value_schema The name of the Python module this class lives in. full_name kiara.models.values.value_schema.ValueSchema The full class namespace.	The python class that implements this module type.
metadata_schema	title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False	The (json) schema for this model data.

instance.execution_context

type_name	instance.execution_context	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ExecutionContext The name of the Python class. python_module_name kiara.models.module.jobs The name of the Python module this class lives in. full_name kiara.models.module.jobs.ExecutionContext The full class namespace.	The python class that implements this module type.
metadata_schema	title ExecutionContext description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties working_dir title Working Dir description The path of the working directory. type string pipeline_dir title Pipeline Dir description The path of the pipeline file that is being executed (if applicable). type string additionalProperties False	The (json) schema for this model data.

instance.active_job

type_name	instance.active_job	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ActiveJob The name of the Python class. python_module_name kiara.models.module.jobs The name of the Python module this class lives in. full_name kiara.models.module.jobs.ActiveJob The full class namespace.	The python class that implements this module type.
metadata_schema	title ActiveJob description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties job_id title Job Id description The job id. type string format uuid job_config title Job Config description The job details. allOf $ref #/definitions/JobConfig status description The current status of the job. default __job_created__ allOf $ref #/definitions/JobStatus job_log title Job Log description The lob jog. allOf $ref #/definitions/JobLog submitted title Submitted description When the job was submitted. type string format date-time started title Started description When the job was started. type string format date-time finished title Finished description When the job was finished. type string format date-time results title Results description The result(s). type object additionalProperties type string format uuid error title Error description Potential error message. type string required job_id job_config job_log additionalProperties False definitions JobConfig title JobConfig description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean inputs title Inputs description A map of all the input fields and value references. type object additionalProperties type string format uuid required module_type inputs additionalProperties False JobStatus title JobStatus description An enumeration. enum __job_created__ __job_started__ __job_success__ __job_failed__ LogMessage title LogMessage type object properties timestamp title Timestamp description The time the message was logged. type string format date-time log_level title Log Level description The log level. type integer msg title Msg description The log message type string required log_level msg JobLog title JobLog type object properties log title Log description The logs for this job. type array items $ref #/definitions/LogMessage percent_finished title Percent Finished description Describes how much of the job is finished. A negative number means the module does not support progress tracking. default -1 type integer	The (json) schema for this model data.

instance.wrapped_python_class

type_name	instance.wrapped_python_class	The registered name for this item type.
documentation	description Python class and module information. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name PythonClass The name of the Python class. python_module_name kiara.models.python_class The name of the Python module this class lives in. full_name kiara.models.python_class.PythonClass The full class namespace.	The python class that implements this module type.
metadata_schema	title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False	The (json) schema for this model data.

metadata.kiara_module_class

type_name	metadata.kiara_module_class	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name KiaraModuleInstance The name of the Python class. python_module_name kiara.models.python_class The name of the Python module this class lives in. full_name kiara.models.python_class.KiaraModuleInstance The full class namespace.	The python class that implements this module type.
metadata_schema	title KiaraModuleInstance description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string module_config title Module Config description The module config. type object inputs_schema title Inputs Schema description The schema for the module input(s). type object additionalProperties $ref #/definitions/ValueSchema outputs_schema title Outputs Schema description The schema for the module output(s). type object additionalProperties $ref #/definitions/ValueSchema required python_class_name python_module_name full_name module_config inputs_schema outputs_schema additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False	The (json) schema for this model data.

metadata.serialized_data

type_name	metadata.serialized_data	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name SerializationMetadata The name of the Python class. python_module_name kiara.models.values.value The name of the Python module this class lives in. full_name kiara.models.values.value.SerializationMetadata The full class namespace.	The python class that implements this module type.
metadata_schema	title SerializationMetadata description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties environment title Environment description Hash(es) for the environments the value was created/serialized. type object additionalProperties type integer deserialize title Deserialize description Suggested manifest configs to use to de-serialize the data. type object additionalProperties $ref #/definitions/Manifest additionalProperties False definitions Manifest title Manifest description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean required module_type additionalProperties False	The (json) schema for this model data.

instance.serialization_result

type_name	instance.serialization_result	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name SerializationResult The name of the Python class. python_module_name kiara.models.values.value The name of the Python module this class lives in. full_name kiara.models.values.value.SerializationResult The full class namespace.	The python class that implements this module type.
metadata_schema	title SerializationResult description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties data_type title Data Type description The name of the data type for this serialized value. type string data_type_config title Data Type Config description The (optional) config for the data type for this serialized value. type object serialization_profile title Serialization Profile description An identifying name for the serialization method used. type string metadata title Metadata description Optional metadata describing aspects of the serialization used. allOf $ref #/definitions/SerializationMetadata hash_codec title Hash Codec description The codec used to hash the value. default sha2-256 type string data title Data description One or several byte arrays representing the serialized state of the value. type object additionalProperties anyOf $ref #/definitions/SerializedBytes $ref #/definitions/SerializedListOfBytes $ref #/definitions/SerializedFile $ref #/definitions/SerializedFiles $ref #/definitions/SerializedInlineJson required data_type serialization_profile data additionalProperties False definitions Manifest title Manifest description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean required module_type additionalProperties False SerializationMetadata title SerializationMetadata description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties environment title Environment description Hash(es) for the environments the value was created/serialized. type object additionalProperties type integer deserialize title Deserialize description Suggested manifest configs to use to de-serialize the data. type object additionalProperties $ref #/definitions/Manifest additionalProperties False SerializedBytes title SerializedBytes type object properties codec title Codec description The codec used to encode the chunks in this model. Using the [multicodecs](https://github.com/multiformats/multicodec) codec table. type string type title Type default chunk enum chunk type string chunk title Chunk description A byte-array type string format binary required codec chunk additionalProperties False SerializedListOfBytes title SerializedListOfBytes type object properties codec title Codec description The codec used to encode the chunks in this model. Using the [multicodecs](https://github.com/multiformats/multicodec) codec table. type string type title Type default chunks enum chunks type string chunks title Chunks description A list of byte arrays. type array items type string format binary required codec chunks additionalProperties False SerializedFile title SerializedFile type object properties codec title Codec description The codec used to encode the chunks in this model. Using the [multicodecs](https://github.com/multiformats/multicodec) codec table. type string type title Type default file enum file type string file title File description A path to a file containing the serialized data. type string required codec file additionalProperties False SerializedFiles title SerializedFiles type object properties codec title Codec description The codec used to encode the chunks in this model. Using the [multicodecs](https://github.com/multiformats/multicodec) codec table. type string type title Type default files enum files type string files title Files description A list of strings, pointing to files containing parts of the serialized data. type array items type string required codec files additionalProperties False SerializedInlineJson title SerializedInlineJson type object properties codec title Codec description The codec used to encode the chunks in this model. Using the [multicodecs](https://github.com/multiformats/multicodec) codec table. type string type title Type default inline-json enum inline-json type string inline_data title Inline Data description Data that will not be stored externally, but inline in the containing model. This should only contain data types that can be serialized reliably using json (scalars, etc.). required codec additionalProperties False	The (json) schema for this model data.

instance.persisted_data

type_name	instance.persisted_data	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name PersistedData The name of the Python class. python_module_name kiara.models.values.value The name of the Python module this class lives in. full_name kiara.models.values.value.PersistedData The full class namespace.	The python class that implements this module type.
metadata_schema	title PersistedData description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties data_type title Data Type description The name of the data type for this serialized value. type string data_type_config title Data Type Config description The (optional) config for the data type for this serialized value. type object serialization_profile title Serialization Profile description An identifying name for the serialization method used. type string metadata title Metadata description Optional metadata describing aspects of the serialization used. allOf $ref #/definitions/SerializationMetadata hash_codec title Hash Codec description The codec used to hash the value. default sha2-256 type string archive_id title Archive Id description The id of the store that persisted the data. type string format uuid chunk_id_map title Chunk Id Map description Reference-ids that resolve to the values' serialized chunks. type object additionalProperties $ref #/definitions/SerializedChunkIDs required data_type serialization_profile archive_id chunk_id_map additionalProperties False definitions Manifest title Manifest description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean required module_type additionalProperties False SerializationMetadata title SerializationMetadata description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties environment title Environment description Hash(es) for the environments the value was created/serialized. type object additionalProperties type integer deserialize title Deserialize description Suggested manifest configs to use to de-serialize the data. type object additionalProperties $ref #/definitions/Manifest additionalProperties False SerializedChunkIDs title SerializedChunkIDs type object properties type title Type default chunk-ids enum chunk-ids type string chunk_id_list title Chunk Id List description A list of chunk ids, which will be resolved via the attached data registry. type array items type string archive_id title Archive Id description The preferred data archive to get the chunks from. type string format uuid size title Size description The size of all chunks combined. type integer required chunk_id_list size additionalProperties False	The (json) schema for this model data.

info.data_type_instance

type_name	info.data_type_instance	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name DataTypeInfo The name of the Python class. python_module_name kiara.models.values.value The name of the Python module this class lives in. full_name kiara.models.values.value.DataTypeInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title DataTypeInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties data_type_name title Data Type Name description The registered name of this data type. type string data_type_config title Data Type Config description The (optional) configuration for this data type. type object characteristics title Characteristics description Characteristics of this data type. allOf $ref #/definitions/DataTypeCharacteristics data_type_class title Data Type Class description The python class that is associated with this model. allOf $ref #/definitions/PythonClass required data_type_name characteristics data_type_class additionalProperties False definitions DataTypeCharacteristics title DataTypeCharacteristics type object properties is_scalar title Is Scalar description Whether the data desribed by this data type behaves like a skalar. default False type boolean is_json_serializable title Is Json Serializable description Whether the data can be serialized to json without information loss. default False type boolean PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False	The (json) schema for this model data.

instance.value_details

type_name	instance.value_details	The registered name for this item type.
documentation	description A wrapper class that manages and retieves value data and its details. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ValueDetails The name of the Python class. python_module_name kiara.models.values.value The name of the Python module this class lives in. full_name kiara.models.values.value.ValueDetails The full class namespace.	The python class that implements this module type.
metadata_schema	title ValueDetails description A wrapper class that manages and retieves value data and its details. type object properties value_id title Value Id description The id of the value. type string format uuid kiara_id title Kiara Id description The id of the kiara context this value belongs to. type string format uuid value_schema title Value Schema description The schema that was used for this Value. allOf $ref #/definitions/ValueSchema value_status description The set/unset status of this value. allOf $ref #/definitions/ValueStatus value_size title Value Size description The size of this value, in bytes. type integer value_hash title Value Hash description The hash of this value. type string pedigree title Pedigree description Information about the module and inputs that went into creating this value. allOf $ref #/definitions/ValuePedigree pedigree_output_name title Pedigree Output Name description The output name that produced this value (using the manifest inside the pedigree). type string data_type_info title Data Type Info description Information about the data type this value is made of. allOf $ref #/definitions/DataTypeInfo required value_id kiara_id value_schema value_status value_size value_hash pedigree pedigree_output_name data_type_info additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False ValueStatus title ValueStatus description An enumeration. enum unknown not set none default set ValuePedigree title ValuePedigree description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean inputs title Inputs description A map of all the input fields and value references. type object additionalProperties type string format uuid kiara_id title Kiara Id description The id of the kiara context a value was created in. type string format uuid environments title Environments description References to the runtime environment details a value was created in. type object additionalProperties type string required module_type inputs kiara_id environments additionalProperties False DataTypeCharacteristics title DataTypeCharacteristics type object properties is_scalar title Is Scalar description Whether the data desribed by this data type behaves like a skalar. default False type boolean is_json_serializable title Is Json Serializable description Whether the data can be serialized to json without information loss. default False type boolean PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False DataTypeInfo title DataTypeInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties data_type_name title Data Type Name description The registered name of this data type. type string data_type_config title Data Type Config description The (optional) configuration for this data type. type object characteristics title Characteristics description Characteristics of this data type. allOf $ref #/definitions/DataTypeCharacteristics data_type_class title Data Type Class description The python class that is associated with this model. allOf $ref #/definitions/PythonClass required data_type_name characteristics data_type_class additionalProperties False	The (json) schema for this model data.

instance.value

type_name	instance.value	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name Value The name of the Python class. python_module_name kiara.models.values.value The name of the Python module this class lives in. full_name kiara.models.values.value.Value The full class namespace.	The python class that implements this module type.
metadata_schema	title Value description A wrapper class that manages and retieves value data and its details. type object properties value_id title Value Id description The id of the value. type string format uuid kiara_id title Kiara Id description The id of the kiara context this value belongs to. type string format uuid value_schema title Value Schema description The schema that was used for this Value. allOf $ref #/definitions/ValueSchema value_status description The set/unset status of this value. allOf $ref #/definitions/ValueStatus value_size title Value Size description The size of this value, in bytes. type integer value_hash title Value Hash description The hash of this value. type string pedigree title Pedigree description Information about the module and inputs that went into creating this value. allOf $ref #/definitions/ValuePedigree pedigree_output_name title Pedigree Output Name description The output name that produced this value (using the manifest inside the pedigree). type string data_type_info title Data Type Info description Information about the data type this value is made of. allOf $ref #/definitions/DataTypeInfo environment_hashes title Environment Hashes description Hashes for the environments this value was created in. type object additionalProperties type object additionalProperties type string enviroments title Enviroments description Information about the environments this value was created in. type object additionalProperties type object property_links title Property Links description Links to values that are properties of this value. type object additionalProperties type string format uuid destiny_backlinks title Destiny Backlinks description Backlinks to values that this value acts as destiny/or property for. type object additionalProperties type string required value_id kiara_id value_schema value_status value_size value_hash pedigree pedigree_output_name data_type_info environment_hashes additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False ValueStatus title ValueStatus description An enumeration. enum unknown not set none default set ValuePedigree title ValuePedigree description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean inputs title Inputs description A map of all the input fields and value references. type object additionalProperties type string format uuid kiara_id title Kiara Id description The id of the kiara context a value was created in. type string format uuid environments title Environments description References to the runtime environment details a value was created in. type object additionalProperties type string required module_type inputs kiara_id environments additionalProperties False DataTypeCharacteristics title DataTypeCharacteristics type object properties is_scalar title Is Scalar description Whether the data desribed by this data type behaves like a skalar. default False type boolean is_json_serializable title Is Json Serializable description Whether the data can be serialized to json without information loss. default False type boolean PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False DataTypeInfo title DataTypeInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties data_type_name title Data Type Name description The registered name of this data type. type string data_type_config title Data Type Config description The (optional) configuration for this data type. type object characteristics title Characteristics description Characteristics of this data type. allOf $ref #/definitions/DataTypeCharacteristics data_type_class title Data Type Class description The python class that is associated with this model. allOf $ref #/definitions/PythonClass required data_type_name characteristics data_type_class additionalProperties False	The (json) schema for this model data.

instance.unloadable_data

type_name	instance.unloadable_data	The registered name for this item type.
documentation	description A special 'marker' model, indicating that the data of value can't be loaded. Short description of the item. doc In most cases, the reason this happens is because the current kiara context is missing some value types and/or modules. Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name UnloadableData The name of the Python class. python_module_name kiara.models.values.value The name of the Python module this class lives in. full_name kiara.models.values.value.UnloadableData The full class namespace.	The python class that implements this module type.
metadata_schema	title UnloadableData description A special 'marker' model, indicating that the data of value can't be loaded. In most cases, the reason this happens is because the current kiara context is missing some value types and/or modules. type object properties value title Value description A reference to the value. allOf $ref #/definitions/Value required value additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False ValueStatus title ValueStatus description An enumeration. enum unknown not set none default set ValuePedigree title ValuePedigree description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean inputs title Inputs description A map of all the input fields and value references. type object additionalProperties type string format uuid kiara_id title Kiara Id description The id of the kiara context a value was created in. type string format uuid environments title Environments description References to the runtime environment details a value was created in. type object additionalProperties type string required module_type inputs kiara_id environments additionalProperties False DataTypeCharacteristics title DataTypeCharacteristics type object properties is_scalar title Is Scalar description Whether the data desribed by this data type behaves like a skalar. default False type boolean is_json_serializable title Is Json Serializable description Whether the data can be serialized to json without information loss. default False type boolean PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False DataTypeInfo title DataTypeInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties data_type_name title Data Type Name description The registered name of this data type. type string data_type_config title Data Type Config description The (optional) configuration for this data type. type object characteristics title Characteristics description Characteristics of this data type. allOf $ref #/definitions/DataTypeCharacteristics data_type_class title Data Type Class description The python class that is associated with this model. allOf $ref #/definitions/PythonClass required data_type_name characteristics data_type_class additionalProperties False Value title Value description A wrapper class that manages and retieves value data and its details. type object properties value_id title Value Id description The id of the value. type string format uuid kiara_id title Kiara Id description The id of the kiara context this value belongs to. type string format uuid value_schema title Value Schema description The schema that was used for this Value. allOf $ref #/definitions/ValueSchema value_status description The set/unset status of this value. allOf $ref #/definitions/ValueStatus value_size title Value Size description The size of this value, in bytes. type integer value_hash title Value Hash description The hash of this value. type string pedigree title Pedigree description Information about the module and inputs that went into creating this value. allOf $ref #/definitions/ValuePedigree pedigree_output_name title Pedigree Output Name description The output name that produced this value (using the manifest inside the pedigree). type string data_type_info title Data Type Info description Information about the data type this value is made of. allOf $ref #/definitions/DataTypeInfo environment_hashes title Environment Hashes description Hashes for the environments this value was created in. type object additionalProperties type object additionalProperties type string enviroments title Enviroments description Information about the environments this value was created in. type object additionalProperties type object property_links title Property Links description Links to values that are properties of this value. type object additionalProperties type string format uuid destiny_backlinks title Destiny Backlinks description Backlinks to values that this value acts as destiny/or property for. type object additionalProperties type string required value_id kiara_id value_schema value_status value_size value_hash pedigree pedigree_output_name data_type_info environment_hashes additionalProperties False	The (json) schema for this model data.

instance.value_map.readonly

type_name	instance.value_map.readonly	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ValueMapReadOnly The name of the Python class. python_module_name kiara.models.values.value The name of the Python module this class lives in. full_name kiara.models.values.value.ValueMapReadOnly The full class namespace.	The python class that implements this module type.
metadata_schema	title ValueMapReadOnly description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties values_schema title Values Schema description The schemas for all the values in this set. type object additionalProperties $ref #/definitions/ValueSchema value_items title Value Items description The values contained in this set. type object additionalProperties $ref #/definitions/Value required values_schema value_items additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False ValueStatus title ValueStatus description An enumeration. enum unknown not set none default set ValuePedigree title ValuePedigree description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean inputs title Inputs description A map of all the input fields and value references. type object additionalProperties type string format uuid kiara_id title Kiara Id description The id of the kiara context a value was created in. type string format uuid environments title Environments description References to the runtime environment details a value was created in. type object additionalProperties type string required module_type inputs kiara_id environments additionalProperties False DataTypeCharacteristics title DataTypeCharacteristics type object properties is_scalar title Is Scalar description Whether the data desribed by this data type behaves like a skalar. default False type boolean is_json_serializable title Is Json Serializable description Whether the data can be serialized to json without information loss. default False type boolean PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False DataTypeInfo title DataTypeInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties data_type_name title Data Type Name description The registered name of this data type. type string data_type_config title Data Type Config description The (optional) configuration for this data type. type object characteristics title Characteristics description Characteristics of this data type. allOf $ref #/definitions/DataTypeCharacteristics data_type_class title Data Type Class description The python class that is associated with this model. allOf $ref #/definitions/PythonClass required data_type_name characteristics data_type_class additionalProperties False Value title Value description A wrapper class that manages and retieves value data and its details. type object properties value_id title Value Id description The id of the value. type string format uuid kiara_id title Kiara Id description The id of the kiara context this value belongs to. type string format uuid value_schema title Value Schema description The schema that was used for this Value. allOf $ref #/definitions/ValueSchema value_status description The set/unset status of this value. allOf $ref #/definitions/ValueStatus value_size title Value Size description The size of this value, in bytes. type integer value_hash title Value Hash description The hash of this value. type string pedigree title Pedigree description Information about the module and inputs that went into creating this value. allOf $ref #/definitions/ValuePedigree pedigree_output_name title Pedigree Output Name description The output name that produced this value (using the manifest inside the pedigree). type string data_type_info title Data Type Info description Information about the data type this value is made of. allOf $ref #/definitions/DataTypeInfo environment_hashes title Environment Hashes description Hashes for the environments this value was created in. type object additionalProperties type object additionalProperties type string enviroments title Enviroments description Information about the environments this value was created in. type object additionalProperties type object property_links title Property Links description Links to values that are properties of this value. type object additionalProperties type string format uuid destiny_backlinks title Destiny Backlinks description Backlinks to values that this value acts as destiny/or property for. type object additionalProperties type string required value_id kiara_id value_schema value_status value_size value_hash pedigree pedigree_output_name data_type_info environment_hashes additionalProperties False	The (json) schema for this model data.

instance.value_map.writeable

type_name	instance.value_map.writeable	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ValueMapWritable The name of the Python class. python_module_name kiara.models.values.value The name of the Python module this class lives in. full_name kiara.models.values.value.ValueMapWritable The full class namespace.	The python class that implements this module type.
metadata_schema	title ValueMapWritable description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties values_schema title Values Schema description The schemas for all the values in this set. type object additionalProperties $ref #/definitions/ValueSchema value_items title Value Items description The values contained in this set. type object additionalProperties $ref #/definitions/Value pedigree title Pedigree description The pedigree to add to all of the result values. allOf $ref #/definitions/ValuePedigree unique_value_ids title Unique Value Ids description Whether this value map always creates new value(id)s, even when a dataset with matching hash is found. default True type boolean required values_schema pedigree additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False ValueStatus title ValueStatus description An enumeration. enum unknown not set none default set ValuePedigree title ValuePedigree description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean inputs title Inputs description A map of all the input fields and value references. type object additionalProperties type string format uuid kiara_id title Kiara Id description The id of the kiara context a value was created in. type string format uuid environments title Environments description References to the runtime environment details a value was created in. type object additionalProperties type string required module_type inputs kiara_id environments additionalProperties False DataTypeCharacteristics title DataTypeCharacteristics type object properties is_scalar title Is Scalar description Whether the data desribed by this data type behaves like a skalar. default False type boolean is_json_serializable title Is Json Serializable description Whether the data can be serialized to json without information loss. default False type boolean PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False DataTypeInfo title DataTypeInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties data_type_name title Data Type Name description The registered name of this data type. type string data_type_config title Data Type Config description The (optional) configuration for this data type. type object characteristics title Characteristics description Characteristics of this data type. allOf $ref #/definitions/DataTypeCharacteristics data_type_class title Data Type Class description The python class that is associated with this model. allOf $ref #/definitions/PythonClass required data_type_name characteristics data_type_class additionalProperties False Value title Value description A wrapper class that manages and retieves value data and its details. type object properties value_id title Value Id description The id of the value. type string format uuid kiara_id title Kiara Id description The id of the kiara context this value belongs to. type string format uuid value_schema title Value Schema description The schema that was used for this Value. allOf $ref #/definitions/ValueSchema value_status description The set/unset status of this value. allOf $ref #/definitions/ValueStatus value_size title Value Size description The size of this value, in bytes. type integer value_hash title Value Hash description The hash of this value. type string pedigree title Pedigree description Information about the module and inputs that went into creating this value. allOf $ref #/definitions/ValuePedigree pedigree_output_name title Pedigree Output Name description The output name that produced this value (using the manifest inside the pedigree). type string data_type_info title Data Type Info description Information about the data type this value is made of. allOf $ref #/definitions/DataTypeInfo environment_hashes title Environment Hashes description Hashes for the environments this value was created in. type object additionalProperties type object additionalProperties type string enviroments title Enviroments description Information about the environments this value was created in. type object additionalProperties type object property_links title Property Links description Links to values that are properties of this value. type object additionalProperties type string format uuid destiny_backlinks title Destiny Backlinks description Backlinks to values that this value acts as destiny/or property for. type object additionalProperties type string required value_id kiara_id value_schema value_status value_size value_hash pedigree pedigree_output_name data_type_info environment_hashes additionalProperties False	The (json) schema for this model data.

instance.value_map.aliases

type_name	instance.value_map.aliases	The registered name for this item type.
documentation	description A model class that holds a tree of values and their schemas. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name AliasValueMap The name of the Python class. python_module_name kiara.models.aliases The name of the Python module this class lives in. full_name kiara.models.aliases.AliasValueMap The full class namespace.	The python class that implements this module type.
metadata_schema	$ref #/definitions/AliasValueMap definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False AliasValueMap title AliasValueMap description A model class that holds a tree of values and their schemas. type object properties values_schema title Values Schema description The schemas for all the values in this set. type object additionalProperties $ref #/definitions/ValueSchema alias title Alias description This maps own (full) alias. type string version title Version description The version of this map (in this maps parent). type integer created title Created description The time this map was created. type string format date-time assoc_schema title Assoc Schema description The schema for this maps associated value. allOf $ref #/definitions/ValueSchema assoc_value title Assoc Value description The value that is associated with this map. type string format uuid value_items title Value Items description The values contained in this set. type object additionalProperties type object additionalProperties $ref #/definitions/AliasValueMap required values_schema version additionalProperties False	The (json) schema for this model data.

info.runtime.python

type_name	info.runtime.python	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name PythonRuntimeEnvironment The name of the Python class. python_module_name kiara.models.runtime_environment.python The name of the Python module this class lives in. full_name kiara.models.runtime_environment.python.PythonRuntimeEnvironment The full class namespace.	The python class that implements this module type.
metadata_schema	title PythonRuntimeEnvironment description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties environment_type title Environment Type enum python type string python_version title Python Version description The version of Python. type string packages title Packages description The packages installed in the Python (virtual) environment. type array items $ref #/definitions/PythonPackage required environment_type python_version packages additionalProperties False definitions PythonPackage title PythonPackage type object properties name title Name description The name of the Python package. type string version title Version description The version of the package. type string required name version	The (json) schema for this model data.

info.runtime.kiara_plugins

type_name	info.runtime.kiara_plugins	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name KiaraPluginsRuntimeEnvironment The name of the Python class. python_module_name kiara.models.runtime_environment.python The name of the Python module this class lives in. full_name kiara.models.runtime_environment.python.KiaraPluginsRuntimeEnvironment The full class namespace.	The python class that implements this module type.
metadata_schema	title KiaraPluginsRuntimeEnvironment description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties environment_type title Environment Type enum kiara_plugins type string kiara_plugins title Kiara Plugins description The kiara plugin packages installed in the Python (virtual) environment. type array items $ref #/definitions/PythonPackage required environment_type kiara_plugins additionalProperties False definitions PythonPackage title PythonPackage type object properties name title Name description The name of the Python package. type string version title Version description The version of the package. type string required name version	The (json) schema for this model data.

info.runtime.kiara_types

type_name	info.runtime.kiara_types	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name KiaraTypesRuntimeEnvironment The name of the Python class. python_module_name kiara.models.runtime_environment.kiara The name of the Python module this class lives in. full_name kiara.models.runtime_environment.kiara.KiaraTypesRuntimeEnvironment The full class namespace.	The python class that implements this module type.
metadata_schema	title KiaraTypesRuntimeEnvironment description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties environment_type title Environment Type enum kiara_types type string archive_types title Archive Types description The available implemented store types. allOf $ref #/definitions/ArchiveTypeClassesInfo metadata_types title Metadata Types description The available metadata types. allOf $ref #/definitions/MetadataTypeClassesInfo required environment_type archive_types metadata_types additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False ArchiveTypeInfo title ArchiveTypeInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel python_class title Python Class description The python class that implements this module type. allOf $ref #/definitions/PythonClass is_writable title Is Writable description Whether this archive is writeable. default False type boolean supported_item_types title Supported Item Types description The item types this archive suports. type array items type string required type_name documentation authors context python_class supported_item_types additionalProperties False ArchiveTypeClassesInfo title ArchiveTypeClassesInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties group_title title Group Title description The group alias. type string item_infos title Item Infos description The archive info instances for each type. type object additionalProperties $ref #/definitions/ArchiveTypeInfo type_name title Type Name default archive_type enum archive_type type string required item_infos additionalProperties False MetadataTypeInfo title MetadataTypeInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel python_class title Python Class description The python class that implements this module type. allOf $ref #/definitions/PythonClass metadata_schema title Metadata Schema description The (json) schema for this metadata value. type object required type_name documentation authors context python_class metadata_schema additionalProperties False MetadataTypeClassesInfo title MetadataTypeClassesInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties group_title title Group Title description The group alias. type string item_infos title Item Infos description The value metadata info instances for each type. type object additionalProperties $ref #/definitions/MetadataTypeInfo type_name title Type Name default value_metadata enum value_metadata type string required item_infos additionalProperties False	The (json) schema for this model data.

info.runtime.os

type_name	info.runtime.os	The registered name for this item type.
documentation	description Manages information about the OS this kiara instance is running in. Short description of the item. doc # TODO: details for other OS's (mainly BSDs) Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name OSRuntimeEnvironment The name of the Python class. python_module_name kiara.models.runtime_environment.operating_system The name of the Python module this class lives in. full_name kiara.models.runtime_environment.operating_system.OSRuntimeEnvironment The full class namespace.	The python class that implements this module type.
metadata_schema	title OSRuntimeEnvironment description Manages information about the OS this kiara instance is running in. # TODO: details for other OS's (mainly BSDs) type object properties environment_type title Environment Type enum operating_system type string operation_system title Operation System description The operation system name. type string platform title Platform description The platform name. type string release title Release description The platform release name. type string version title Version description The platform version name. type string machine title Machine description The architecture. type string os_specific title Os Specific description OS specific platform metadata. type object required environment_type operation_system platform release version machine additionalProperties False	The (json) schema for this model data.

instance.operation_details

type_name	instance.operation_details	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name OperationDetails The name of the Python class. python_module_name kiara.models.module.operation The name of the Python module this class lives in. full_name kiara.models.module.operation.OperationDetails The full class namespace.	The python class that implements this module type.
metadata_schema	title OperationDetails description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties operation_id title Operation Id description The id of the operation. type string is_internal_operation title Is Internal Operation description Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). default False type boolean required operation_id additionalProperties False	The (json) schema for this model data.

instance.operation_details.base

type_name	instance.operation_details.base	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name BaseOperationDetails The name of the Python class. python_module_name kiara.models.module.operation The name of the Python module this class lives in. full_name kiara.models.module.operation.BaseOperationDetails The full class namespace.	The python class that implements this module type.
metadata_schema	title BaseOperationDetails description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties operation_id title Operation Id description The id of the operation. type string is_internal_operation title Is Internal Operation description Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). default False type boolean module_inputs_schema title Module Inputs Schema description The input schemas of the module. type object additionalProperties $ref #/definitions/ValueSchema module_outputs_schema title Module Outputs Schema description The output schemas of the module. type object additionalProperties $ref #/definitions/ValueSchema required operation_id module_inputs_schema module_outputs_schema additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False	The (json) schema for this model data.

instance.operation_config.manifest

type_name	instance.operation_config.manifest	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ManifestOperationConfig The name of the Python class. python_module_name kiara.models.module.operation The name of the Python module this class lives in. full_name kiara.models.module.operation.ManifestOperationConfig The full class namespace.	The python class that implements this module type.
metadata_schema	title ManifestOperationConfig description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties doc title Doc description Documentation for this operation. allOf $ref #/definitions/DocumentationMetadataModel module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object required doc module_type additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False	The (json) schema for this model data.

instance.operation_config.pipeline

type_name	instance.operation_config.pipeline	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name PipelineOperationConfig The name of the Python class. python_module_name kiara.models.module.operation The name of the Python module this class lives in. full_name kiara.models.module.operation.PipelineOperationConfig The full class namespace.	The python class that implements this module type.
metadata_schema	title PipelineOperationConfig description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties doc title Doc description Documentation for this operation. allOf $ref #/definitions/DocumentationMetadataModel pipeline_name title Pipeline Name description The pipeline id. type string pipeline_config title Pipeline Config description The pipeline config data. type object module_map title Module Map description A lookup map to resolves operation ids to module names/configs. type object metadata title Metadata description Additional metadata for the pipeline. type object required doc pipeline_name pipeline_config additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False	The (json) schema for this model data.

filter

type_name	filter	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name Filter The name of the Python class. python_module_name kiara.models.module.operation The name of the Python module this class lives in. full_name kiara.models.module.operation.Filter The full class namespace.	The python class that implements this module type.
metadata_schema	title Filter description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties operation title Operation description The underlying operation providing which does the filtering. allOf $ref #/definitions/Operation input_name title Input Name description The input name to use for the dataset to filter. type string output_name title Output Name description The output name to use for the dataset to filter. type string data_type title Data Type description The type of the dataset that gets filtered. type string required operation input_name output_name data_type additionalProperties False definitions OperationDetails title OperationDetails description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties operation_id title Operation Id description The id of the operation. type string is_internal_operation title Is Internal Operation description Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). default False type boolean required operation_id additionalProperties False DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False KiaraModuleInstance title KiaraModuleInstance description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string module_config title Module Config description The module config. type object inputs_schema title Inputs Schema description The schema for the module input(s). type object additionalProperties $ref #/definitions/ValueSchema outputs_schema title Outputs Schema description The schema for the module output(s). type object additionalProperties $ref #/definitions/ValueSchema required python_class_name python_module_name full_name module_config inputs_schema outputs_schema additionalProperties False Operation title Operation description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean operation_id title Operation Id description The (unique) id of this operation. type string operation_details title Operation Details description The operation specific details of this operation. allOf $ref #/definitions/OperationDetails doc title Doc description Documentation for this operation. allOf $ref #/definitions/DocumentationMetadataModel module_details title Module Details description The class of the underlying module. allOf $ref #/definitions/KiaraModuleInstance metadata title Metadata description Additional metadata for this operation. type object required module_type operation_id operation_details doc module_details additionalProperties False	The (json) schema for this model data.

info.pipeline_stage

type_name	info.pipeline_stage	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name PipelineStage The name of the Python class. python_module_name kiara.models.module.pipeline.stages The name of the Python module this class lives in. full_name kiara.models.module.pipeline.stages.PipelineStage The full class namespace.	The python class that implements this module type.
metadata_schema	title PipelineStage description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties stage_index title Stage Index description The index of this stage. type integer steps title Steps description The pipeline steps that are executed in this stage. type array items type string connected_outputs title Connected Outputs description Previous step outputs that are connected to this stage. type array items type string stage_outputs title Stage Outputs description The outputs of this stage. type array items type string pipeline_inputs title Pipeline Inputs description The pipeline inputs required for this stage. type array items type string pipeline_outputs title Pipeline Outputs description The pipeline outputs that are ready once this stage is processed. type array items type string previous_pipeline_inputs title Previous Pipeline Inputs description Pipeline inputs that are already set by this stage. type array items type string previous_pipeline_outputs title Previous Pipeline Outputs description Pipeline outputs that are already computed by this stage. type array items type string required stage_index steps connected_outputs stage_outputs pipeline_inputs pipeline_outputs previous_pipeline_inputs previous_pipeline_outputs additionalProperties False	The (json) schema for this model data.

pipeline_stages

type_name	pipeline_stages	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name PipelineStages The name of the Python class. python_module_name kiara.models.module.pipeline.stages The name of the Python module this class lives in. full_name kiara.models.module.pipeline.stages.PipelineStages The full class namespace.	The python class that implements this module type.
metadata_schema	title PipelineStages description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties stages title Stages description The pipeline stages. type array items $ref #/definitions/PipelineStage required stages additionalProperties False definitions PipelineStage title PipelineStage description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties stage_index title Stage Index description The index of this stage. type integer steps title Steps description The pipeline steps that are executed in this stage. type array items type string connected_outputs title Connected Outputs description Previous step outputs that are connected to this stage. type array items type string stage_outputs title Stage Outputs description The outputs of this stage. type array items type string pipeline_inputs title Pipeline Inputs description The pipeline inputs required for this stage. type array items type string pipeline_outputs title Pipeline Outputs description The pipeline outputs that are ready once this stage is processed. type array items type string previous_pipeline_inputs title Previous Pipeline Inputs description Pipeline inputs that are already set by this stage. type array items type string previous_pipeline_outputs title Previous Pipeline Outputs description Pipeline outputs that are already computed by this stage. type array items type string required stage_index steps connected_outputs stage_outputs pipeline_inputs pipeline_outputs previous_pipeline_inputs previous_pipeline_outputs additionalProperties False	The (json) schema for this model data.

info.pipeline_step

type_name	info.pipeline_step	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name StepInfo The name of the Python class. python_module_name kiara.models.module.pipeline.structure The name of the Python module this class lives in. full_name kiara.models.module.pipeline.structure.StepInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title StepInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties step title Step description The pipeline step object. allOf $ref #/definitions/PipelineStep inputs title Inputs description Reference(s) to the fields that feed this steps inputs. type object additionalProperties $ref #/definitions/StepInputRef outputs title Outputs description Reference(s) to the fields that are fed by this steps outputs. type object additionalProperties $ref #/definitions/StepOutputRef required title Required description Whether this step is always required or whether all his outputs feed into optional input fields. type boolean doc title Doc description The step documentation. allOf $ref #/definitions/DocumentationMetadataModel required step inputs outputs required additionalProperties False definitions Manifest title Manifest description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean required module_type additionalProperties False StepValueAddress title StepValueAddress description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. type object properties step_id title Step Id description The id of a step within a pipeline. type string value_name title Value Name description The name of the value (output name or pipeline input name). type string sub_value title Sub Value description A reference to a subitem of a value (e.g. column, list item) type object required step_id value_name additionalProperties False DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False KiaraModuleInstance title KiaraModuleInstance description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string module_config title Module Config description The module config. type object inputs_schema title Inputs Schema description The schema for the module input(s). type object additionalProperties $ref #/definitions/ValueSchema outputs_schema title Outputs Schema description The schema for the module output(s). type object additionalProperties $ref #/definitions/ValueSchema required python_class_name python_module_name full_name module_config inputs_schema outputs_schema additionalProperties False PipelineStep title PipelineStep description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The module config. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean step_id title Step Id description Locally unique id (within a pipeline) of this step. type string manifest_src title Manifest Src description The original manfifest provided by the user. allOf $ref #/definitions/Manifest input_links title Input Links description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. type object additionalProperties type array items $ref #/definitions/StepValueAddress module_details title Module Details description The class of the underlying module. allOf $ref #/definitions/KiaraModuleInstance doc title Doc description A description what this step does. allOf $ref #/definitions/DocumentationMetadataModel required module_type step_id manifest_src module_details doc additionalProperties False StepInputRef title StepInputRef description An input to a step. This object can either have a 'connected_outputs' set, or a 'connected_pipeline_input', not both. type object properties value_name title Value Name type string value_schema $ref #/definitions/ValueSchema step_id title Step Id description The step id. type string connected_outputs title Connected Outputs description A potential connected list of one or several module outputs. type array items $ref #/definitions/StepValueAddress connected_pipeline_input title Connected Pipeline Input description A potential pipeline input. type string is_constant title Is Constant description Whether this input is a constant and can't be changed by the user. type boolean required value_name value_schema step_id is_constant additionalProperties False StepOutputRef title StepOutputRef description An output to a step. type object properties value_name title Value Name type string value_schema $ref #/definitions/ValueSchema step_id title Step Id description The step id. type string pipeline_output title Pipeline Output description The connected pipeline output. type string connected_inputs title Connected Inputs description The step inputs that are connected to this step output type array items $ref #/definitions/StepValueAddress required value_name value_schema step_id additionalProperties False	The (json) schema for this model data.

instance.pipeline_structure

type_name	instance.pipeline_structure	The registered name for this item type.
documentation	description An object that holds one or several steps, and describes the connections between them. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name PipelineStructure The name of the Python class. python_module_name kiara.models.module.pipeline.structure The name of the Python module this class lives in. full_name kiara.models.module.pipeline.structure.PipelineStructure The full class namespace.	The python class that implements this module type.
metadata_schema	title PipelineStructure description An object that holds one or several steps, and describes the connections between them. type object properties pipeline_config title Pipeline Config description The underlying pipeline config. allOf $ref #/definitions/PipelineConfig steps title Steps description The pipeline steps type array items $ref #/definitions/PipelineStep input_aliases title Input Aliases description The input aliases. type object additionalProperties type string output_aliases title Output Aliases description The output aliases. type object additionalProperties type string required pipeline_config steps input_aliases output_aliases additionalProperties False definitions Manifest title Manifest description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean required module_type additionalProperties False StepValueAddress title StepValueAddress description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. type object properties step_id title Step Id description The id of a step within a pipeline. type string value_name title Value Name description The name of the value (output name or pipeline input name). type string sub_value title Sub Value description A reference to a subitem of a value (e.g. column, list item) type object required step_id value_name additionalProperties False DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False KiaraModuleInstance title KiaraModuleInstance description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string module_config title Module Config description The module config. type object inputs_schema title Inputs Schema description The schema for the module input(s). type object additionalProperties $ref #/definitions/ValueSchema outputs_schema title Outputs Schema description The schema for the module output(s). type object additionalProperties $ref #/definitions/ValueSchema required python_class_name python_module_name full_name module_config inputs_schema outputs_schema additionalProperties False PipelineStep title PipelineStep description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The module config. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean step_id title Step Id description Locally unique id (within a pipeline) of this step. type string manifest_src title Manifest Src description The original manfifest provided by the user. allOf $ref #/definitions/Manifest input_links title Input Links description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. type object additionalProperties type array items $ref #/definitions/StepValueAddress module_details title Module Details description The class of the underlying module. allOf $ref #/definitions/KiaraModuleInstance doc title Doc description A description what this step does. allOf $ref #/definitions/DocumentationMetadataModel required module_type step_id manifest_src module_details doc additionalProperties False PipelineConfig title PipelineConfig description A class to hold the configuration for a [PipelineModule][kiara.pipeline.module.PipelineModule]. If you want to control the pipeline input and output names, you need to have to provide a map that uses the autogenerated field name ([step_id]__[alias] -- 2 underscores!!) as key, and the desired field name as value. The reason that schema for the autogenerated field names exist is that it's hard to ensure the uniqueness of each field; some steps can have the same input field names, but will need different input values. In some cases, some inputs of different steps need the same input. Those sorts of things. So, to make sure that we always use the right values, I chose to implement a conservative default approach, accepting that in some cases the user will be prompted for duplicate inputs for the same value. To remedy that, the pipeline creator has the option to manually specify a mapping to rename some or all of the input/output fields. Further, because in a lot of cases there won't be any overlapping fields, the creator can specify ``auto``, in which case *Kiara* will automatically create a mapping that tries to map autogenerated field names to the shortest possible names for each case. Examples: -------- Configuration for a pipeline module that functions as a ``nand`` logic gate (in Python): ``` python and_step = PipelineStepConfig(module_type="and", step_id="and") not_step = PipelineStepConfig(module_type="not", step_id="not", input_links={"a": ["and.y"]} nand_p_conf = PipelineConfig(doc="Returns 'False' if both inputs are 'True'.", steps=[and_step, not_step], input_aliases={ "and.a": "a", "and.b": "b" }, output_aliases={ "not.y": "y" }} ``` Or, the same thing in json: ``` json { "module_type_name": "nand", "doc": "Returns 'False' if both inputs are 'True'.", "steps": [ { "module_type": "and", "step_id": "and" }, { "module_type": "not", "step_id": "not", "input_links": { "a": "and.y" } } ], "input_aliases": { "and.a": "a", "and.b": "b" }, "output_aliases": { "not.y": "y" } } ``` type object properties constants title Constants description Value constants for this module. type object defaults title Defaults description Value defaults for this module. type object pipeline_name title Pipeline Name description The name of this pipeline. type string steps title Steps description A list of steps/modules of this pipeline, and their connections. type array items $ref #/definitions/PipelineStep input_aliases title Input Aliases description A map of input aliases, with the location of the input (in the format '[step_id].[input_field]') as key, and the pipeline input field name as value. type object additionalProperties type string output_aliases title Output Aliases description A map of output aliases, with the location of the output (in the format '[step_id].[output_field]') as key, and the pipeline output field name as value. type object additionalProperties type string doc title Doc description Documentation about what the pipeline does. default -- n/a -- allOf $ref #/definitions/DocumentationMetadataModel context title Context description Metadata for this workflow. type object required pipeline_name steps input_aliases output_aliases	The (json) schema for this model data.

info.archive_type

type_name	info.archive_type	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ArchiveTypeInfo The name of the Python class. python_module_name kiara.models.archives The name of the Python module this class lives in. full_name kiara.models.archives.ArchiveTypeInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title ArchiveTypeInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel python_class title Python Class description The python class that implements this module type. allOf $ref #/definitions/PythonClass is_writable title Is Writable description Whether this archive is writeable. default False type boolean supported_item_types title Supported Item Types description The item types this archive suports. type array items type string required type_name documentation authors context python_class supported_item_types additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False	The (json) schema for this model data.

info.metadata_type

type_name	info.metadata_type	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name MetadataTypeInfo The name of the Python class. python_module_name kiara.models.values.value_metadata The name of the Python module this class lives in. full_name kiara.models.values.value_metadata.MetadataTypeInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title MetadataTypeInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel python_class title Python Class description The python class that implements this module type. allOf $ref #/definitions/PythonClass metadata_schema title Metadata Schema description The (json) schema for this metadata value. type object required type_name documentation authors context python_class metadata_schema additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False	The (json) schema for this model data.

info.pipeline

type_name	info.pipeline	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name PipelineInfo The name of the Python class. python_module_name kiara.models.module.pipeline.pipeline The name of the Python module this class lives in. full_name kiara.models.module.pipeline.pipeline.PipelineInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title PipelineInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel pipeline_config title Pipeline Config description The configuration of the pipeline. allOf $ref #/definitions/PipelineConfig pipeline_state title Pipeline State description The current input details. allOf $ref #/definitions/PipelineState required type_name documentation authors context pipeline_config pipeline_state additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string Manifest title Manifest description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean required module_type additionalProperties False StepValueAddress title StepValueAddress description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. type object properties step_id title Step Id description The id of a step within a pipeline. type string value_name title Value Name description The name of the value (output name or pipeline input name). type string sub_value title Sub Value description A reference to a subitem of a value (e.g. column, list item) type object required step_id value_name additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False KiaraModuleInstance title KiaraModuleInstance description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string module_config title Module Config description The module config. type object inputs_schema title Inputs Schema description The schema for the module input(s). type object additionalProperties $ref #/definitions/ValueSchema outputs_schema title Outputs Schema description The schema for the module output(s). type object additionalProperties $ref #/definitions/ValueSchema required python_class_name python_module_name full_name module_config inputs_schema outputs_schema additionalProperties False PipelineStep title PipelineStep description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The module config. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean step_id title Step Id description Locally unique id (within a pipeline) of this step. type string manifest_src title Manifest Src description The original manfifest provided by the user. allOf $ref #/definitions/Manifest input_links title Input Links description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. type object additionalProperties type array items $ref #/definitions/StepValueAddress module_details title Module Details description The class of the underlying module. allOf $ref #/definitions/KiaraModuleInstance doc title Doc description A description what this step does. allOf $ref #/definitions/DocumentationMetadataModel required module_type step_id manifest_src module_details doc additionalProperties False PipelineConfig title PipelineConfig description A class to hold the configuration for a [PipelineModule][kiara.pipeline.module.PipelineModule]. If you want to control the pipeline input and output names, you need to have to provide a map that uses the autogenerated field name ([step_id]__[alias] -- 2 underscores!!) as key, and the desired field name as value. The reason that schema for the autogenerated field names exist is that it's hard to ensure the uniqueness of each field; some steps can have the same input field names, but will need different input values. In some cases, some inputs of different steps need the same input. Those sorts of things. So, to make sure that we always use the right values, I chose to implement a conservative default approach, accepting that in some cases the user will be prompted for duplicate inputs for the same value. To remedy that, the pipeline creator has the option to manually specify a mapping to rename some or all of the input/output fields. Further, because in a lot of cases there won't be any overlapping fields, the creator can specify ``auto``, in which case *Kiara* will automatically create a mapping that tries to map autogenerated field names to the shortest possible names for each case. Examples: -------- Configuration for a pipeline module that functions as a ``nand`` logic gate (in Python): ``` python and_step = PipelineStepConfig(module_type="and", step_id="and") not_step = PipelineStepConfig(module_type="not", step_id="not", input_links={"a": ["and.y"]} nand_p_conf = PipelineConfig(doc="Returns 'False' if both inputs are 'True'.", steps=[and_step, not_step], input_aliases={ "and.a": "a", "and.b": "b" }, output_aliases={ "not.y": "y" }} ``` Or, the same thing in json: ``` json { "module_type_name": "nand", "doc": "Returns 'False' if both inputs are 'True'.", "steps": [ { "module_type": "and", "step_id": "and" }, { "module_type": "not", "step_id": "not", "input_links": { "a": "and.y" } } ], "input_aliases": { "and.a": "a", "and.b": "b" }, "output_aliases": { "not.y": "y" } } ``` type object properties constants title Constants description Value constants for this module. type object defaults title Defaults description Value defaults for this module. type object pipeline_name title Pipeline Name description The name of this pipeline. type string steps title Steps description A list of steps/modules of this pipeline, and their connections. type array items $ref #/definitions/PipelineStep input_aliases title Input Aliases description A map of input aliases, with the location of the input (in the format '[step_id].[input_field]') as key, and the pipeline input field name as value. type object additionalProperties type string output_aliases title Output Aliases description A map of output aliases, with the location of the output (in the format '[step_id].[output_field]') as key, and the pipeline output field name as value. type object additionalProperties type string doc title Doc description Documentation about what the pipeline does. default -- n/a -- allOf $ref #/definitions/DocumentationMetadataModel context title Context description Metadata for this workflow. type object required pipeline_name steps input_aliases output_aliases StepStatus title StepStatus description Enum to describe the state of a workflow. enum inputs_invalid inputs_ready results_ready StepDetails title StepDetails type object properties kiara_id title Kiara Id description The id of the kiara context. type string format uuid pipeline_id title Pipeline Id description The id of the pipeline. type string format uuid step title Step description The pipeline step details. allOf $ref #/definitions/PipelineStep step_id title Step Id description The id of the step. type string processing_stage title Processing Stage description The execution stage where this step is executed. type integer status description The current status of this step. allOf $ref #/definitions/StepStatus invalid_details title Invalid Details description Details about fields that are invalid (if status < 'INPUTS_READY'. type object additionalProperties type string inputs title Inputs description The current inputs of this step. type object additionalProperties type string format uuid outputs title Outputs description The current outputs of this step. type object additionalProperties type string format uuid required kiara_id pipeline_id step step_id processing_stage status inputs outputs PipelineState title PipelineState description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties kiara_id title Kiara Id description The id of the kiara context. type string format uuid pipeline_id title Pipeline Id description The id of the pipeline. type string format uuid pipeline_status description The current status of this pipeline. allOf $ref #/definitions/StepStatus invalid_details title Invalid Details description Details about fields that are invalid (if status < 'INPUTS_READY'. type object additionalProperties type string pipeline_inputs title Pipeline Inputs description The current pipeline inputs. type object additionalProperties type string format uuid pipeline_outputs title Pipeline Outputs description The current pipeline outputs. type object additionalProperties type string format uuid step_states title Step States description The state of each step within this pipeline. type object additionalProperties $ref #/definitions/StepDetails required kiara_id pipeline_id pipeline_status pipeline_inputs pipeline_outputs step_states additionalProperties False	The (json) schema for this model data.

info.workflow

type_name	info.workflow	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name WorkflowInfo The name of the Python class. python_module_name kiara.models.workflow The name of the Python module this class lives in. full_name kiara.models.workflow.WorkflowInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title WorkflowInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel workflow_metadata title Workflow Metadata description The workflow details. allOf $ref #/definitions/WorkflowMetadata workflow_state_ids title Workflow State Ids description All states for this workflow. type array items type string pipeline_info title Pipeline Info description The current state of the workflows' pipeline. allOf $ref #/definitions/PipelineInfo current_input_values title Current Input Values description The current workflow inputs (after aliasing). allOf $ref #/definitions/ValueMap current_output_values title Current Output Values description The current workflow outputs (after aliasing). allOf $ref #/definitions/ValueMap input_aliases title Input Aliases description The (current) input aliases for this workflow. type object additionalProperties type string output_aliases title Output Aliases description The (current) output aliases for this workflow. type object additionalProperties type string required type_name documentation authors context workflow_metadata workflow_state_ids pipeline_info current_input_values current_output_values input_aliases output_aliases additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string WorkflowMetadata title WorkflowMetadata description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties workflow_id title Workflow Id description The globaly unique uuid for this workflow. type string format uuid documentation title Documentation description A description for this workflow. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description The author(s) of this workflow. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Workflow context details. allOf $ref #/definitions/ContextMetadataModel current_state title Current State description A reference to the current state of this workflow. type string workflow_history title Workflow History description A history of all the states of this workflow. type object additionalProperties type string input_aliases title Input Aliases description A set of aliases that can be used to forward inputs to their (unaliased) pipeline inputs. type object additionalProperties type string output_aliases title Output Aliases description A set of aliases to make output field names more user friendly. type object additionalProperties type string is_persisted title Is Persisted description Whether this workflow is persisted in it's current state in a kiara store. default False type boolean required workflow_id additionalProperties False Manifest title Manifest description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean required module_type additionalProperties False StepValueAddress title StepValueAddress description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. type object properties step_id title Step Id description The id of a step within a pipeline. type string value_name title Value Name description The name of the value (output name or pipeline input name). type string sub_value title Sub Value description A reference to a subitem of a value (e.g. column, list item) type object required step_id value_name additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False KiaraModuleInstance title KiaraModuleInstance description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string module_config title Module Config description The module config. type object inputs_schema title Inputs Schema description The schema for the module input(s). type object additionalProperties $ref #/definitions/ValueSchema outputs_schema title Outputs Schema description The schema for the module output(s). type object additionalProperties $ref #/definitions/ValueSchema required python_class_name python_module_name full_name module_config inputs_schema outputs_schema additionalProperties False PipelineStep title PipelineStep description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The module config. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean step_id title Step Id description Locally unique id (within a pipeline) of this step. type string manifest_src title Manifest Src description The original manfifest provided by the user. allOf $ref #/definitions/Manifest input_links title Input Links description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. type object additionalProperties type array items $ref #/definitions/StepValueAddress module_details title Module Details description The class of the underlying module. allOf $ref #/definitions/KiaraModuleInstance doc title Doc description A description what this step does. allOf $ref #/definitions/DocumentationMetadataModel required module_type step_id manifest_src module_details doc additionalProperties False PipelineConfig title PipelineConfig description A class to hold the configuration for a [PipelineModule][kiara.pipeline.module.PipelineModule]. If you want to control the pipeline input and output names, you need to have to provide a map that uses the autogenerated field name ([step_id]__[alias] -- 2 underscores!!) as key, and the desired field name as value. The reason that schema for the autogenerated field names exist is that it's hard to ensure the uniqueness of each field; some steps can have the same input field names, but will need different input values. In some cases, some inputs of different steps need the same input. Those sorts of things. So, to make sure that we always use the right values, I chose to implement a conservative default approach, accepting that in some cases the user will be prompted for duplicate inputs for the same value. To remedy that, the pipeline creator has the option to manually specify a mapping to rename some or all of the input/output fields. Further, because in a lot of cases there won't be any overlapping fields, the creator can specify ``auto``, in which case *Kiara* will automatically create a mapping that tries to map autogenerated field names to the shortest possible names for each case. Examples: -------- Configuration for a pipeline module that functions as a ``nand`` logic gate (in Python): ``` python and_step = PipelineStepConfig(module_type="and", step_id="and") not_step = PipelineStepConfig(module_type="not", step_id="not", input_links={"a": ["and.y"]} nand_p_conf = PipelineConfig(doc="Returns 'False' if both inputs are 'True'.", steps=[and_step, not_step], input_aliases={ "and.a": "a", "and.b": "b" }, output_aliases={ "not.y": "y" }} ``` Or, the same thing in json: ``` json { "module_type_name": "nand", "doc": "Returns 'False' if both inputs are 'True'.", "steps": [ { "module_type": "and", "step_id": "and" }, { "module_type": "not", "step_id": "not", "input_links": { "a": "and.y" } } ], "input_aliases": { "and.a": "a", "and.b": "b" }, "output_aliases": { "not.y": "y" } } ``` type object properties constants title Constants description Value constants for this module. type object defaults title Defaults description Value defaults for this module. type object pipeline_name title Pipeline Name description The name of this pipeline. type string steps title Steps description A list of steps/modules of this pipeline, and their connections. type array items $ref #/definitions/PipelineStep input_aliases title Input Aliases description A map of input aliases, with the location of the input (in the format '[step_id].[input_field]') as key, and the pipeline input field name as value. type object additionalProperties type string output_aliases title Output Aliases description A map of output aliases, with the location of the output (in the format '[step_id].[output_field]') as key, and the pipeline output field name as value. type object additionalProperties type string doc title Doc description Documentation about what the pipeline does. default -- n/a -- allOf $ref #/definitions/DocumentationMetadataModel context title Context description Metadata for this workflow. type object required pipeline_name steps input_aliases output_aliases StepStatus title StepStatus description Enum to describe the state of a workflow. enum inputs_invalid inputs_ready results_ready StepDetails title StepDetails type object properties kiara_id title Kiara Id description The id of the kiara context. type string format uuid pipeline_id title Pipeline Id description The id of the pipeline. type string format uuid step title Step description The pipeline step details. allOf $ref #/definitions/PipelineStep step_id title Step Id description The id of the step. type string processing_stage title Processing Stage description The execution stage where this step is executed. type integer status description The current status of this step. allOf $ref #/definitions/StepStatus invalid_details title Invalid Details description Details about fields that are invalid (if status < 'INPUTS_READY'. type object additionalProperties type string inputs title Inputs description The current inputs of this step. type object additionalProperties type string format uuid outputs title Outputs description The current outputs of this step. type object additionalProperties type string format uuid required kiara_id pipeline_id step step_id processing_stage status inputs outputs PipelineState title PipelineState description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties kiara_id title Kiara Id description The id of the kiara context. type string format uuid pipeline_id title Pipeline Id description The id of the pipeline. type string format uuid pipeline_status description The current status of this pipeline. allOf $ref #/definitions/StepStatus invalid_details title Invalid Details description Details about fields that are invalid (if status < 'INPUTS_READY'. type object additionalProperties type string pipeline_inputs title Pipeline Inputs description The current pipeline inputs. type object additionalProperties type string format uuid pipeline_outputs title Pipeline Outputs description The current pipeline outputs. type object additionalProperties type string format uuid step_states title Step States description The state of each step within this pipeline. type object additionalProperties $ref #/definitions/StepDetails required kiara_id pipeline_id pipeline_status pipeline_inputs pipeline_outputs step_states additionalProperties False PipelineInfo title PipelineInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel pipeline_config title Pipeline Config description The configuration of the pipeline. allOf $ref #/definitions/PipelineConfig pipeline_state title Pipeline State description The current input details. allOf $ref #/definitions/PipelineState required type_name documentation authors context pipeline_config pipeline_state additionalProperties False ValueMap title ValueMap description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties values_schema title Values Schema description The schemas for all the values in this set. type object additionalProperties $ref #/definitions/ValueSchema required values_schema additionalProperties False	The (json) schema for this model data.

archive_info

type_name	archive_info	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ArchiveInfo The name of the Python class. python_module_name kiara.models.archives The name of the Python module this class lives in. full_name kiara.models.archives.ArchiveInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title ArchiveInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel archive_id title Archive Id description The (globally unique) archive id. type string format uuid archive_type_info title Archive Type Info description Information about this archives' type. allOf $ref #/definitions/ArchiveTypeInfo config title Config description The configuration of this archive. type object details title Details description Type dependent (runtime) details for this archive. allOf $ref #/definitions/ArchiveDetails aliases title Aliases description Aliases for this archive. type array items type string required type_name documentation authors context archive_id archive_type_info config details additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False ArchiveTypeInfo title ArchiveTypeInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel python_class title Python Class description The python class that implements this module type. allOf $ref #/definitions/PythonClass is_writable title Is Writable description Whether this archive is writeable. default False type boolean supported_item_types title Supported Item Types description The item types this archive suports. type array items type string required type_name documentation authors context python_class supported_item_types additionalProperties False ArchiveDetails title ArchiveDetails type object properties size title Size description The size of the stored archive. type integer	The (json) schema for this model data.

info.archive_types

type_name	info.archive_types	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ArchiveTypeClassesInfo The name of the Python class. python_module_name kiara.models.archives The name of the Python module this class lives in. full_name kiara.models.archives.ArchiveTypeClassesInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title ArchiveTypeClassesInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties group_title title Group Title description The group alias. type string item_infos title Item Infos description The archive info instances for each type. type object additionalProperties $ref #/definitions/ArchiveTypeInfo type_name title Type Name default archive_type enum archive_type type string required item_infos additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False ArchiveTypeInfo title ArchiveTypeInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel python_class title Python Class description The python class that implements this module type. allOf $ref #/definitions/PythonClass is_writable title Is Writable description Whether this archive is writeable. default False type boolean supported_item_types title Supported Item Types description The item types this archive suports. type array items type string required type_name documentation authors context python_class supported_item_types additionalProperties False	The (json) schema for this model data.

info.metadata_types

type_name	info.metadata_types	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name MetadataTypeClassesInfo The name of the Python class. python_module_name kiara.models.values.value_metadata The name of the Python module this class lives in. full_name kiara.models.values.value_metadata.MetadataTypeClassesInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title MetadataTypeClassesInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties group_title title Group Title description The group alias. type string item_infos title Item Infos description The value metadata info instances for each type. type object additionalProperties $ref #/definitions/MetadataTypeInfo type_name title Type Name default value_metadata enum value_metadata type string required item_infos additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False MetadataTypeInfo title MetadataTypeInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel python_class title Python Class description The python class that implements this module type. allOf $ref #/definitions/PythonClass metadata_schema title Metadata Schema description The (json) schema for this metadata value. type object required type_name documentation authors context python_class metadata_schema additionalProperties False	The (json) schema for this model data.

info.workflows

type_name	info.workflows	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name WorkflowGroupInfo The name of the Python class. python_module_name kiara.models.workflow The name of the Python module this class lives in. full_name kiara.models.workflow.WorkflowGroupInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title WorkflowGroupInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties group_title title Group Title description The group alias. type string item_infos title Item Infos description The workflow infos objects for each workflow. type object additionalProperties $ref #/definitions/WorkflowInfo aliases title Aliases description The available aliases. type object additionalProperties type string format uuid required item_infos additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string WorkflowMetadata title WorkflowMetadata description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties workflow_id title Workflow Id description The globaly unique uuid for this workflow. type string format uuid documentation title Documentation description A description for this workflow. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description The author(s) of this workflow. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Workflow context details. allOf $ref #/definitions/ContextMetadataModel current_state title Current State description A reference to the current state of this workflow. type string workflow_history title Workflow History description A history of all the states of this workflow. type object additionalProperties type string input_aliases title Input Aliases description A set of aliases that can be used to forward inputs to their (unaliased) pipeline inputs. type object additionalProperties type string output_aliases title Output Aliases description A set of aliases to make output field names more user friendly. type object additionalProperties type string is_persisted title Is Persisted description Whether this workflow is persisted in it's current state in a kiara store. default False type boolean required workflow_id additionalProperties False Manifest title Manifest description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean required module_type additionalProperties False StepValueAddress title StepValueAddress description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. type object properties step_id title Step Id description The id of a step within a pipeline. type string value_name title Value Name description The name of the value (output name or pipeline input name). type string sub_value title Sub Value description A reference to a subitem of a value (e.g. column, list item) type object required step_id value_name additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False KiaraModuleInstance title KiaraModuleInstance description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string module_config title Module Config description The module config. type object inputs_schema title Inputs Schema description The schema for the module input(s). type object additionalProperties $ref #/definitions/ValueSchema outputs_schema title Outputs Schema description The schema for the module output(s). type object additionalProperties $ref #/definitions/ValueSchema required python_class_name python_module_name full_name module_config inputs_schema outputs_schema additionalProperties False PipelineStep title PipelineStep description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The module config. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean step_id title Step Id description Locally unique id (within a pipeline) of this step. type string manifest_src title Manifest Src description The original manfifest provided by the user. allOf $ref #/definitions/Manifest input_links title Input Links description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. type object additionalProperties type array items $ref #/definitions/StepValueAddress module_details title Module Details description The class of the underlying module. allOf $ref #/definitions/KiaraModuleInstance doc title Doc description A description what this step does. allOf $ref #/definitions/DocumentationMetadataModel required module_type step_id manifest_src module_details doc additionalProperties False PipelineConfig title PipelineConfig description A class to hold the configuration for a [PipelineModule][kiara.pipeline.module.PipelineModule]. If you want to control the pipeline input and output names, you need to have to provide a map that uses the autogenerated field name ([step_id]__[alias] -- 2 underscores!!) as key, and the desired field name as value. The reason that schema for the autogenerated field names exist is that it's hard to ensure the uniqueness of each field; some steps can have the same input field names, but will need different input values. In some cases, some inputs of different steps need the same input. Those sorts of things. So, to make sure that we always use the right values, I chose to implement a conservative default approach, accepting that in some cases the user will be prompted for duplicate inputs for the same value. To remedy that, the pipeline creator has the option to manually specify a mapping to rename some or all of the input/output fields. Further, because in a lot of cases there won't be any overlapping fields, the creator can specify ``auto``, in which case *Kiara* will automatically create a mapping that tries to map autogenerated field names to the shortest possible names for each case. Examples: -------- Configuration for a pipeline module that functions as a ``nand`` logic gate (in Python): ``` python and_step = PipelineStepConfig(module_type="and", step_id="and") not_step = PipelineStepConfig(module_type="not", step_id="not", input_links={"a": ["and.y"]} nand_p_conf = PipelineConfig(doc="Returns 'False' if both inputs are 'True'.", steps=[and_step, not_step], input_aliases={ "and.a": "a", "and.b": "b" }, output_aliases={ "not.y": "y" }} ``` Or, the same thing in json: ``` json { "module_type_name": "nand", "doc": "Returns 'False' if both inputs are 'True'.", "steps": [ { "module_type": "and", "step_id": "and" }, { "module_type": "not", "step_id": "not", "input_links": { "a": "and.y" } } ], "input_aliases": { "and.a": "a", "and.b": "b" }, "output_aliases": { "not.y": "y" } } ``` type object properties constants title Constants description Value constants for this module. type object defaults title Defaults description Value defaults for this module. type object pipeline_name title Pipeline Name description The name of this pipeline. type string steps title Steps description A list of steps/modules of this pipeline, and their connections. type array items $ref #/definitions/PipelineStep input_aliases title Input Aliases description A map of input aliases, with the location of the input (in the format '[step_id].[input_field]') as key, and the pipeline input field name as value. type object additionalProperties type string output_aliases title Output Aliases description A map of output aliases, with the location of the output (in the format '[step_id].[output_field]') as key, and the pipeline output field name as value. type object additionalProperties type string doc title Doc description Documentation about what the pipeline does. default -- n/a -- allOf $ref #/definitions/DocumentationMetadataModel context title Context description Metadata for this workflow. type object required pipeline_name steps input_aliases output_aliases StepStatus title StepStatus description Enum to describe the state of a workflow. enum inputs_invalid inputs_ready results_ready StepDetails title StepDetails type object properties kiara_id title Kiara Id description The id of the kiara context. type string format uuid pipeline_id title Pipeline Id description The id of the pipeline. type string format uuid step title Step description The pipeline step details. allOf $ref #/definitions/PipelineStep step_id title Step Id description The id of the step. type string processing_stage title Processing Stage description The execution stage where this step is executed. type integer status description The current status of this step. allOf $ref #/definitions/StepStatus invalid_details title Invalid Details description Details about fields that are invalid (if status < 'INPUTS_READY'. type object additionalProperties type string inputs title Inputs description The current inputs of this step. type object additionalProperties type string format uuid outputs title Outputs description The current outputs of this step. type object additionalProperties type string format uuid required kiara_id pipeline_id step step_id processing_stage status inputs outputs PipelineState title PipelineState description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties kiara_id title Kiara Id description The id of the kiara context. type string format uuid pipeline_id title Pipeline Id description The id of the pipeline. type string format uuid pipeline_status description The current status of this pipeline. allOf $ref #/definitions/StepStatus invalid_details title Invalid Details description Details about fields that are invalid (if status < 'INPUTS_READY'. type object additionalProperties type string pipeline_inputs title Pipeline Inputs description The current pipeline inputs. type object additionalProperties type string format uuid pipeline_outputs title Pipeline Outputs description The current pipeline outputs. type object additionalProperties type string format uuid step_states title Step States description The state of each step within this pipeline. type object additionalProperties $ref #/definitions/StepDetails required kiara_id pipeline_id pipeline_status pipeline_inputs pipeline_outputs step_states additionalProperties False PipelineInfo title PipelineInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel pipeline_config title Pipeline Config description The configuration of the pipeline. allOf $ref #/definitions/PipelineConfig pipeline_state title Pipeline State description The current input details. allOf $ref #/definitions/PipelineState required type_name documentation authors context pipeline_config pipeline_state additionalProperties False ValueMap title ValueMap description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties values_schema title Values Schema description The schemas for all the values in this set. type object additionalProperties $ref #/definitions/ValueSchema required values_schema additionalProperties False WorkflowInfo title WorkflowInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel workflow_metadata title Workflow Metadata description The workflow details. allOf $ref #/definitions/WorkflowMetadata workflow_state_ids title Workflow State Ids description All states for this workflow. type array items type string pipeline_info title Pipeline Info description The current state of the workflows' pipeline. allOf $ref #/definitions/PipelineInfo current_input_values title Current Input Values description The current workflow inputs (after aliasing). allOf $ref #/definitions/ValueMap current_output_values title Current Output Values description The current workflow outputs (after aliasing). allOf $ref #/definitions/ValueMap input_aliases title Input Aliases description The (current) input aliases for this workflow. type object additionalProperties type string output_aliases title Output Aliases description The (current) output aliases for this workflow. type object additionalProperties type string required type_name documentation authors context workflow_metadata workflow_state_ids pipeline_info current_input_values current_output_values input_aliases output_aliases additionalProperties False	The (json) schema for this model data.

info.archives

type_name	info.archives	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ArchiveGroupInfo The name of the Python class. python_module_name kiara.models.archives The name of the Python module this class lives in. full_name kiara.models.archives.ArchiveGroupInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title ArchiveGroupInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties group_title title Group Title description The group alias. type string item_infos title Item Infos description The info for each archive. type object additionalProperties $ref #/definitions/ArchiveInfo required item_infos additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False ArchiveTypeInfo title ArchiveTypeInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel python_class title Python Class description The python class that implements this module type. allOf $ref #/definitions/PythonClass is_writable title Is Writable description Whether this archive is writeable. default False type boolean supported_item_types title Supported Item Types description The item types this archive suports. type array items type string required type_name documentation authors context python_class supported_item_types additionalProperties False ArchiveDetails title ArchiveDetails type object properties size title Size description The size of the stored archive. type integer ArchiveInfo title ArchiveInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel archive_id title Archive Id description The (globally unique) archive id. type string format uuid archive_type_info title Archive Type Info description Information about this archives' type. allOf $ref #/definitions/ArchiveTypeInfo config title Config description The configuration of this archive. type object details title Details description Type dependent (runtime) details for this archive. allOf $ref #/definitions/ArchiveDetails aliases title Aliases description Aliases for this archive. type array items type string required type_name documentation authors context archive_id archive_type_info config details additionalProperties False	The (json) schema for this model data.

instance.pipeline_state

type_name	instance.pipeline_state	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name PipelineState The name of the Python class. python_module_name kiara.models.events.pipeline The name of the Python module this class lives in. full_name kiara.models.events.pipeline.PipelineState The full class namespace.	The python class that implements this module type.
metadata_schema	title PipelineState description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties kiara_id title Kiara Id description The id of the kiara context. type string format uuid pipeline_id title Pipeline Id description The id of the pipeline. type string format uuid pipeline_status description The current status of this pipeline. allOf $ref #/definitions/StepStatus invalid_details title Invalid Details description Details about fields that are invalid (if status < 'INPUTS_READY'. type object additionalProperties type string pipeline_inputs title Pipeline Inputs description The current pipeline inputs. type object additionalProperties type string format uuid pipeline_outputs title Pipeline Outputs description The current pipeline outputs. type object additionalProperties type string format uuid step_states title Step States description The state of each step within this pipeline. type object additionalProperties $ref #/definitions/StepDetails required kiara_id pipeline_id pipeline_status pipeline_inputs pipeline_outputs step_states additionalProperties False definitions StepStatus title StepStatus description Enum to describe the state of a workflow. enum inputs_invalid inputs_ready results_ready Manifest title Manifest description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean required module_type additionalProperties False StepValueAddress title StepValueAddress description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. type object properties step_id title Step Id description The id of a step within a pipeline. type string value_name title Value Name description The name of the value (output name or pipeline input name). type string sub_value title Sub Value description A reference to a subitem of a value (e.g. column, list item) type object required step_id value_name additionalProperties False DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False KiaraModuleInstance title KiaraModuleInstance description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string module_config title Module Config description The module config. type object inputs_schema title Inputs Schema description The schema for the module input(s). type object additionalProperties $ref #/definitions/ValueSchema outputs_schema title Outputs Schema description The schema for the module output(s). type object additionalProperties $ref #/definitions/ValueSchema required python_class_name python_module_name full_name module_config inputs_schema outputs_schema additionalProperties False PipelineStep title PipelineStep description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The module config. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean step_id title Step Id description Locally unique id (within a pipeline) of this step. type string manifest_src title Manifest Src description The original manfifest provided by the user. allOf $ref #/definitions/Manifest input_links title Input Links description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. type object additionalProperties type array items $ref #/definitions/StepValueAddress module_details title Module Details description The class of the underlying module. allOf $ref #/definitions/KiaraModuleInstance doc title Doc description A description what this step does. allOf $ref #/definitions/DocumentationMetadataModel required module_type step_id manifest_src module_details doc additionalProperties False StepDetails title StepDetails type object properties kiara_id title Kiara Id description The id of the kiara context. type string format uuid pipeline_id title Pipeline Id description The id of the pipeline. type string format uuid step title Step description The pipeline step details. allOf $ref #/definitions/PipelineStep step_id title Step Id description The id of the step. type string processing_stage title Processing Stage description The execution stage where this step is executed. type integer status description The current status of this step. allOf $ref #/definitions/StepStatus invalid_details title Invalid Details description Details about fields that are invalid (if status < 'INPUTS_READY'. type object additionalProperties type string inputs title Inputs description The current inputs of this step. type object additionalProperties type string format uuid outputs title Outputs description The current outputs of this step. type object additionalProperties type string format uuid required kiara_id pipeline_id step step_id processing_stage status inputs outputs	The (json) schema for this model data.

instance.render_scene

type_name	instance.render_scene	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name RenderScene The name of the Python class. python_module_name kiara.models.rendering The name of the Python module this class lives in. full_name kiara.models.rendering.RenderScene The full class namespace.	The python class that implements this module type.
metadata_schema	$ref #/definitions/RenderScene definitions RenderScene title RenderScene description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties title title Title description The title of this scene. type string disabled title Disabled description Whether this scene should be displayed as 'disabled' in a UI. default False type boolean description title Description description Description of what this scene renders. default -- n/a -- type string manifest_hash title Manifest Hash description The hash of the manifest of the referenced render scene. type string render_config title Render Config description The inputs used with the referenced manifest. type object related_scenes title Related Scenes description Other render scenes, related to this one. type object additionalProperties $ref #/definitions/RenderScene required title manifest_hash additionalProperties False	The (json) schema for this model data.

render_value_result

type_name	render_value_result	The registered name for this item type.
documentation	description Object containing all the result properties of a 'render_value' operation. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name RenderValueResult The name of the Python class. python_module_name kiara.models.rendering The name of the Python module this class lives in. full_name kiara.models.rendering.RenderValueResult The full class namespace.	The python class that implements this module type.
metadata_schema	title RenderValueResult description Object containing all the result properties of a 'render_value' operation. type object properties value_id title Value Id description The value that was rendered. type string format uuid render_config title Render Config description The config that was used to render this. type object render_manifest title Render Manifest description The id of the manifest that was used to render this. type string related_scenes title Related Scenes description Other render scenes, related to this one. type object additionalProperties $ref #/definitions/RenderScene manifest_lookup title Manifest Lookup description The manifests referenced in this model, indexed by the hashes. type object additionalProperties $ref #/definitions/Manifest rendered title Rendered description The rendered object. required value_id render_manifest additionalProperties False definitions RenderScene title RenderScene description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties title title Title description The title of this scene. type string disabled title Disabled description Whether this scene should be displayed as 'disabled' in a UI. default False type boolean description title Description description Description of what this scene renders. default -- n/a -- type string manifest_hash title Manifest Hash description The hash of the manifest of the referenced render scene. type string render_config title Render Config description The inputs used with the referenced manifest. type object related_scenes title Related Scenes description Other render scenes, related to this one. type object additionalProperties $ref #/definitions/RenderScene required title manifest_hash additionalProperties False Manifest title Manifest description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean required module_type additionalProperties False	The (json) schema for this model data.

value_matcher

type_name	value_matcher	The registered name for this item type.
documentation	description An object describing requirements values should satisfy in order to be included in a query result. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ValueMatcher The name of the Python class. python_module_name kiara.models.values.matchers The name of the Python module this class lives in. full_name kiara.models.values.matchers.ValueMatcher The full class namespace.	The python class that implements this module type.
metadata_schema	title ValueMatcher description An object describing requirements values should satisfy in order to be included in a query result. type object properties data_types title Data Types description The data type. type array items type string allow_sub_types title Allow Sub Types description Allow subtypes. default True type boolean min_size title Min Size description The minimum size for the dataset. default 0 type integer max_size title Max Size description The maximum size for the dataset. type integer allow_internal title Allow Internal description Allow internal data types. default False type boolean has_alias title Has Alias description Value must have at least one alias. default True type boolean alias_matchers title Alias Matchers description Values must have an alias that matches one of the provided matchers. Assumes 'has_alias' is set to 'True'. type array items type string additionalProperties False	The (json) schema for this model data.

workflow_state

type_name	workflow_state	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name WorkflowState The name of the Python class. python_module_name kiara.models.workflow The name of the Python module this class lives in. full_name kiara.models.workflow.WorkflowState The full class namespace.	The python class that implements this module type.
metadata_schema	title WorkflowState description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties steps title Steps description The current steps in the workflow. type array items $ref #/definitions/PipelineStep inputs title Inputs description The current (pipeline) input values. type object additionalProperties type string format uuid pipeline_info title Pipeline Info description Details about the pipeline and its state. allOf $ref #/definitions/PipelineInfo required pipeline_info additionalProperties False definitions Manifest title Manifest description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean required module_type additionalProperties False StepValueAddress title StepValueAddress description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. type object properties step_id title Step Id description The id of a step within a pipeline. type string value_name title Value Name description The name of the value (output name or pipeline input name). type string sub_value title Sub Value description A reference to a subitem of a value (e.g. column, list item) type object required step_id value_name additionalProperties False DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False KiaraModuleInstance title KiaraModuleInstance description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string module_config title Module Config description The module config. type object inputs_schema title Inputs Schema description The schema for the module input(s). type object additionalProperties $ref #/definitions/ValueSchema outputs_schema title Outputs Schema description The schema for the module output(s). type object additionalProperties $ref #/definitions/ValueSchema required python_class_name python_module_name full_name module_config inputs_schema outputs_schema additionalProperties False PipelineStep title PipelineStep description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The module config. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean step_id title Step Id description Locally unique id (within a pipeline) of this step. type string manifest_src title Manifest Src description The original manfifest provided by the user. allOf $ref #/definitions/Manifest input_links title Input Links description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. type object additionalProperties type array items $ref #/definitions/StepValueAddress module_details title Module Details description The class of the underlying module. allOf $ref #/definitions/KiaraModuleInstance doc title Doc description A description what this step does. allOf $ref #/definitions/DocumentationMetadataModel required module_type step_id manifest_src module_details doc additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PipelineConfig title PipelineConfig description A class to hold the configuration for a [PipelineModule][kiara.pipeline.module.PipelineModule]. If you want to control the pipeline input and output names, you need to have to provide a map that uses the autogenerated field name ([step_id]__[alias] -- 2 underscores!!) as key, and the desired field name as value. The reason that schema for the autogenerated field names exist is that it's hard to ensure the uniqueness of each field; some steps can have the same input field names, but will need different input values. In some cases, some inputs of different steps need the same input. Those sorts of things. So, to make sure that we always use the right values, I chose to implement a conservative default approach, accepting that in some cases the user will be prompted for duplicate inputs for the same value. To remedy that, the pipeline creator has the option to manually specify a mapping to rename some or all of the input/output fields. Further, because in a lot of cases there won't be any overlapping fields, the creator can specify ``auto``, in which case *Kiara* will automatically create a mapping that tries to map autogenerated field names to the shortest possible names for each case. Examples: -------- Configuration for a pipeline module that functions as a ``nand`` logic gate (in Python): ``` python and_step = PipelineStepConfig(module_type="and", step_id="and") not_step = PipelineStepConfig(module_type="not", step_id="not", input_links={"a": ["and.y"]} nand_p_conf = PipelineConfig(doc="Returns 'False' if both inputs are 'True'.", steps=[and_step, not_step], input_aliases={ "and.a": "a", "and.b": "b" }, output_aliases={ "not.y": "y" }} ``` Or, the same thing in json: ``` json { "module_type_name": "nand", "doc": "Returns 'False' if both inputs are 'True'.", "steps": [ { "module_type": "and", "step_id": "and" }, { "module_type": "not", "step_id": "not", "input_links": { "a": "and.y" } } ], "input_aliases": { "and.a": "a", "and.b": "b" }, "output_aliases": { "not.y": "y" } } ``` type object properties constants title Constants description Value constants for this module. type object defaults title Defaults description Value defaults for this module. type object pipeline_name title Pipeline Name description The name of this pipeline. type string steps title Steps description A list of steps/modules of this pipeline, and their connections. type array items $ref #/definitions/PipelineStep input_aliases title Input Aliases description A map of input aliases, with the location of the input (in the format '[step_id].[input_field]') as key, and the pipeline input field name as value. type object additionalProperties type string output_aliases title Output Aliases description A map of output aliases, with the location of the output (in the format '[step_id].[output_field]') as key, and the pipeline output field name as value. type object additionalProperties type string doc title Doc description Documentation about what the pipeline does. default -- n/a -- allOf $ref #/definitions/DocumentationMetadataModel context title Context description Metadata for this workflow. type object required pipeline_name steps input_aliases output_aliases StepStatus title StepStatus description Enum to describe the state of a workflow. enum inputs_invalid inputs_ready results_ready StepDetails title StepDetails type object properties kiara_id title Kiara Id description The id of the kiara context. type string format uuid pipeline_id title Pipeline Id description The id of the pipeline. type string format uuid step title Step description The pipeline step details. allOf $ref #/definitions/PipelineStep step_id title Step Id description The id of the step. type string processing_stage title Processing Stage description The execution stage where this step is executed. type integer status description The current status of this step. allOf $ref #/definitions/StepStatus invalid_details title Invalid Details description Details about fields that are invalid (if status < 'INPUTS_READY'. type object additionalProperties type string inputs title Inputs description The current inputs of this step. type object additionalProperties type string format uuid outputs title Outputs description The current outputs of this step. type object additionalProperties type string format uuid required kiara_id pipeline_id step step_id processing_stage status inputs outputs PipelineState title PipelineState description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties kiara_id title Kiara Id description The id of the kiara context. type string format uuid pipeline_id title Pipeline Id description The id of the pipeline. type string format uuid pipeline_status description The current status of this pipeline. allOf $ref #/definitions/StepStatus invalid_details title Invalid Details description Details about fields that are invalid (if status < 'INPUTS_READY'. type object additionalProperties type string pipeline_inputs title Pipeline Inputs description The current pipeline inputs. type object additionalProperties type string format uuid pipeline_outputs title Pipeline Outputs description The current pipeline outputs. type object additionalProperties type string format uuid step_states title Step States description The state of each step within this pipeline. type object additionalProperties $ref #/definitions/StepDetails required kiara_id pipeline_id pipeline_status pipeline_inputs pipeline_outputs step_states additionalProperties False PipelineInfo title PipelineInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel pipeline_config title Pipeline Config description The configuration of the pipeline. allOf $ref #/definitions/PipelineConfig pipeline_state title Pipeline State description The current input details. allOf $ref #/definitions/PipelineState required type_name documentation authors context pipeline_config pipeline_state additionalProperties False	The (json) schema for this model data.

instance.workflow

type_name	instance.workflow	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name WorkflowMetadata The name of the Python class. python_module_name kiara.models.workflow The name of the Python module this class lives in. full_name kiara.models.workflow.WorkflowMetadata The full class namespace.	The python class that implements this module type.
metadata_schema	title WorkflowMetadata description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties workflow_id title Workflow Id description The globaly unique uuid for this workflow. type string format uuid documentation title Documentation description A description for this workflow. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description The author(s) of this workflow. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Workflow context details. allOf $ref #/definitions/ContextMetadataModel current_state title Current State description A reference to the current state of this workflow. type string workflow_history title Workflow History description A history of all the states of this workflow. type object additionalProperties type string input_aliases title Input Aliases description A set of aliases that can be used to forward inputs to their (unaliased) pipeline inputs. type object additionalProperties type string output_aliases title Output Aliases description A set of aliases to make output field names more user friendly. type object additionalProperties type string is_persisted title Is Persisted description Whether this workflow is persisted in it's current state in a kiara store. default False type boolean required workflow_id additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string	The (json) schema for this model data.

context_info

type_name	context_info	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ContextInfo The name of the Python class. python_module_name kiara.models.context The name of the Python module this class lives in. full_name kiara.models.context.ContextInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title ContextInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties kiara_id title Kiara Id description The (globally unique) id of the kiara context. type string format uuid context_name title Context Name description The local alias for this context. type string value_ids title Value Ids description The ids of all stored values in this context. type array items type string format uuid aliases title Aliases description All available aliases within this context (and the value ids they refer to). type object additionalProperties type string format uuid archives title Archives description The archives registered in this context. allOf $ref #/definitions/ArchiveGroupInfo invalid title Invalid description Whether this context has errors. bool False type boolean comment title Comment description (Optional) comment about this context. type string required kiara_id value_ids aliases archives invalid additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False ArchiveTypeInfo title ArchiveTypeInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel python_class title Python Class description The python class that implements this module type. allOf $ref #/definitions/PythonClass is_writable title Is Writable description Whether this archive is writeable. default False type boolean supported_item_types title Supported Item Types description The item types this archive suports. type array items type string required type_name documentation authors context python_class supported_item_types additionalProperties False ArchiveDetails title ArchiveDetails type object properties size title Size description The size of the stored archive. type integer ArchiveInfo title ArchiveInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel archive_id title Archive Id description The (globally unique) archive id. type string format uuid archive_type_info title Archive Type Info description Information about this archives' type. allOf $ref #/definitions/ArchiveTypeInfo config title Config description The configuration of this archive. type object details title Details description Type dependent (runtime) details for this archive. allOf $ref #/definitions/ArchiveDetails aliases title Aliases description Aliases for this archive. type array items type string required type_name documentation authors context archive_id archive_type_info config details additionalProperties False ArchiveGroupInfo title ArchiveGroupInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties group_title title Group Title description The group alias. type string item_infos title Item Infos description The info for each archive. type object additionalProperties $ref #/definitions/ArchiveInfo required item_infos additionalProperties False	The (json) schema for this model data.

metadata.python_class

type_name	metadata.python_class	The registered name for this item type.
documentation	description Python class and module information. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name PythonClassMetadata The name of the Python class. python_module_name kiara.models.values.value_metadata.included_metadata_types The name of the Python module this class lives in. full_name kiara.models.values.value_metadata.included_metadata_types.PythonClassMetadata The full class namespace.	The python class that implements this module type.
metadata_schema	title PythonClassMetadata description Python class and module information. type object properties python_class title Python Class description Details about the Python class that backs this value. allOf $ref #/definitions/PythonClass required python_class additionalProperties False definitions PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False	The (json) schema for this model data.

metadata.file

type_name	metadata.file	The registered name for this item type.
documentation	description File stats. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name FileMetadata The name of the Python class. python_module_name kiara.models.values.value_metadata.included_metadata_types The name of the Python module this class lives in. full_name kiara.models.values.value_metadata.included_metadata_types.FileMetadata The full class namespace.	The python class that implements this module type.
metadata_schema	title FileMetadata description File stats. type object properties file title File description The file-specific metadata. allOf $ref #/definitions/KiaraFile required file additionalProperties False definitions KiaraFile title KiaraFile description Describes properties for the 'file' value type. type object properties mime_type title Mime Type description The mime type of the file. type string file_name title File Name default The name of the file. type string size title Size description The size of the file. type integer metadata title Metadata description Additional, ustructured, user-defined metadata. type object metadata_schemas title Metadata Schemas description The metadata schemas for each of the metadata values (if available). type object additionalProperties type string required mime_type size additionalProperties False	The (json) schema for this model data.

metadata.file_bundle

type_name	metadata.file_bundle	The registered name for this item type.
documentation	description File bundle stats. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name FileBundleMetadata The name of the Python class. python_module_name kiara.models.values.value_metadata.included_metadata_types The name of the Python module this class lives in. full_name kiara.models.values.value_metadata.included_metadata_types.FileBundleMetadata The full class namespace.	The python class that implements this module type.
metadata_schema	title FileBundleMetadata description File bundle stats. type object properties file_bundle title File Bundle description The file-specific metadata. allOf $ref #/definitions/KiaraFileBundle required file_bundle additionalProperties False definitions KiaraFile title KiaraFile description Describes properties for the 'file' value type. type object properties mime_type title Mime Type description The mime type of the file. type string file_name title File Name default The name of the file. type string size title Size description The size of the file. type integer metadata title Metadata description Additional, ustructured, user-defined metadata. type object metadata_schemas title Metadata Schemas description The metadata schemas for each of the metadata values (if available). type object additionalProperties type string required mime_type size additionalProperties False KiaraFileBundle title KiaraFileBundle description Describes properties for the 'file_bundle' value type. type object properties bundle_name title Bundle Name description The name of this bundle. type string number_of_files title Number Of Files description How many files are included in this bundle. type integer included_files title Included Files description A map of all the included files, incl. their properties. Uses the relative path of each file as key. type object additionalProperties $ref #/definitions/KiaraFile size title Size description The size of all files in this folder, combined. type integer metadata title Metadata description Additional, ustructured, user-defined metadata. type object metadata_schemas title Metadata Schemas description The metadata schemas for each metadata value (if available). type object additionalProperties type string required bundle_name number_of_files included_files size additionalProperties False	The (json) schema for this model data.

instance.data.file

type_name	instance.data.file	The registered name for this item type.
documentation	description Describes properties for the 'file' value type. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name KiaraFile The name of the Python class. python_module_name kiara.models.filesystem The name of the Python module this class lives in. full_name kiara.models.filesystem.KiaraFile The full class namespace.	The python class that implements this module type.
metadata_schema	title KiaraFile description Describes properties for the 'file' value type. type object properties mime_type title Mime Type description The mime type of the file. type string file_name title File Name default The name of the file. type string size title Size description The size of the file. type integer metadata title Metadata description Additional, ustructured, user-defined metadata. type object metadata_schemas title Metadata Schemas description The metadata schemas for each of the metadata values (if available). type object additionalProperties type string required mime_type size additionalProperties False	The (json) schema for this model data.

instance.data.file_bundle

type_name	instance.data.file_bundle	The registered name for this item type.
documentation	description Describes properties for the 'file_bundle' value type. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name KiaraFileBundle The name of the Python class. python_module_name kiara.models.filesystem The name of the Python module this class lives in. full_name kiara.models.filesystem.KiaraFileBundle The full class namespace.	The python class that implements this module type.
metadata_schema	title KiaraFileBundle description Describes properties for the 'file_bundle' value type. type object properties bundle_name title Bundle Name description The name of this bundle. type string number_of_files title Number Of Files description How many files are included in this bundle. type integer included_files title Included Files description A map of all the included files, incl. their properties. Uses the relative path of each file as key. type object additionalProperties $ref #/definitions/KiaraFile size title Size description The size of all files in this folder, combined. type integer metadata title Metadata description Additional, ustructured, user-defined metadata. type object metadata_schemas title Metadata Schemas description The metadata schemas for each metadata value (if available). type object additionalProperties type string required bundle_name number_of_files included_files size additionalProperties False definitions KiaraFile title KiaraFile description Describes properties for the 'file' value type. type object properties mime_type title Mime Type description The mime type of the file. type string file_name title File Name default The name of the file. type string size title Size description The size of the file. type integer metadata title Metadata description Additional, ustructured, user-defined metadata. type object metadata_schemas title Metadata Schemas description The metadata schemas for each of the metadata values (if available). type object additionalProperties type string required mime_type size additionalProperties False	The (json) schema for this model data.

info.kiara_model

type_name	info.kiara_model	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name KiaraModelTypeInfo The name of the Python class. python_module_name kiara.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.KiaraModelTypeInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title KiaraModelTypeInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel python_class title Python Class description The python class that implements this module type. allOf $ref #/definitions/PythonClass metadata_schema title Metadata Schema description The (json) schema for this model data. type object required type_name documentation authors context python_class metadata_schema additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False	The (json) schema for this model data.

info.data_type

type_name	info.data_type	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name DataTypeClassInfo The name of the Python class. python_module_name kiara.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.DataTypeClassInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title DataTypeClassInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel python_class title Python Class description The python class that implements this module type. allOf $ref #/definitions/PythonClass value_cls title Value Cls description The python class of the value itself. allOf $ref #/definitions/PythonClass data_type_config_cls title Data Type Config Cls description The python class holding the schema for configuring this type. allOf $ref #/definitions/PythonClass lineage title Lineage description This types lineage. type array items type string qualifier_profiles title Qualifier Profiles description A map of qualifier profiles for this data types. type object additionalProperties type object required type_name documentation authors context python_class value_cls data_type_config_cls additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False	The (json) schema for this model data.

info.kiara_module_type

type_name	info.kiara_module_type	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ModuleTypeInfo The name of the Python class. python_module_name kiara.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.ModuleTypeInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title ModuleTypeInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel python_class title Python Class description The python class that implements this module type. allOf $ref #/definitions/PythonClass module_src title Module Src description The source code of the process method of the module. type string required type_name documentation authors context python_class module_src additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False	The (json) schema for this model data.

info.operation_type

type_name	info.operation_type	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name OperationTypeInfo The name of the Python class. python_module_name kiara.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.OperationTypeInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title OperationTypeInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel python_class title Python Class description The python class that implements this module type. allOf $ref #/definitions/PythonClass required type_name documentation authors context python_class additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False	The (json) schema for this model data.

info.value

type_name	info.value	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ValueInfo The name of the Python class. python_module_name kiara.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.ValueInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title ValueInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel value_id title Value Id description The id of the value. type string format uuid kiara_id title Kiara Id description The id of the kiara context this value belongs to. type string format uuid value_schema title Value Schema description The schema that was used for this Value. allOf $ref #/definitions/ValueSchema value_status description The set/unset status of this value. allOf $ref #/definitions/ValueStatus value_size title Value Size description The size of this value, in bytes. type integer value_hash title Value Hash description The hash of this value. type string pedigree title Pedigree description Information about the module and inputs that went into creating this value. allOf $ref #/definitions/ValuePedigree pedigree_output_name title Pedigree Output Name description The output name that produced this value (using the manifest inside the pedigree). type string data_type_info title Data Type Info description Information about the underlying data type and it's configuration. allOf $ref #/definitions/DataTypeInfo aliases title Aliases description The aliases that are registered for this value. type array items type string serialized title Serialized description Details for the serialization process that was used for this value. allOf $ref #/definitions/PersistedData properties title Properties description Property data for this value. type object destiny_links title Destiny Links description References to all the values that act as destiny for this value in this context. type object additionalProperties type string format uuid environment_hashes title Environment Hashes description Hashes for the environments this value was created in. type object additionalProperties type object additionalProperties type string enviroments title Enviroments description Information about the environments this value was created in. type object additionalProperties type object property_links title Property Links description Links to values that are properties of this value. type object additionalProperties type string format uuid destiny_backlinks title Destiny Backlinks description Backlinks to values that this value acts as destiny/or property for. type object additionalProperties type string is_internal title Is Internal description Whether this value is only used internally in kiara. default False type boolean is_persisted title Is Persisted description Whether this value is stored in at least one data store. type boolean required type_name documentation authors context value_id kiara_id value_schema value_status value_size value_hash pedigree pedigree_output_name data_type_info environment_hashes is_persisted additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False ValueStatus title ValueStatus description An enumeration. enum unknown not set none default set ValuePedigree title ValuePedigree description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean inputs title Inputs description A map of all the input fields and value references. type object additionalProperties type string format uuid kiara_id title Kiara Id description The id of the kiara context a value was created in. type string format uuid environments title Environments description References to the runtime environment details a value was created in. type object additionalProperties type string required module_type inputs kiara_id environments additionalProperties False DataTypeCharacteristics title DataTypeCharacteristics type object properties is_scalar title Is Scalar description Whether the data desribed by this data type behaves like a skalar. default False type boolean is_json_serializable title Is Json Serializable description Whether the data can be serialized to json without information loss. default False type boolean PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False DataTypeInfo title DataTypeInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties data_type_name title Data Type Name description The registered name of this data type. type string data_type_config title Data Type Config description The (optional) configuration for this data type. type object characteristics title Characteristics description Characteristics of this data type. allOf $ref #/definitions/DataTypeCharacteristics data_type_class title Data Type Class description The python class that is associated with this model. allOf $ref #/definitions/PythonClass required data_type_name characteristics data_type_class additionalProperties False Manifest title Manifest description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean required module_type additionalProperties False SerializationMetadata title SerializationMetadata description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties environment title Environment description Hash(es) for the environments the value was created/serialized. type object additionalProperties type integer deserialize title Deserialize description Suggested manifest configs to use to de-serialize the data. type object additionalProperties $ref #/definitions/Manifest additionalProperties False SerializedChunkIDs title SerializedChunkIDs type object properties type title Type default chunk-ids enum chunk-ids type string chunk_id_list title Chunk Id List description A list of chunk ids, which will be resolved via the attached data registry. type array items type string archive_id title Archive Id description The preferred data archive to get the chunks from. type string format uuid size title Size description The size of all chunks combined. type integer required chunk_id_list size additionalProperties False PersistedData title PersistedData description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties data_type title Data Type description The name of the data type for this serialized value. type string data_type_config title Data Type Config description The (optional) config for the data type for this serialized value. type object serialization_profile title Serialization Profile description An identifying name for the serialization method used. type string metadata title Metadata description Optional metadata describing aspects of the serialization used. allOf $ref #/definitions/SerializationMetadata hash_codec title Hash Codec description The codec used to hash the value. default sha2-256 type string archive_id title Archive Id description The id of the store that persisted the data. type string format uuid chunk_id_map title Chunk Id Map description Reference-ids that resolve to the values' serialized chunks. type object additionalProperties $ref #/definitions/SerializedChunkIDs required data_type serialization_profile archive_id chunk_id_map additionalProperties False	The (json) schema for this model data.

info.pipeline_structure

type_name	info.pipeline_structure	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name PipelineStructureInfo The name of the Python class. python_module_name kiara.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.PipelineStructureInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title PipelineStructureInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel pipeline_config title Pipeline Config description The underlying pipeline config. allOf $ref #/definitions/PipelineConfig pipeline_config_orig title Pipeline Config Orig description The original, user-provided pipeline config. type object step_details title Step Details description Additional information for each step. type object additionalProperties $ref #/definitions/StepInfo input_aliases title Input Aliases description The input aliases. type object additionalProperties type string output_aliases title Output Aliases description The output aliases. type object additionalProperties type string constants title Constants description The input constants for this pipeline. type object defaults title Defaults description The default inputs for this pipeline. type object pipeline_input_fields title Pipeline Input Fields description The pipeline inputs schema. type object additionalProperties $ref #/definitions/FieldInfo pipeline_output_fields title Pipeline Output Fields description The pipeline outputs schema. type object additionalProperties $ref #/definitions/FieldInfo pipeline_input_refs title Pipeline Input Refs description References to the step inputs that are linked to pipeline inputs. type object additionalProperties $ref #/definitions/PipelineInputRef pipeline_output_refs title Pipeline Output Refs description References to the step outputs that are linked to pipeline outputs. type object additionalProperties $ref #/definitions/PipelineOutputRef execution_graph title Execution Graph description Data describing the execution graph of this pipeline. type object data_flow_graph title Data Flow Graph description Data describing the data flow of this pipeline. type object data_flow_graph_simple title Data Flow Graph Simple description Data describing the (simplified) data flow of this pipeline. type object processing_stages title Processing Stages description A list of lists, containing all the step_ids per stage, in the order of execution. type array items type array items type string required type_name documentation authors context pipeline_config pipeline_config_orig step_details input_aliases output_aliases constants defaults pipeline_input_fields pipeline_output_fields pipeline_input_refs pipeline_output_refs execution_graph data_flow_graph data_flow_graph_simple processing_stages additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string Manifest title Manifest description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean required module_type additionalProperties False StepValueAddress title StepValueAddress description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. type object properties step_id title Step Id description The id of a step within a pipeline. type string value_name title Value Name description The name of the value (output name or pipeline input name). type string sub_value title Sub Value description A reference to a subitem of a value (e.g. column, list item) type object required step_id value_name additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False KiaraModuleInstance title KiaraModuleInstance description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string module_config title Module Config description The module config. type object inputs_schema title Inputs Schema description The schema for the module input(s). type object additionalProperties $ref #/definitions/ValueSchema outputs_schema title Outputs Schema description The schema for the module output(s). type object additionalProperties $ref #/definitions/ValueSchema required python_class_name python_module_name full_name module_config inputs_schema outputs_schema additionalProperties False PipelineStep title PipelineStep description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The module config. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean step_id title Step Id description Locally unique id (within a pipeline) of this step. type string manifest_src title Manifest Src description The original manfifest provided by the user. allOf $ref #/definitions/Manifest input_links title Input Links description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. type object additionalProperties type array items $ref #/definitions/StepValueAddress module_details title Module Details description The class of the underlying module. allOf $ref #/definitions/KiaraModuleInstance doc title Doc description A description what this step does. allOf $ref #/definitions/DocumentationMetadataModel required module_type step_id manifest_src module_details doc additionalProperties False PipelineConfig title PipelineConfig description A class to hold the configuration for a [PipelineModule][kiara.pipeline.module.PipelineModule]. If you want to control the pipeline input and output names, you need to have to provide a map that uses the autogenerated field name ([step_id]__[alias] -- 2 underscores!!) as key, and the desired field name as value. The reason that schema for the autogenerated field names exist is that it's hard to ensure the uniqueness of each field; some steps can have the same input field names, but will need different input values. In some cases, some inputs of different steps need the same input. Those sorts of things. So, to make sure that we always use the right values, I chose to implement a conservative default approach, accepting that in some cases the user will be prompted for duplicate inputs for the same value. To remedy that, the pipeline creator has the option to manually specify a mapping to rename some or all of the input/output fields. Further, because in a lot of cases there won't be any overlapping fields, the creator can specify ``auto``, in which case *Kiara* will automatically create a mapping that tries to map autogenerated field names to the shortest possible names for each case. Examples: -------- Configuration for a pipeline module that functions as a ``nand`` logic gate (in Python): ``` python and_step = PipelineStepConfig(module_type="and", step_id="and") not_step = PipelineStepConfig(module_type="not", step_id="not", input_links={"a": ["and.y"]} nand_p_conf = PipelineConfig(doc="Returns 'False' if both inputs are 'True'.", steps=[and_step, not_step], input_aliases={ "and.a": "a", "and.b": "b" }, output_aliases={ "not.y": "y" }} ``` Or, the same thing in json: ``` json { "module_type_name": "nand", "doc": "Returns 'False' if both inputs are 'True'.", "steps": [ { "module_type": "and", "step_id": "and" }, { "module_type": "not", "step_id": "not", "input_links": { "a": "and.y" } } ], "input_aliases": { "and.a": "a", "and.b": "b" }, "output_aliases": { "not.y": "y" } } ``` type object properties constants title Constants description Value constants for this module. type object defaults title Defaults description Value defaults for this module. type object pipeline_name title Pipeline Name description The name of this pipeline. type string steps title Steps description A list of steps/modules of this pipeline, and their connections. type array items $ref #/definitions/PipelineStep input_aliases title Input Aliases description A map of input aliases, with the location of the input (in the format '[step_id].[input_field]') as key, and the pipeline input field name as value. type object additionalProperties type string output_aliases title Output Aliases description A map of output aliases, with the location of the output (in the format '[step_id].[output_field]') as key, and the pipeline output field name as value. type object additionalProperties type string doc title Doc description Documentation about what the pipeline does. default -- n/a -- allOf $ref #/definitions/DocumentationMetadataModel context title Context description Metadata for this workflow. type object required pipeline_name steps input_aliases output_aliases StepInputRef title StepInputRef description An input to a step. This object can either have a 'connected_outputs' set, or a 'connected_pipeline_input', not both. type object properties value_name title Value Name type string value_schema $ref #/definitions/ValueSchema step_id title Step Id description The step id. type string connected_outputs title Connected Outputs description A potential connected list of one or several module outputs. type array items $ref #/definitions/StepValueAddress connected_pipeline_input title Connected Pipeline Input description A potential pipeline input. type string is_constant title Is Constant description Whether this input is a constant and can't be changed by the user. type boolean required value_name value_schema step_id is_constant additionalProperties False StepOutputRef title StepOutputRef description An output to a step. type object properties value_name title Value Name type string value_schema $ref #/definitions/ValueSchema step_id title Step Id description The step id. type string pipeline_output title Pipeline Output description The connected pipeline output. type string connected_inputs title Connected Inputs description The step inputs that are connected to this step output type array items $ref #/definitions/StepValueAddress required value_name value_schema step_id additionalProperties False StepInfo title StepInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties step title Step description The pipeline step object. allOf $ref #/definitions/PipelineStep inputs title Inputs description Reference(s) to the fields that feed this steps inputs. type object additionalProperties $ref #/definitions/StepInputRef outputs title Outputs description Reference(s) to the fields that are fed by this steps outputs. type object additionalProperties $ref #/definitions/StepOutputRef required title Required description Whether this step is always required or whether all his outputs feed into optional input fields. type boolean doc title Doc description The step documentation. allOf $ref #/definitions/DocumentationMetadataModel required step inputs outputs required additionalProperties False DataTypeCharacteristics title DataTypeCharacteristics type object properties is_scalar title Is Scalar description Whether the data desribed by this data type behaves like a skalar. default False type boolean is_json_serializable title Is Json Serializable description Whether the data can be serialized to json without information loss. default False type boolean PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False DataTypeInfo title DataTypeInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties data_type_name title Data Type Name description The registered name of this data type. type string data_type_config title Data Type Config description The (optional) configuration for this data type. type object characteristics title Characteristics description Characteristics of this data type. allOf $ref #/definitions/DataTypeCharacteristics data_type_class title Data Type Class description The python class that is associated with this model. allOf $ref #/definitions/PythonClass required data_type_name characteristics data_type_class additionalProperties False FieldInfo title FieldInfo type object properties field_name title Field Name description The field name. type string field_schema title Field Schema description The schema of the field. allOf $ref #/definitions/ValueSchema data_type_info title Data Type Info description Information about the data type instance of the associated value. allOf $ref #/definitions/DataTypeInfo value_required title Value Required description Whether user input is required (meaning: 'optional' is False, and no default set). type boolean required field_name field_schema data_type_info value_required PipelineInputRef title PipelineInputRef description An input to a pipeline. type object properties value_name title Value Name type string value_schema $ref #/definitions/ValueSchema connected_inputs title Connected Inputs description The step inputs that are connected to this pipeline input type array items $ref #/definitions/StepValueAddress is_constant title Is Constant description Whether this input is a constant and can't be changed by the user. type boolean required value_name value_schema is_constant additionalProperties False PipelineOutputRef title PipelineOutputRef description An output to a pipeline. type object properties value_name title Value Name type string value_schema $ref #/definitions/ValueSchema connected_output title Connected Output description Connected step outputs. allOf $ref #/definitions/StepValueAddress required value_name value_schema connected_output additionalProperties False	The (json) schema for this model data.

info.operation

type_name	info.operation	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name OperationInfo The name of the Python class. python_module_name kiara.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.OperationInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title OperationInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel operation title Operation description The operation instance. allOf $ref #/definitions/Operation operation_types title Operation Types description The operation types this operation belongs to. type array items type string input_fields title Input Fields description The inputs schema for this operation. type object additionalProperties $ref #/definitions/FieldInfo output_fields title Output Fields description The outputs schema for this operation. type object additionalProperties $ref #/definitions/FieldInfo required type_name documentation authors context operation operation_types input_fields output_fields additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string OperationDetails title OperationDetails description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties operation_id title Operation Id description The id of the operation. type string is_internal_operation title Is Internal Operation description Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). default False type boolean required operation_id additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False KiaraModuleInstance title KiaraModuleInstance description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string module_config title Module Config description The module config. type object inputs_schema title Inputs Schema description The schema for the module input(s). type object additionalProperties $ref #/definitions/ValueSchema outputs_schema title Outputs Schema description The schema for the module output(s). type object additionalProperties $ref #/definitions/ValueSchema required python_class_name python_module_name full_name module_config inputs_schema outputs_schema additionalProperties False Operation title Operation description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean operation_id title Operation Id description The (unique) id of this operation. type string operation_details title Operation Details description The operation specific details of this operation. allOf $ref #/definitions/OperationDetails doc title Doc description Documentation for this operation. allOf $ref #/definitions/DocumentationMetadataModel module_details title Module Details description The class of the underlying module. allOf $ref #/definitions/KiaraModuleInstance metadata title Metadata description Additional metadata for this operation. type object required module_type operation_id operation_details doc module_details additionalProperties False DataTypeCharacteristics title DataTypeCharacteristics type object properties is_scalar title Is Scalar description Whether the data desribed by this data type behaves like a skalar. default False type boolean is_json_serializable title Is Json Serializable description Whether the data can be serialized to json without information loss. default False type boolean PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False DataTypeInfo title DataTypeInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties data_type_name title Data Type Name description The registered name of this data type. type string data_type_config title Data Type Config description The (optional) configuration for this data type. type object characteristics title Characteristics description Characteristics of this data type. allOf $ref #/definitions/DataTypeCharacteristics data_type_class title Data Type Class description The python class that is associated with this model. allOf $ref #/definitions/PythonClass required data_type_name characteristics data_type_class additionalProperties False FieldInfo title FieldInfo type object properties field_name title Field Name description The field name. type string field_schema title Field Schema description The schema of the field. allOf $ref #/definitions/ValueSchema data_type_info title Data Type Info description Information about the data type instance of the associated value. allOf $ref #/definitions/DataTypeInfo value_required title Value Required description Whether user input is required (meaning: 'optional' is False, and no default set). type boolean required field_name field_schema data_type_info value_required	The (json) schema for this model data.

renderer_info

type_name	renderer_info	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name RendererInfo The name of the Python class. python_module_name kiara.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.RendererInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title RendererInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel renderer_config title Renderer Config description The renderer config. type object renderer_cls title Renderer Cls description The Python class that implements the renderer. allOf $ref #/definitions/PythonClass supported_inputs title Supported Inputs description Descriptions of the supported inputs. type array items type string supported_source_types title Supported Source Types description Descriptions of the supported source types. type array items type string supported_target_types title Supported Target Types description Descriptions of the supported target types. type array items type string supported_python_classes title Supported Python Classes description A list of supported Python types that are acceptable as inputs. type array items $ref #/definitions/PythonClass required type_name documentation authors context renderer_config renderer_cls supported_inputs supported_source_types supported_target_types supported_python_classes additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False	The (json) schema for this model data.

info.kiara_models

type_name	info.kiara_models	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name KiaraModelClassesInfo The name of the Python class. python_module_name kiara.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.KiaraModelClassesInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title KiaraModelClassesInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties group_title title Group Title description The group alias. type string item_infos title Item Infos description The value metadata info instances for each type. type object additionalProperties $ref #/definitions/KiaraModelTypeInfo type_name title Type Name default kiara_model enum kiara_model type string required item_infos additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False KiaraModelTypeInfo title KiaraModelTypeInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel python_class title Python Class description The python class that implements this module type. allOf $ref #/definitions/PythonClass metadata_schema title Metadata Schema description The (json) schema for this model data. type object required type_name documentation authors context python_class metadata_schema additionalProperties False	The (json) schema for this model data.

info.data_types

type_name	info.data_types	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name DataTypeClassesInfo The name of the Python class. python_module_name kiara.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.DataTypeClassesInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title DataTypeClassesInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties group_title title Group Title description The group alias. type string item_infos title Item Infos description The data_type info instances for each type. type object additionalProperties $ref #/definitions/DataTypeClassInfo type_name title Type Name default data_type enum data_type type string required item_infos additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False DataTypeClassInfo title DataTypeClassInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel python_class title Python Class description The python class that implements this module type. allOf $ref #/definitions/PythonClass value_cls title Value Cls description The python class of the value itself. allOf $ref #/definitions/PythonClass data_type_config_cls title Data Type Config Cls description The python class holding the schema for configuring this type. allOf $ref #/definitions/PythonClass lineage title Lineage description This types lineage. type array items type string qualifier_profiles title Qualifier Profiles description A map of qualifier profiles for this data types. type object additionalProperties type object required type_name documentation authors context python_class value_cls data_type_config_cls additionalProperties False	The (json) schema for this model data.

info.module_types

type_name	info.module_types	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ModuleTypesInfo The name of the Python class. python_module_name kiara.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.ModuleTypesInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title ModuleTypesInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties group_title title Group Title description The group alias. type string item_infos title Item Infos description The module type info instances for each type. type object additionalProperties $ref #/definitions/ModuleTypeInfo type_name title Type Name default module_type enum module_type type string required item_infos additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False ModuleTypeInfo title ModuleTypeInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel python_class title Python Class description The python class that implements this module type. allOf $ref #/definitions/PythonClass module_src title Module Src description The source code of the process method of the module. type string required type_name documentation authors context python_class module_src additionalProperties False	The (json) schema for this model data.

info.operation_types

type_name	info.operation_types	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name OperationTypeClassesInfo The name of the Python class. python_module_name kiara.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.OperationTypeClassesInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title OperationTypeClassesInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties group_title title Group Title description The group alias. type string item_infos title Item Infos description The operation info instances for each type. type object additionalProperties $ref #/definitions/OperationTypeInfo type_name title Type Name default operation_type enum operation_type type string required item_infos additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False OperationTypeInfo title OperationTypeInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel python_class title Python Class description The python class that implements this module type. allOf $ref #/definitions/PythonClass required type_name documentation authors context python_class additionalProperties False	The (json) schema for this model data.

values_info

type_name	values_info	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name ValuesInfo The name of the Python class. python_module_name kiara.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.ValuesInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title ValuesInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties group_title title Group Title description The group alias. type string item_infos title Item Infos description The info items. type object additionalProperties $ref #/definitions/ItemInfo required item_infos additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string ItemInfo title ItemInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel required type_name documentation authors context additionalProperties False	The (json) schema for this model data.

info.operations

type_name	info.operations	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name OperationGroupInfo The name of the Python class. python_module_name kiara.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.OperationGroupInfo The full class namespace.	The python class that implements this module type.
metadata_schema	title OperationGroupInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties group_title title Group Title description The group alias. type string item_infos title Item Infos description The operation info instances for each type. type object additionalProperties $ref #/definitions/OperationInfo required item_infos additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string OperationDetails title OperationDetails description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties operation_id title Operation Id description The id of the operation. type string is_internal_operation title Is Internal Operation description Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). default False type boolean required operation_id additionalProperties False ValueSchema title ValueSchema description The schema of a value. The schema contains the [ValueTypeOrm][kiara.data.values.ValueTypeOrm] of a value, as well as an optional default that will be used if no user input was given (yet) for a value. For more complex container data_types like array, tables, unions etc, data_types can also be configured with values from the ``type_config`` field. type object properties type title Type description The type of the value. type string type_config title Type Config description Configuration for the type, in case it's complex. type object default title Default description A default value. default __not_set__ optional title Optional description Whether this value is required (True), or whether 'None' value is allowed (False). default False type boolean is_constant title Is Constant description Whether the value is a constant. default False type boolean doc title Doc description A description for the value of this input field. allOf $ref #/definitions/DocumentationMetadataModel required type additionalProperties False KiaraModuleInstance title KiaraModuleInstance description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string module_config title Module Config description The module config. type object inputs_schema title Inputs Schema description The schema for the module input(s). type object additionalProperties $ref #/definitions/ValueSchema outputs_schema title Outputs Schema description The schema for the module output(s). type object additionalProperties $ref #/definitions/ValueSchema required python_class_name python_module_name full_name module_config inputs_schema outputs_schema additionalProperties False Operation title Operation description A class to hold the type and configuration for a module instance. type object properties module_type title Module Type description The module type. type string module_config title Module Config description The configuration for the module. type object is_resolved title Is Resolved description Whether the configuration of this module was augmented with the module type defaults etc. default False type boolean operation_id title Operation Id description The (unique) id of this operation. type string operation_details title Operation Details description The operation specific details of this operation. allOf $ref #/definitions/OperationDetails doc title Doc description Documentation for this operation. allOf $ref #/definitions/DocumentationMetadataModel module_details title Module Details description The class of the underlying module. allOf $ref #/definitions/KiaraModuleInstance metadata title Metadata description Additional metadata for this operation. type object required module_type operation_id operation_details doc module_details additionalProperties False DataTypeCharacteristics title DataTypeCharacteristics type object properties is_scalar title Is Scalar description Whether the data desribed by this data type behaves like a skalar. default False type boolean is_json_serializable title Is Json Serializable description Whether the data can be serialized to json without information loss. default False type boolean PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False DataTypeInfo title DataTypeInfo description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties data_type_name title Data Type Name description The registered name of this data type. type string data_type_config title Data Type Config description The (optional) configuration for this data type. type object characteristics title Characteristics description Characteristics of this data type. allOf $ref #/definitions/DataTypeCharacteristics data_type_class title Data Type Class description The python class that is associated with this model. allOf $ref #/definitions/PythonClass required data_type_name characteristics data_type_class additionalProperties False FieldInfo title FieldInfo type object properties field_name title Field Name description The field name. type string field_schema title Field Schema description The schema of the field. allOf $ref #/definitions/ValueSchema data_type_info title Data Type Info description Information about the data type instance of the associated value. allOf $ref #/definitions/DataTypeInfo value_required title Value Required description Whether user input is required (meaning: 'optional' is False, and no default set). type boolean required field_name field_schema data_type_info value_required OperationInfo title OperationInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel operation title Operation description The operation instance. allOf $ref #/definitions/Operation operation_types title Operation Types description The operation types this operation belongs to. type array items type string input_fields title Input Fields description The inputs schema for this operation. type object additionalProperties $ref #/definitions/FieldInfo output_fields title Output Fields description The outputs schema for this operation. type object additionalProperties $ref #/definitions/FieldInfo required type_name documentation authors context operation operation_types input_fields output_fields additionalProperties False	The (json) schema for this model data.

renderer_infos

type_name	renderer_infos	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name RendererInfos The name of the Python class. python_module_name kiara.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.RendererInfos The full class namespace.	The python class that implements this module type.
metadata_schema	title RendererInfos description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties group_title title Group Title description The group alias. type string item_infos title Item Infos description The info items. type object additionalProperties $ref #/definitions/ItemInfo required item_infos additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False AuthorModel title Author description Details about an author of a resource. type object properties name title Name description The full name of the author. type string email title Email description The email address of the author type string format email required name AuthorsMetadataModel title Authors description Information about all authors of a resource. type object properties authors title Authors description The authors/creators of this item. type array items $ref #/definitions/AuthorModel LinkModel title Link description A description and url for a reference of any kind. type object properties url title Url description The url. minLength 1 maxLength 65536 format uri type string desc title Desc description A short description of the link content. default -- n/a -- type string required url ContextMetadataModel title Context description Information about the context of a resource. type object properties references title References description References for the item. type object additionalProperties $ref #/definitions/LinkModel tags title Tags description A list of tags for the item. type array items type string labels title Labels description A list of labels for the item. type object additionalProperties type string ItemInfo title ItemInfo description Base class that holds/manages information about an item within kiara. type object properties type_name title Type Name description The registered name for this item type. type string documentation title Documentation description Documentation for the item. allOf $ref #/definitions/DocumentationMetadataModel authors title Authors description Information about authorship for the item. allOf $ref #/definitions/AuthorsMetadataModel context title Context description Generic properties of this item (description, tags, labels, references, ...). allOf $ref #/definitions/ContextMetadataModel required type_name documentation authors context additionalProperties False	The (json) schema for this model data.

metadata.module_config

type_name	metadata.module_config	The registered name for this item type.
documentation	description -- n/a -- Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name KiaraModuleConfigMetadata The name of the Python class. python_module_name kiara.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.KiaraModuleConfigMetadata The full class namespace.	The python class that implements this module type.
metadata_schema	title KiaraModuleConfigMetadata description Base class that all models in kiara inherit from. This class provides utility functions for things like rendering the model on terminal or as html, integration into a tree hierarchy of the overall kiara context, hashing, etc. type object properties python_class title Python Class description The config model python class. allOf $ref #/definitions/PythonClass config_values title Config Values description The available configuration values. type object additionalProperties $ref #/definitions/ValueTypeAndDescription required python_class config_values additionalProperties False definitions PythonClass title PythonClass description Python class and module information. type object properties python_class_name title Python Class Name description The name of the Python class. type string python_module_name title Python Module Name description The name of the Python module this class lives in. type string full_name title Full Name description The full class namespace. type string required python_class_name python_module_name full_name additionalProperties False ValueTypeAndDescription title ValueTypeAndDescription type object properties description title Description description The description for the value. type string type title Type description The value type. type string value_default title Value Default description Default for the value. required title Required description Whether this value is required type boolean required description type required	The (json) schema for this model data.

instance.job_desc

type_name	instance.job_desc	The registered name for this item type.
documentation	description An object describing a compute job with both raw or referenced inputs. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name JobDesc The name of the Python class. python_module_name kiara.interfaces.python_api.models.job The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.job.JobDesc The full class namespace.	The python class that implements this module type.
metadata_schema	title JobDesc description An object describing a compute job with both raw or referenced inputs. type object properties job_alias title Job Alias description The alias for the job. default default type string operation title Operation description The operation id or module type. type string module_config title Module Config description The configuration for the module. type object inputs title Inputs description The inputs for the job. type object doc title Doc description A description/doc for this job. allOf $ref #/definitions/DocumentationMetadataModel save title Save description Configuration on how/whether to save the job results. type object additionalProperties type string required operation additionalProperties False definitions DocumentationMetadataModel title Documentation description Documentation about a resource. type object properties description title Description description Short description of the item. default -- n/a -- type string doc title Doc description Detailed documentation of the item (in markdown). type string additionalProperties False	The (json) schema for this model data.

workflow_matcher

type_name	workflow_matcher	The registered name for this item type.
documentation	description An object describing requirements values should satisfy in order to be included in a query result. Short description of the item. doc None Detailed documentation of the item (in markdown).	Documentation for the item.
authors	authors name Markus Binsteiner The full name of the author. email markus@frkl.io The email address of the author The authors/creators of this item.	Information about authorship for the item.
context	references source_repo url https://github.com/DHARPA-Project/kiara The url. desc The kiara project git repository. A short description of the link content. documentation url https://dharpa.org/kiara_documentation/ The url. desc The url for kiara documentation. A short description of the link content. References for the item. tags A list of tags for the item. labels package kiara A list of labels for the item.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name WorkflowMatcher The name of the Python class. python_module_name kiara.interfaces.python_api.models.workflow The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.workflow.WorkflowMatcher The full class namespace.	The python class that implements this module type.
metadata_schema	title WorkflowMatcher description An object describing requirements values should satisfy in order to be included in a query result. type object properties has_alias title Has Alias description Workflow must have at least one alias. default False type boolean additionalProperties False	The (json) schema for this model data.