metadata.authors

type_name	metadata.authors	The registered name for this item type.
documentation	Information about all authors of a resource.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object	The (json) schema for this model data.

metadata.context

type_name	metadata.context	The registered name for this item type.
documentation	Information about the context of a resource.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object	The (json) schema for this model data.

metadata.documentation

type_name	metadata.documentation	The registered name for this item type.
documentation	Documentation about a resource.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object	The (json) schema for this model data.

instance.value_schema

type_name	instance.value_schema	The registered name for this item type.
documentation	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.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object	The (json) schema for this model data.

instance.module_config

type_name	instance.module_config	The registered name for this item type.
documentation	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.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	additionalProperties False 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. properties constants additionalProperties True description Value constants for this module. title Constants type object defaults additionalProperties True description Value defaults for this module. title Defaults type object title KiaraModuleConfig type object	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	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" } } ```	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object PipelineStep additionalProperties False description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The module config. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean step_id description Locally unique id (within a pipeline) of this step. title Step Id type string manifest_src $ref #/$defs/Manifest description The original manfifest provided by the user. input_links additionalProperties items $ref #/$defs/StepValueAddress type array description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. title Input Links type object module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. doc $ref #/$defs/DocumentationMetadataModel description A description what this step does. required module_type step_id manifest_src module_details doc title PipelineStep type object StepValueAddress additionalProperties False description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. properties step_id description The id of a step within a pipeline. title Step Id type string value_name description The name of the value (output name or pipeline input name). title Value Name type string sub_value anyOf additionalProperties True type object type null default None description A reference to a subitem of a value (e.g. column, list item) title Sub Value required step_id value_name title StepValueAddress type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object 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" } } ``` properties constants additionalProperties True description Value constants for this module. title Constants type object defaults additionalProperties True description Value defaults for this module. title Defaults type object pipeline_name description The name of this pipeline. title Pipeline Name type string steps description A list of steps/modules of this pipeline, and their connections. items $ref #/$defs/PipelineStep title Steps type array input_aliases additionalProperties type string 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. title Input Aliases type object output_aliases additionalProperties type string 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. title Output Aliases type object doc $ref #/$defs/DocumentationMetadataModel default -- n/a -- description Documentation about what the pipeline does. context additionalProperties True description Metadata for this workflow. title Context type object required pipeline_name steps input_aliases output_aliases title PipelineConfig type object	The (json) schema for this model data.

instance.manifest

type_name	instance.manifest	The registered name for this item type.
documentation	A class to hold the type and configuration for a module instance.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object	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	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean inputs additionalProperties format uuid type string description A map of all the input fields and value references. title Inputs type object required module_type inputs title InputsManifest type object	The (json) schema for this model data.

instance.job_config

type_name	instance.job_config	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs PipelineMetadata properties pipeline_id description The id of the pipeline. format uuid title Pipeline Id type string step_id description The id of the step in the pipeline. title Step Id type string required pipeline_id step_id title PipelineMetadata type object additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean inputs additionalProperties format uuid type string description A map of all the input fields and value references. title Inputs type object pipeline_metadata anyOf $ref #/$defs/PipelineMetadata type null default None description Metadata for the pipeline this job is part of. required module_type inputs title JobConfig type object	The (json) schema for this model data.

instance.job_record

type_name	instance.job_record	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs JobLog properties log description The logs for this job. items $ref #/$defs/LogMessage title Log type array percent_finished default -1 description Describes how much of the job is finished. A negative number means the module does not support progress tracking. title Percent Finished type integer title JobLog type object JobRuntimeDetails properties job_log $ref #/$defs/JobLog description The lob jog. submitted description When the job was submitted. format date-time title Submitted type string started description When the job was started. format date-time title Started type string finished description When the job was finished. format date-time title Finished type string runtime description The duration of the job (in seconds). title Runtime type number required job_log submitted started finished runtime title JobRuntimeDetails type object LogMessage properties timestamp description The time the message was logged. format date-time title Timestamp type string log_level description The log level. title Log Level type integer msg description The log message title Msg type string required log_level msg title LogMessage type object PipelineMetadata properties pipeline_id description The id of the pipeline. format uuid title Pipeline Id type string step_id description The id of the step in the pipeline. title Step Id type string required pipeline_id step_id title PipelineMetadata type object additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean inputs additionalProperties format uuid type string description A map of all the input fields and value references. title Inputs type object pipeline_metadata anyOf $ref #/$defs/PipelineMetadata type null default None description Metadata for the pipeline this job is part of. job_id description The globally unique id for this job. format uuid title Job Id type string job_submitted description When the job was submitted. format date-time title Job Submitted type string environment_hashes additionalProperties type string description Hashes for the environments this value was created in. title Environment Hashes type object is_internal description Whether this job was created by the system. title Is Internal type boolean inputs_data_hash description A map of the hashes of this jobs inputs (the hashes of field names and the actual bytes). title Inputs Data Hash type string outputs additionalProperties format uuid type string description References to the job outputs. title Outputs type object runtime_details anyOf $ref #/$defs/JobRuntimeDetails type null description Runtime details for the job. required module_type inputs job_id job_submitted environment_hashes is_internal inputs_data_hash outputs runtime_details title JobRecord type object	The (json) schema for this model data.

instance.value_pedigree

type_name	instance.value_pedigree	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean inputs additionalProperties format uuid type string description A map of all the input fields and value references. title Inputs type object kiara_id description The id of the kiara context a value was created in. format uuid title Kiara Id type string environments additionalProperties type string description References to the runtime environment details a value was created in. title Environments type object required module_type inputs kiara_id environments title ValuePedigree type object	The (json) schema for this model data.

instance.pipeline_step

type_name	instance.pipeline_step	The registered name for this item type.
documentation	A step within a pipeline-structure, includes information about it's connection(s) and other metadata.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object StepValueAddress additionalProperties False description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. properties step_id description The id of a step within a pipeline. title Step Id type string value_name description The name of the value (output name or pipeline input name). title Value Name type string sub_value anyOf additionalProperties True type object type null default None description A reference to a subitem of a value (e.g. column, list item) title Sub Value required step_id value_name title StepValueAddress type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object additionalProperties False description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The module config. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean step_id description Locally unique id (within a pipeline) of this step. title Step Id type string manifest_src $ref #/$defs/Manifest description The original manfifest provided by the user. input_links additionalProperties items $ref #/$defs/StepValueAddress type array description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. title Input Links type object module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. doc $ref #/$defs/DocumentationMetadataModel description A description what this step does. required module_type step_id manifest_src module_details doc title PipelineStep type object	The (json) schema for this model data.

instance.operation

type_name	instance.operation	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object OperationDetails additionalProperties False properties operation_id description The id of the operation. title Operation Id type string is_internal_operation default False description Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). title Is Internal Operation type boolean required operation_id title OperationDetails type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean operation_id description The (unique) id of this operation. title Operation Id type string operation_details $ref #/$defs/OperationDetails description The operation specific details of this operation. doc $ref #/$defs/DocumentationMetadataModel description Documentation for this operation. module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. metadata additionalProperties True description Additional metadata for this operation. title Metadata type object required module_type operation_id operation_details doc module_details title Operation type object	The (json) schema for this model data.

instance.destiny

type_name	instance.destiny	The registered name for this item type.
documentation	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.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object additionalProperties False 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. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean destiny_id description The id of this destiny. format uuid title Destiny Id type string destiny_alias description The path to (the) destiny. title Destiny Alias type string module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. fixed_inputs additionalProperties format uuid type string description Inputs that are known in advance. title Fixed Inputs type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schemas of all deferred input fields. title Inputs Schema type object deferred_inputs additionalProperties anyOf format uuid type string type null description Potentially required external inputs that are needed for this destiny to materialize. title Deferred Inputs type object result_field_name description The name of the result field. title Result Field Name type string result_schema $ref #/$defs/ValueSchema description The value schema of the result. result_value_id anyOf format uuid type string type null description The value id of the result. title Result Value Id required module_type destiny_id destiny_alias module_details fixed_inputs inputs_schema deferred_inputs result_field_name result_schema result_value_id title Destiny type object	The (json) schema for this model data.

instance.execution_context

type_name	instance.execution_context	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	additionalProperties False properties working_dir description The path of the working directory. title Working Dir type string pipeline_dir anyOf type string type null default None description The path of the pipeline file that is being executed (if applicable). title Pipeline Dir title ExecutionContext type object	The (json) schema for this model data.

instance.active_job

type_name	instance.active_job	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs JobConfig additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean inputs additionalProperties format uuid type string description A map of all the input fields and value references. title Inputs type object pipeline_metadata anyOf $ref #/$defs/PipelineMetadata type null default None description Metadata for the pipeline this job is part of. required module_type inputs title JobConfig type object JobLog properties log description The logs for this job. items $ref #/$defs/LogMessage title Log type array percent_finished default -1 description Describes how much of the job is finished. A negative number means the module does not support progress tracking. title Percent Finished type integer title JobLog type object JobStatus enum __job_created__ __job_started__ __job_success__ __job_failed__ title JobStatus type string LogMessage properties timestamp description The time the message was logged. format date-time title Timestamp type string log_level description The log level. title Log Level type integer msg description The log message title Msg type string required log_level msg title LogMessage type object PipelineMetadata properties pipeline_id description The id of the pipeline. format uuid title Pipeline Id type string step_id description The id of the step in the pipeline. title Step Id type string required pipeline_id step_id title PipelineMetadata type object additionalProperties False properties job_id description The job id. format uuid title Job Id type string job_config $ref #/$defs/JobConfig description The job details. status $ref #/$defs/JobStatus default __job_created__ description The current status of the job. job_log $ref #/$defs/JobLog description The lob jog. submitted description When the job was submitted. format date-time title Submitted type string started anyOf format date-time type string type null default None description When the job was started. title Started finished anyOf format date-time type string type null default None description When the job was finished. title Finished results anyOf additionalProperties format uuid type string type object type null default None description The result(s). title Results error anyOf type string type null default None description Potential error message. title Error required job_id job_config job_log title ActiveJob type object	The (json) schema for this model data.

job_matcher

type_name	job_matcher	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name JobMatcher 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.JobMatcher The full class namespace.	The python class that implements this module type.
metadata_schema	additionalProperties False properties job_ids description A list of job ids, if specified, only jobs with one of these ids will be included. items format uuid type string title Job Ids type array allow_internal default False description Allow internal jobs. title Allow Internal type boolean earliest anyOf format date-time type string type null default None description The earliest time when the job was created. title Earliest latest anyOf format date-time type string type null default None description The latest time when the job was created. title Latest operation_inputs description A list of value ids, if specified, only jobs that use one of them will be included. items format uuid type string title Operation Inputs type array produced_outputs description A list of value ids, if specified, only jobs that produced one of them will be included. items format uuid type string title Produced Outputs type array title JobMatcher type object	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	Python class and module information.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object	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	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object	The (json) schema for this model data.

metadata.serialized_data

type_name	metadata.serialized_data	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object additionalProperties False properties environment additionalProperties type integer description Hash(es) for the environments the value was created/serialized. title Environment type object deserialize additionalProperties $ref #/$defs/Manifest description Suggested manifest configs to use to de-serialize the data. title Deserialize type object title SerializationMetadata type object	The (json) schema for this model data.

instance.serialization_result

type_name	instance.serialization_result	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object SerializationMetadata additionalProperties False properties environment additionalProperties type integer description Hash(es) for the environments the value was created/serialized. title Environment type object deserialize additionalProperties $ref #/$defs/Manifest description Suggested manifest configs to use to de-serialize the data. title Deserialize type object title SerializationMetadata type object SerializedBytes additionalProperties False properties codec description The codec used to encode the chunks in this model. Using the [multicodecs](https://github.com/multiformats/multicodec) codec table. title Codec type string type const chunk default chunk title Type type string chunk description A byte-array format binary title Chunk type string required codec chunk title SerializedBytes type object SerializedFile additionalProperties False properties codec description The codec used to encode the chunks in this model. Using the [multicodecs](https://github.com/multiformats/multicodec) codec table. title Codec type string type const file default file title Type type string file description A path to a file containing the serialized data. title File type string required codec file title SerializedFile type object SerializedFiles additionalProperties False properties codec description The codec used to encode the chunks in this model. Using the [multicodecs](https://github.com/multiformats/multicodec) codec table. title Codec type string type const files default files title Type type string files description A list of strings, pointing to files containing parts of the serialized data. items type string title Files type array required codec files title SerializedFiles type object SerializedInlineJson additionalProperties False properties codec description The codec used to encode the chunks in this model. Using the [multicodecs](https://github.com/multiformats/multicodec) codec table. title Codec type string type const inline-json default inline-json title Type type string inline_data default None 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.). title Inline Data required codec title SerializedInlineJson type object SerializedListOfBytes additionalProperties False properties codec description The codec used to encode the chunks in this model. Using the [multicodecs](https://github.com/multiformats/multicodec) codec table. title Codec type string type const chunks default chunks title Type type string chunks description A list of byte arrays. items format binary type string title Chunks type array required codec chunks title SerializedListOfBytes type object additionalProperties False properties data_type description The name of the data type for this serialized value. title Data Type type string data_type_config additionalProperties True description The (optional) config for the data type for this serialized value. title Data Type Config type object serialization_profile description An identifying name for the serialization method used. title Serialization Profile type string metadata $ref #/$defs/SerializationMetadata description Optional metadata describing aspects of the serialization used. hash_codec default sha2-256 description The codec used to hash the value. title Hash Codec type string data additionalProperties anyOf $ref #/$defs/SerializedBytes $ref #/$defs/SerializedListOfBytes $ref #/$defs/SerializedFile $ref #/$defs/SerializedFiles $ref #/$defs/SerializedInlineJson description One or several byte arrays representing the serialized state of the value. title Data type object required data_type serialization_profile data title SerializationResult type object	The (json) schema for this model data.

instance.persisted_data

type_name	instance.persisted_data	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object SerializationMetadata additionalProperties False properties environment additionalProperties type integer description Hash(es) for the environments the value was created/serialized. title Environment type object deserialize additionalProperties $ref #/$defs/Manifest description Suggested manifest configs to use to de-serialize the data. title Deserialize type object title SerializationMetadata type object SerializedChunkIDs additionalProperties False properties type const chunk-ids default chunk-ids title Type type string chunk_id_list description A list of chunk ids, which will be resolved via the attached data registry. items type string title Chunk Id List type array archive_id anyOf format uuid type string type null default None description The preferred data archive to get the chunks from. title Archive Id size description The size of all chunks combined. title Size type integer required chunk_id_list size title SerializedChunkIDs type object additionalProperties False properties data_type description The name of the data type for this serialized value. title Data Type type string data_type_config additionalProperties True description The (optional) config for the data type for this serialized value. title Data Type Config type object serialization_profile description An identifying name for the serialization method used. title Serialization Profile type string metadata $ref #/$defs/SerializationMetadata description Optional metadata describing aspects of the serialization used. hash_codec default sha2-256 description The codec used to hash the value. title Hash Codec type string archive_id description The id of the store that persisted the data. format uuid title Archive Id type string chunk_id_map additionalProperties $ref #/$defs/SerializedChunkIDs description Reference-ids that resolve to the values' serialized chunks. title Chunk Id Map type object required data_type serialization_profile archive_id chunk_id_map title PersistedData type object	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	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DataTypeCharacteristics properties is_scalar default False description Whether the data desribed by this data type behaves like a skalar. title Is Scalar type boolean is_json_serializable default False description Whether the data can be serialized to json without information loss. title Is Json Serializable type boolean title DataTypeCharacteristics type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object additionalProperties False properties data_type_name description The registered name of this data type. title Data Type Name type string data_type_config additionalProperties True description The (optional) configuration for this data type. title Data Type Config type object characteristics $ref #/$defs/DataTypeCharacteristics description Characteristics of this data type. data_type_class $ref #/$defs/PythonClass description The python class that is associated with this model. required data_type_name characteristics data_type_class title DataTypeInfo type object	The (json) schema for this model data.

instance.value_details

type_name	instance.value_details	The registered name for this item type.
documentation	A wrapper class that manages and retieves value data and its details.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DataTypeCharacteristics properties is_scalar default False description Whether the data desribed by this data type behaves like a skalar. title Is Scalar type boolean is_json_serializable default False description Whether the data can be serialized to json without information loss. title Is Json Serializable type boolean title DataTypeCharacteristics type object DataTypeInfo additionalProperties False properties data_type_name description The registered name of this data type. title Data Type Name type string data_type_config additionalProperties True description The (optional) configuration for this data type. title Data Type Config type object characteristics $ref #/$defs/DataTypeCharacteristics description Characteristics of this data type. data_type_class $ref #/$defs/PythonClass description The python class that is associated with this model. required data_type_name characteristics data_type_class title DataTypeInfo type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object ValuePedigree additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean inputs additionalProperties format uuid type string description A map of all the input fields and value references. title Inputs type object kiara_id description The id of the kiara context a value was created in. format uuid title Kiara Id type string environments additionalProperties type string description References to the runtime environment details a value was created in. title Environments type object required module_type inputs kiara_id environments title ValuePedigree type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object ValueStatus enum unknown not set none default set title ValueStatus type string additionalProperties False description A wrapper class that manages and retieves value data and its details. properties value_id description The id of the value. format uuid title Value Id type string kiara_id description The id of the kiara context this value belongs to. format uuid title Kiara Id type string value_schema $ref #/$defs/ValueSchema description The schema that was used for this Value. value_created description The time when this value was created. format date-time title Value Created type string value_status $ref #/$defs/ValueStatus description The set/unset status of this value. value_size description The size of this value, in bytes. title Value Size type integer value_hash description The hash of this value. title Value Hash type string pedigree $ref #/$defs/ValuePedigree description Information about the module and inputs that went into creating this value. pedigree_output_name description The output name that produced this value (using the manifest inside the pedigree). title Pedigree Output Name type string data_type_info $ref #/$defs/DataTypeInfo description Information about the data type this value is made of. required value_id kiara_id value_schema value_status value_size value_hash pedigree pedigree_output_name data_type_info title ValueDetails type object	The (json) schema for this model data.

instance.value

type_name	instance.value	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DataTypeCharacteristics properties is_scalar default False description Whether the data desribed by this data type behaves like a skalar. title Is Scalar type boolean is_json_serializable default False description Whether the data can be serialized to json without information loss. title Is Json Serializable type boolean title DataTypeCharacteristics type object DataTypeInfo additionalProperties False properties data_type_name description The registered name of this data type. title Data Type Name type string data_type_config additionalProperties True description The (optional) configuration for this data type. title Data Type Config type object characteristics $ref #/$defs/DataTypeCharacteristics description Characteristics of this data type. data_type_class $ref #/$defs/PythonClass description The python class that is associated with this model. required data_type_name characteristics data_type_class title DataTypeInfo type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object ValuePedigree additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean inputs additionalProperties format uuid type string description A map of all the input fields and value references. title Inputs type object kiara_id description The id of the kiara context a value was created in. format uuid title Kiara Id type string environments additionalProperties type string description References to the runtime environment details a value was created in. title Environments type object required module_type inputs kiara_id environments title ValuePedigree type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object ValueStatus enum unknown not set none default set title ValueStatus type string additionalProperties False properties value_id description The id of the value. format uuid title Value Id type string kiara_id description The id of the kiara context this value belongs to. format uuid title Kiara Id type string value_schema $ref #/$defs/ValueSchema description The schema that was used for this Value. value_created description The time when this value was created. format date-time title Value Created type string value_status $ref #/$defs/ValueStatus description The set/unset status of this value. value_size description The size of this value, in bytes. title Value Size type integer value_hash description The hash of this value. title Value Hash type string pedigree $ref #/$defs/ValuePedigree description Information about the module and inputs that went into creating this value. pedigree_output_name description The output name that produced this value (using the manifest inside the pedigree). title Pedigree Output Name type string data_type_info $ref #/$defs/DataTypeInfo description Information about the data type this value is made of. environment_hashes additionalProperties additionalProperties type string type object description Hashes for the environments this value was created in. title Environment Hashes type object property_links additionalProperties format uuid type string description Links to values that are properties of this value. title Property Links type object destiny_backlinks additionalProperties type string description Backlinks to values that this value acts as destiny/or property for. propertyNames format uuid title Destiny Backlinks type object job_id anyOf format uuid type string type null default None description The id of the job that created this value (if applicable). title Job Id required value_id kiara_id value_schema value_status value_size value_hash pedigree pedigree_output_name data_type_info environment_hashes title Value type object	The (json) schema for this model data.

instance.unloadable_data

type_name	instance.unloadable_data	The registered name for this item type.
documentation	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.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DataTypeCharacteristics properties is_scalar default False description Whether the data desribed by this data type behaves like a skalar. title Is Scalar type boolean is_json_serializable default False description Whether the data can be serialized to json without information loss. title Is Json Serializable type boolean title DataTypeCharacteristics type object DataTypeInfo additionalProperties False properties data_type_name description The registered name of this data type. title Data Type Name type string data_type_config additionalProperties True description The (optional) configuration for this data type. title Data Type Config type object characteristics $ref #/$defs/DataTypeCharacteristics description Characteristics of this data type. data_type_class $ref #/$defs/PythonClass description The python class that is associated with this model. required data_type_name characteristics data_type_class title DataTypeInfo type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object Value additionalProperties False properties value_id description The id of the value. format uuid title Value Id type string kiara_id description The id of the kiara context this value belongs to. format uuid title Kiara Id type string value_schema $ref #/$defs/ValueSchema description The schema that was used for this Value. value_created description The time when this value was created. format date-time title Value Created type string value_status $ref #/$defs/ValueStatus description The set/unset status of this value. value_size description The size of this value, in bytes. title Value Size type integer value_hash description The hash of this value. title Value Hash type string pedigree $ref #/$defs/ValuePedigree description Information about the module and inputs that went into creating this value. pedigree_output_name description The output name that produced this value (using the manifest inside the pedigree). title Pedigree Output Name type string data_type_info $ref #/$defs/DataTypeInfo description Information about the data type this value is made of. environment_hashes additionalProperties additionalProperties type string type object description Hashes for the environments this value was created in. title Environment Hashes type object property_links additionalProperties format uuid type string description Links to values that are properties of this value. title Property Links type object destiny_backlinks additionalProperties type string description Backlinks to values that this value acts as destiny/or property for. propertyNames format uuid title Destiny Backlinks type object job_id anyOf format uuid type string type null default None description The id of the job that created this value (if applicable). title Job Id required value_id kiara_id value_schema value_status value_size value_hash pedigree pedigree_output_name data_type_info environment_hashes title Value type object ValuePedigree additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean inputs additionalProperties format uuid type string description A map of all the input fields and value references. title Inputs type object kiara_id description The id of the kiara context a value was created in. format uuid title Kiara Id type string environments additionalProperties type string description References to the runtime environment details a value was created in. title Environments type object required module_type inputs kiara_id environments title ValuePedigree type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object ValueStatus enum unknown not set none default set title ValueStatus type string additionalProperties False 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. properties value $ref #/$defs/Value description A reference to the value. required value title UnloadableData type object	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	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DataTypeCharacteristics properties is_scalar default False description Whether the data desribed by this data type behaves like a skalar. title Is Scalar type boolean is_json_serializable default False description Whether the data can be serialized to json without information loss. title Is Json Serializable type boolean title DataTypeCharacteristics type object DataTypeInfo additionalProperties False properties data_type_name description The registered name of this data type. title Data Type Name type string data_type_config additionalProperties True description The (optional) configuration for this data type. title Data Type Config type object characteristics $ref #/$defs/DataTypeCharacteristics description Characteristics of this data type. data_type_class $ref #/$defs/PythonClass description The python class that is associated with this model. required data_type_name characteristics data_type_class title DataTypeInfo type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object Value additionalProperties False properties value_id description The id of the value. format uuid title Value Id type string kiara_id description The id of the kiara context this value belongs to. format uuid title Kiara Id type string value_schema $ref #/$defs/ValueSchema description The schema that was used for this Value. value_created description The time when this value was created. format date-time title Value Created type string value_status $ref #/$defs/ValueStatus description The set/unset status of this value. value_size description The size of this value, in bytes. title Value Size type integer value_hash description The hash of this value. title Value Hash type string pedigree $ref #/$defs/ValuePedigree description Information about the module and inputs that went into creating this value. pedigree_output_name description The output name that produced this value (using the manifest inside the pedigree). title Pedigree Output Name type string data_type_info $ref #/$defs/DataTypeInfo description Information about the data type this value is made of. environment_hashes additionalProperties additionalProperties type string type object description Hashes for the environments this value was created in. title Environment Hashes type object property_links additionalProperties format uuid type string description Links to values that are properties of this value. title Property Links type object destiny_backlinks additionalProperties type string description Backlinks to values that this value acts as destiny/or property for. propertyNames format uuid title Destiny Backlinks type object job_id anyOf format uuid type string type null default None description The id of the job that created this value (if applicable). title Job Id required value_id kiara_id value_schema value_status value_size value_hash pedigree pedigree_output_name data_type_info environment_hashes title Value type object ValuePedigree additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean inputs additionalProperties format uuid type string description A map of all the input fields and value references. title Inputs type object kiara_id description The id of the kiara context a value was created in. format uuid title Kiara Id type string environments additionalProperties type string description References to the runtime environment details a value was created in. title Environments type object required module_type inputs kiara_id environments title ValuePedigree type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object ValueStatus enum unknown not set none default set title ValueStatus type string additionalProperties False properties values_schema additionalProperties $ref #/$defs/ValueSchema description The schemas for all the values in this set. title Values Schema type object value_items additionalProperties $ref #/$defs/Value description The values contained in this set. title Value Items type object required values_schema value_items title ValueMapReadOnly type object	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	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DataTypeCharacteristics properties is_scalar default False description Whether the data desribed by this data type behaves like a skalar. title Is Scalar type boolean is_json_serializable default False description Whether the data can be serialized to json without information loss. title Is Json Serializable type boolean title DataTypeCharacteristics type object DataTypeInfo additionalProperties False properties data_type_name description The registered name of this data type. title Data Type Name type string data_type_config additionalProperties True description The (optional) configuration for this data type. title Data Type Config type object characteristics $ref #/$defs/DataTypeCharacteristics description Characteristics of this data type. data_type_class $ref #/$defs/PythonClass description The python class that is associated with this model. required data_type_name characteristics data_type_class title DataTypeInfo type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object Value additionalProperties False properties value_id description The id of the value. format uuid title Value Id type string kiara_id description The id of the kiara context this value belongs to. format uuid title Kiara Id type string value_schema $ref #/$defs/ValueSchema description The schema that was used for this Value. value_created description The time when this value was created. format date-time title Value Created type string value_status $ref #/$defs/ValueStatus description The set/unset status of this value. value_size description The size of this value, in bytes. title Value Size type integer value_hash description The hash of this value. title Value Hash type string pedigree $ref #/$defs/ValuePedigree description Information about the module and inputs that went into creating this value. pedigree_output_name description The output name that produced this value (using the manifest inside the pedigree). title Pedigree Output Name type string data_type_info $ref #/$defs/DataTypeInfo description Information about the data type this value is made of. environment_hashes additionalProperties additionalProperties type string type object description Hashes for the environments this value was created in. title Environment Hashes type object property_links additionalProperties format uuid type string description Links to values that are properties of this value. title Property Links type object destiny_backlinks additionalProperties type string description Backlinks to values that this value acts as destiny/or property for. propertyNames format uuid title Destiny Backlinks type object job_id anyOf format uuid type string type null default None description The id of the job that created this value (if applicable). title Job Id required value_id kiara_id value_schema value_status value_size value_hash pedigree pedigree_output_name data_type_info environment_hashes title Value type object ValuePedigree additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean inputs additionalProperties format uuid type string description A map of all the input fields and value references. title Inputs type object kiara_id description The id of the kiara context a value was created in. format uuid title Kiara Id type string environments additionalProperties type string description References to the runtime environment details a value was created in. title Environments type object required module_type inputs kiara_id environments title ValuePedigree type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object ValueStatus enum unknown not set none default set title ValueStatus type string additionalProperties False properties values_schema additionalProperties $ref #/$defs/ValueSchema description The schemas for all the values in this set. title Values Schema type object value_items additionalProperties $ref #/$defs/Value description The values contained in this set. title Value Items type object pedigree $ref #/$defs/ValuePedigree description The pedigree to add to all of the result values. unique_value_ids default True description Whether this value map always creates new value(id)s, even when a dataset with matching hash is found. title Unique Value Ids type boolean required values_schema pedigree title ValueMapWritable type object	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	A model class that holds a tree of values and their schemas.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AliasValueMap additionalProperties False description A model class that holds a tree of values and their schemas. properties values_schema additionalProperties $ref #/$defs/ValueSchema description The schemas for all the values in this set. title Values Schema type object alias anyOf type string type null description This maps own (full) alias. title Alias version description The version of this map (in this maps parent). title Version type integer created anyOf format date-time type string type null default None description The time this map was created. title Created assoc_schema anyOf $ref #/$defs/ValueSchema type null description The schema for this maps associated value. assoc_value anyOf format uuid type string type null description The value that is associated with this map. title Assoc Value value_items additionalProperties additionalProperties $ref #/$defs/AliasValueMap type object description The values contained in this set. title Value Items type object required values_schema alias version assoc_schema assoc_value title AliasValueMap type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object $ref #/$defs/AliasValueMap	The (json) schema for this model data.

instance.operation_details

type_name	instance.operation_details	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	additionalProperties False properties operation_id description The id of the operation. title Operation Id type string is_internal_operation default False description Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). title Is Internal Operation type boolean required operation_id title OperationDetails type object	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	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object additionalProperties False properties operation_id description The id of the operation. title Operation Id type string is_internal_operation default False description Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). title Is Internal Operation type boolean module_inputs_schema additionalProperties $ref #/$defs/ValueSchema description The input schemas of the module. title Module Inputs Schema type object module_outputs_schema additionalProperties $ref #/$defs/ValueSchema description The output schemas of the module. title Module Outputs Schema type object required operation_id module_inputs_schema module_outputs_schema title BaseOperationDetails type object	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	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object additionalProperties False properties doc $ref #/$defs/DocumentationMetadataModel description Documentation for this operation. module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object required doc module_type title ManifestOperationConfig type object	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	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object additionalProperties False properties doc $ref #/$defs/DocumentationMetadataModel description Documentation for this operation. pipeline_name description The pipeline id. title Pipeline Name type string pipeline_config additionalProperties True description The pipeline config data. title Pipeline Config type object module_map additionalProperties True description A lookup map to resolves operation ids to module names/configs. title Module Map type object metadata additionalProperties True description Additional metadata for the pipeline. title Metadata type object required doc pipeline_name pipeline_config title PipelineOperationConfig type object	The (json) schema for this model data.

filter

type_name	filter	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object Operation additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean operation_id description The (unique) id of this operation. title Operation Id type string operation_details $ref #/$defs/OperationDetails description The operation specific details of this operation. doc $ref #/$defs/DocumentationMetadataModel description Documentation for this operation. module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. metadata additionalProperties True description Additional metadata for this operation. title Metadata type object required module_type operation_id operation_details doc module_details title Operation type object OperationDetails additionalProperties False properties operation_id description The id of the operation. title Operation Id type string is_internal_operation default False description Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). title Is Internal Operation type boolean required operation_id title OperationDetails type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object additionalProperties False properties operation $ref #/$defs/Operation description The underlying operation providing which does the filtering. input_name description The input name to use for the dataset to filter. title Input Name type string output_name description The output name to use for the dataset to filter. title Output Name type string data_type description The type of the dataset that gets filtered. title Data Type type string required operation input_name output_name data_type title Filter type object	The (json) schema for this model data.

info.pipeline_stage

type_name	info.pipeline_stage	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	additionalProperties False properties stage_index description The index of this stage. title Stage Index type integer steps description The pipeline steps that are executed in this stage. items type string title Steps type array connected_outputs description Previous step outputs that are connected to this stage. items type string title Connected Outputs type array stage_outputs description The outputs of this stage. items type string title Stage Outputs type array pipeline_inputs description The pipeline inputs required for this stage. items type string title Pipeline Inputs type array pipeline_outputs description The pipeline outputs that are ready once this stage is processed. items type string title Pipeline Outputs type array previous_pipeline_inputs description Pipeline inputs that are already set by this stage. items type string title Previous Pipeline Inputs type array previous_pipeline_outputs description Pipeline outputs that are already computed by this stage. items type string title Previous Pipeline Outputs type array required stage_index steps connected_outputs stage_outputs pipeline_inputs pipeline_outputs previous_pipeline_inputs previous_pipeline_outputs title PipelineStage type object	The (json) schema for this model data.

pipeline_stages

type_name	pipeline_stages	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs PipelineStage additionalProperties False properties stage_index description The index of this stage. title Stage Index type integer steps description The pipeline steps that are executed in this stage. items type string title Steps type array connected_outputs description Previous step outputs that are connected to this stage. items type string title Connected Outputs type array stage_outputs description The outputs of this stage. items type string title Stage Outputs type array pipeline_inputs description The pipeline inputs required for this stage. items type string title Pipeline Inputs type array pipeline_outputs description The pipeline outputs that are ready once this stage is processed. items type string title Pipeline Outputs type array previous_pipeline_inputs description Pipeline inputs that are already set by this stage. items type string title Previous Pipeline Inputs type array previous_pipeline_outputs description Pipeline outputs that are already computed by this stage. items type string title Previous Pipeline Outputs type array required stage_index steps connected_outputs stage_outputs pipeline_inputs pipeline_outputs previous_pipeline_inputs previous_pipeline_outputs title PipelineStage type object additionalProperties False properties stages description The pipeline stages. items $ref #/$defs/PipelineStage title Stages type array required stages title PipelineStages type object	The (json) schema for this model data.

info.pipeline_step

type_name	info.pipeline_step	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object PipelineStep additionalProperties False description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The module config. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean step_id description Locally unique id (within a pipeline) of this step. title Step Id type string manifest_src $ref #/$defs/Manifest description The original manfifest provided by the user. input_links additionalProperties items $ref #/$defs/StepValueAddress type array description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. title Input Links type object module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. doc $ref #/$defs/DocumentationMetadataModel description A description what this step does. required module_type step_id manifest_src module_details doc title PipelineStep type object StepInputRef additionalProperties False description An input to a step. This object can either have a 'connected_outputs' set, or a 'connected_pipeline_input', not both. properties value_name title Value Name type string value_schema $ref #/$defs/ValueSchema step_id description The step id. title Step Id type string connected_outputs anyOf items $ref #/$defs/StepValueAddress type array type null default None description A potential connected list of one or several module outputs. title Connected Outputs connected_pipeline_input anyOf type string type null default None description A potential pipeline input. title Connected Pipeline Input is_constant description Whether this input is a constant and can't be changed by the user. title Is Constant type boolean required value_name value_schema step_id is_constant title StepInputRef type object StepOutputRef additionalProperties False description An output to a step. properties value_name title Value Name type string value_schema $ref #/$defs/ValueSchema step_id description The step id. title Step Id type string pipeline_output anyOf type string type null description The connected pipeline output. title Pipeline Output connected_inputs description The step inputs that are connected to this step output items $ref #/$defs/StepValueAddress title Connected Inputs type array required value_name value_schema step_id pipeline_output title StepOutputRef type object StepValueAddress additionalProperties False description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. properties step_id description The id of a step within a pipeline. title Step Id type string value_name description The name of the value (output name or pipeline input name). title Value Name type string sub_value anyOf additionalProperties True type object type null default None description A reference to a subitem of a value (e.g. column, list item) title Sub Value required step_id value_name title StepValueAddress type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object additionalProperties False properties step $ref #/$defs/PipelineStep description The pipeline step object. inputs additionalProperties $ref #/$defs/StepInputRef description Reference(s) to the fields that feed this steps inputs. title Inputs type object outputs additionalProperties $ref #/$defs/StepOutputRef description Reference(s) to the fields that are fed by this steps outputs. title Outputs type object required description Whether this step is always required or whether all his outputs feed into optional input fields. title Required type boolean doc $ref #/$defs/DocumentationMetadataModel description The step documentation. required step inputs outputs required title StepInfo type object	The (json) schema for this model data.

instance.pipeline_structure

type_name	instance.pipeline_structure	The registered name for this item type.
documentation	An object that holds one or several steps, and describes the connections between them.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object 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" } } ``` properties constants additionalProperties True description Value constants for this module. title Constants type object defaults additionalProperties True description Value defaults for this module. title Defaults type object pipeline_name description The name of this pipeline. title Pipeline Name type string steps description A list of steps/modules of this pipeline, and their connections. items $ref #/$defs/PipelineStep title Steps type array input_aliases additionalProperties type string 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. title Input Aliases type object output_aliases additionalProperties type string 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. title Output Aliases type object doc $ref #/$defs/DocumentationMetadataModel default -- n/a -- description Documentation about what the pipeline does. context additionalProperties True description Metadata for this workflow. title Context type object required pipeline_name steps input_aliases output_aliases title PipelineConfig type object PipelineStep additionalProperties False description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The module config. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean step_id description Locally unique id (within a pipeline) of this step. title Step Id type string manifest_src $ref #/$defs/Manifest description The original manfifest provided by the user. input_links additionalProperties items $ref #/$defs/StepValueAddress type array description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. title Input Links type object module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. doc $ref #/$defs/DocumentationMetadataModel description A description what this step does. required module_type step_id manifest_src module_details doc title PipelineStep type object StepValueAddress additionalProperties False description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. properties step_id description The id of a step within a pipeline. title Step Id type string value_name description The name of the value (output name or pipeline input name). title Value Name type string sub_value anyOf additionalProperties True type object type null default None description A reference to a subitem of a value (e.g. column, list item) title Sub Value required step_id value_name title StepValueAddress type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object additionalProperties False description An object that holds one or several steps, and describes the connections between them. properties pipeline_config $ref #/$defs/PipelineConfig description The underlying pipeline config. steps description The pipeline steps items $ref #/$defs/PipelineStep title Steps type array input_aliases additionalProperties type string description The input aliases. title Input Aliases type object output_aliases additionalProperties type string description The output aliases. title Output Aliases type object required pipeline_config steps input_aliases output_aliases title PipelineStructure type object	The (json) schema for this model data.

info.archive_type

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

archive_info

type_name	archive_info	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs ArchiveDetails additionalProperties True title ArchiveDetails type object ArchiveMetadata additionalProperties True title ArchiveMetadata type object ArchiveTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. is_writable default False description Whether this archive is writeable. title Is Writable type boolean supported_item_types description The item types this archive suports. items type string title Supported Item Types type array required type_name documentation authors context python_class supported_item_types title ArchiveTypeInfo type object AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). archive_id description The (globally unique) archive id. format uuid title Archive Id type string archive_alias description The archive alias. title Archive Alias type string archive_type_info $ref #/$defs/ArchiveTypeInfo description Information about this archives' type. config additionalProperties True description The configuration of this archive. title Config type object details $ref #/$defs/ArchiveDetails description Type dependent (runtime) details for this archive. metadata $ref #/$defs/ArchiveMetadata description Metadata for this archive. required type_name documentation authors context archive_id archive_alias archive_type_info config details metadata title ArchiveInfo type object	The (json) schema for this model data.

ki_archive_info

type_name	ki_archive_info	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name KiArchiveInfo 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.KiArchiveInfo The full class namespace.	The python class that implements this module type.
metadata_schema	$defs ArchiveDetails additionalProperties True title ArchiveDetails type object ArchiveInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). archive_id description The (globally unique) archive id. format uuid title Archive Id type string archive_alias description The archive alias. title Archive Alias type string archive_type_info $ref #/$defs/ArchiveTypeInfo description Information about this archives' type. config additionalProperties True description The configuration of this archive. title Config type object details $ref #/$defs/ArchiveDetails description Type dependent (runtime) details for this archive. metadata $ref #/$defs/ArchiveMetadata description Metadata for this archive. required type_name documentation authors context archive_id archive_alias archive_type_info config details metadata title ArchiveInfo type object ArchiveMetadata additionalProperties True title ArchiveMetadata type object ArchiveTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. is_writable default False description Whether this archive is writeable. title Is Writable type boolean supported_item_types description The item types this archive suports. items type string title Supported Item Types type array required type_name documentation authors context python_class supported_item_types title ArchiveTypeInfo type object AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). data_archive_info anyOf $ref #/$defs/ArchiveInfo type null description The info for the included data archive. alias_archive_info anyOf $ref #/$defs/ArchiveInfo type null description The info for the included alias archive. metadata_archive_info anyOf $ref #/$defs/ArchiveInfo type null description The info for the included metadata archive. job_archive_info anyOf $ref #/$defs/ArchiveInfo type null description The info for the included job archive. required type_name documentation authors context data_archive_info alias_archive_info metadata_archive_info job_archive_info title KiArchiveInfo type object	The (json) schema for this model data.

info.pipeline

type_name	info.pipeline	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object 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" } } ``` properties constants additionalProperties True description Value constants for this module. title Constants type object defaults additionalProperties True description Value defaults for this module. title Defaults type object pipeline_name description The name of this pipeline. title Pipeline Name type string steps description A list of steps/modules of this pipeline, and their connections. items $ref #/$defs/PipelineStep title Steps type array input_aliases additionalProperties type string 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. title Input Aliases type object output_aliases additionalProperties type string 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. title Output Aliases type object doc $ref #/$defs/DocumentationMetadataModel default -- n/a -- description Documentation about what the pipeline does. context additionalProperties True description Metadata for this workflow. title Context type object required pipeline_name steps input_aliases output_aliases title PipelineConfig type object PipelineState additionalProperties False properties kiara_id description The id of the kiara context. format uuid title Kiara Id type string pipeline_id description The id of the pipeline. format uuid title Pipeline Id type string pipeline_status $ref #/$defs/StepStatus description The current status of this pipeline. invalid_details additionalProperties type string description Details about fields that are invalid (if status < 'INPUTS_READY'. title Invalid Details type object pipeline_inputs additionalProperties format uuid type string description The current pipeline inputs. title Pipeline Inputs type object pipeline_outputs additionalProperties format uuid type string description The current pipeline outputs. title Pipeline Outputs type object step_states additionalProperties $ref #/$defs/StepDetails description The state of each step within this pipeline. title Step States type object required kiara_id pipeline_id pipeline_status pipeline_inputs pipeline_outputs step_states title PipelineState type object PipelineStep additionalProperties False description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The module config. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean step_id description Locally unique id (within a pipeline) of this step. title Step Id type string manifest_src $ref #/$defs/Manifest description The original manfifest provided by the user. input_links additionalProperties items $ref #/$defs/StepValueAddress type array description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. title Input Links type object module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. doc $ref #/$defs/DocumentationMetadataModel description A description what this step does. required module_type step_id manifest_src module_details doc title PipelineStep type object StepDetails properties kiara_id description The id of the kiara context. format uuid title Kiara Id type string pipeline_id description The id of the pipeline. format uuid title Pipeline Id type string step $ref #/$defs/PipelineStep description The pipeline step details. step_id description The id of the step. title Step Id type string processing_stage description The execution stage where this step is executed. title Processing Stage type integer status $ref #/$defs/StepStatus description The current status of this step. invalid_details additionalProperties type string description Details about fields that are invalid (if status < 'INPUTS_READY'. title Invalid Details type object inputs additionalProperties format uuid type string description The current inputs of this step. title Inputs type object outputs additionalProperties format uuid type string description The current outputs of this step. title Outputs type object required kiara_id pipeline_id step step_id processing_stage status inputs outputs title StepDetails type object StepStatus description Enum to describe the state of a workflow. enum inputs_invalid inputs_ready results_ready title StepStatus type string StepValueAddress additionalProperties False description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. properties step_id description The id of a step within a pipeline. title Step Id type string value_name description The name of the value (output name or pipeline input name). title Value Name type string sub_value anyOf additionalProperties True type object type null default None description A reference to a subitem of a value (e.g. column, list item) title Sub Value required step_id value_name title StepValueAddress type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). pipeline_config $ref #/$defs/PipelineConfig description The configuration of the pipeline. pipeline_state $ref #/$defs/PipelineState description The current input details. required type_name documentation authors context pipeline_config pipeline_state title PipelineInfo type object	The (json) schema for this model data.

info.workflow

type_name	info.workflow	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object 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" } } ``` properties constants additionalProperties True description Value constants for this module. title Constants type object defaults additionalProperties True description Value defaults for this module. title Defaults type object pipeline_name description The name of this pipeline. title Pipeline Name type string steps description A list of steps/modules of this pipeline, and their connections. items $ref #/$defs/PipelineStep title Steps type array input_aliases additionalProperties type string 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. title Input Aliases type object output_aliases additionalProperties type string 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. title Output Aliases type object doc $ref #/$defs/DocumentationMetadataModel default -- n/a -- description Documentation about what the pipeline does. context additionalProperties True description Metadata for this workflow. title Context type object required pipeline_name steps input_aliases output_aliases title PipelineConfig type object PipelineInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). pipeline_config $ref #/$defs/PipelineConfig description The configuration of the pipeline. pipeline_state $ref #/$defs/PipelineState description The current input details. required type_name documentation authors context pipeline_config pipeline_state title PipelineInfo type object PipelineState additionalProperties False properties kiara_id description The id of the kiara context. format uuid title Kiara Id type string pipeline_id description The id of the pipeline. format uuid title Pipeline Id type string pipeline_status $ref #/$defs/StepStatus description The current status of this pipeline. invalid_details additionalProperties type string description Details about fields that are invalid (if status < 'INPUTS_READY'. title Invalid Details type object pipeline_inputs additionalProperties format uuid type string description The current pipeline inputs. title Pipeline Inputs type object pipeline_outputs additionalProperties format uuid type string description The current pipeline outputs. title Pipeline Outputs type object step_states additionalProperties $ref #/$defs/StepDetails description The state of each step within this pipeline. title Step States type object required kiara_id pipeline_id pipeline_status pipeline_inputs pipeline_outputs step_states title PipelineState type object PipelineStep additionalProperties False description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The module config. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean step_id description Locally unique id (within a pipeline) of this step. title Step Id type string manifest_src $ref #/$defs/Manifest description The original manfifest provided by the user. input_links additionalProperties items $ref #/$defs/StepValueAddress type array description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. title Input Links type object module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. doc $ref #/$defs/DocumentationMetadataModel description A description what this step does. required module_type step_id manifest_src module_details doc title PipelineStep type object StepDetails properties kiara_id description The id of the kiara context. format uuid title Kiara Id type string pipeline_id description The id of the pipeline. format uuid title Pipeline Id type string step $ref #/$defs/PipelineStep description The pipeline step details. step_id description The id of the step. title Step Id type string processing_stage description The execution stage where this step is executed. title Processing Stage type integer status $ref #/$defs/StepStatus description The current status of this step. invalid_details additionalProperties type string description Details about fields that are invalid (if status < 'INPUTS_READY'. title Invalid Details type object inputs additionalProperties format uuid type string description The current inputs of this step. title Inputs type object outputs additionalProperties format uuid type string description The current outputs of this step. title Outputs type object required kiara_id pipeline_id step step_id processing_stage status inputs outputs title StepDetails type object StepStatus description Enum to describe the state of a workflow. enum inputs_invalid inputs_ready results_ready title StepStatus type string StepValueAddress additionalProperties False description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. properties step_id description The id of a step within a pipeline. title Step Id type string value_name description The name of the value (output name or pipeline input name). title Value Name type string sub_value anyOf additionalProperties True type object type null default None description A reference to a subitem of a value (e.g. column, list item) title Sub Value required step_id value_name title StepValueAddress type object ValueMap additionalProperties False properties values_schema additionalProperties $ref #/$defs/ValueSchema description The schemas for all the values in this set. title Values Schema type object required values_schema title ValueMap type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object WorkflowMetadata additionalProperties False properties workflow_id description The globaly unique uuid for this workflow. format uuid title Workflow Id type string documentation $ref #/$defs/DocumentationMetadataModel description A description for this workflow. authors $ref #/$defs/AuthorsMetadataModel description The author(s) of this workflow. context $ref #/$defs/ContextMetadataModel description Workflow context details. current_state anyOf type string type null default None description A reference to the current state of this workflow. title Current State workflow_history additionalProperties type string description A history of all the states of this workflow. propertyNames format date-time title Workflow History type object input_aliases additionalProperties type string description A set of aliases that can be used to forward inputs to their (unaliased) pipeline inputs. title Input Aliases type object output_aliases additionalProperties type string description A set of aliases to make output field names more user friendly. title Output Aliases type object is_persisted default False description Whether this workflow is persisted in it's current state in a kiara store. title Is Persisted type boolean required workflow_id title WorkflowMetadata type object additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). workflow_metadata $ref #/$defs/WorkflowMetadata description The workflow details. workflow_state_ids description All states for this workflow. items type string title Workflow State Ids type array pipeline_info $ref #/$defs/PipelineInfo description The current state of the workflows' pipeline. current_input_values $ref #/$defs/ValueMap description The current workflow inputs (after aliasing). current_output_values $ref #/$defs/ValueMap description The current workflow outputs (after aliasing). input_aliases additionalProperties type string description The (current) input aliases for this workflow. title Input Aliases type object output_aliases additionalProperties type string description The (current) output aliases for this workflow. title Output Aliases type object required type_name documentation authors context workflow_metadata workflow_state_ids pipeline_info current_input_values current_output_values input_aliases output_aliases title WorkflowInfo type object	The (json) schema for this model data.

info.archive_types

type_name	info.archive_types	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs ArchiveTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. is_writable default False description Whether this archive is writeable. title Is Writable type boolean supported_item_types description The item types this archive suports. items type string title Supported Item Types type array required type_name documentation authors context python_class supported_item_types title ArchiveTypeInfo type object AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/ArchiveTypeInfo description The archive info instances for each type. title Item Infos type object type_name const archive_type default archive_type title Type Name type string required item_infos title ArchiveTypeClassesInfo type object	The (json) schema for this model data.

info.archives

type_name	info.archives	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs ArchiveDetails additionalProperties True title ArchiveDetails type object ArchiveInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). archive_id description The (globally unique) archive id. format uuid title Archive Id type string archive_alias description The archive alias. title Archive Alias type string archive_type_info $ref #/$defs/ArchiveTypeInfo description Information about this archives' type. config additionalProperties True description The configuration of this archive. title Config type object details $ref #/$defs/ArchiveDetails description Type dependent (runtime) details for this archive. metadata $ref #/$defs/ArchiveMetadata description Metadata for this archive. required type_name documentation authors context archive_id archive_alias archive_type_info config details metadata title ArchiveInfo type object ArchiveMetadata additionalProperties True title ArchiveMetadata type object ArchiveTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. is_writable default False description Whether this archive is writeable. title Is Writable type boolean supported_item_types description The item types this archive suports. items type string title Supported Item Types type array required type_name documentation authors context python_class supported_item_types title ArchiveTypeInfo type object AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/ArchiveInfo description The info for each archive. title Item Infos type object required item_infos title ArchiveGroupInfo type object	The (json) schema for this model data.

info.pipelines

type_name	info.pipelines	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name PipelineGroupInfo 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.PipelineGroupInfo The full class namespace.	The python class that implements this module type.
metadata_schema	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object 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" } } ``` properties constants additionalProperties True description Value constants for this module. title Constants type object defaults additionalProperties True description Value defaults for this module. title Defaults type object pipeline_name description The name of this pipeline. title Pipeline Name type string steps description A list of steps/modules of this pipeline, and their connections. items $ref #/$defs/PipelineStep title Steps type array input_aliases additionalProperties type string 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. title Input Aliases type object output_aliases additionalProperties type string 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. title Output Aliases type object doc $ref #/$defs/DocumentationMetadataModel default -- n/a -- description Documentation about what the pipeline does. context additionalProperties True description Metadata for this workflow. title Context type object required pipeline_name steps input_aliases output_aliases title PipelineConfig type object PipelineInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). pipeline_config $ref #/$defs/PipelineConfig description The configuration of the pipeline. pipeline_state $ref #/$defs/PipelineState description The current input details. required type_name documentation authors context pipeline_config pipeline_state title PipelineInfo type object PipelineState additionalProperties False properties kiara_id description The id of the kiara context. format uuid title Kiara Id type string pipeline_id description The id of the pipeline. format uuid title Pipeline Id type string pipeline_status $ref #/$defs/StepStatus description The current status of this pipeline. invalid_details additionalProperties type string description Details about fields that are invalid (if status < 'INPUTS_READY'. title Invalid Details type object pipeline_inputs additionalProperties format uuid type string description The current pipeline inputs. title Pipeline Inputs type object pipeline_outputs additionalProperties format uuid type string description The current pipeline outputs. title Pipeline Outputs type object step_states additionalProperties $ref #/$defs/StepDetails description The state of each step within this pipeline. title Step States type object required kiara_id pipeline_id pipeline_status pipeline_inputs pipeline_outputs step_states title PipelineState type object PipelineStep additionalProperties False description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The module config. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean step_id description Locally unique id (within a pipeline) of this step. title Step Id type string manifest_src $ref #/$defs/Manifest description The original manfifest provided by the user. input_links additionalProperties items $ref #/$defs/StepValueAddress type array description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. title Input Links type object module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. doc $ref #/$defs/DocumentationMetadataModel description A description what this step does. required module_type step_id manifest_src module_details doc title PipelineStep type object StepDetails properties kiara_id description The id of the kiara context. format uuid title Kiara Id type string pipeline_id description The id of the pipeline. format uuid title Pipeline Id type string step $ref #/$defs/PipelineStep description The pipeline step details. step_id description The id of the step. title Step Id type string processing_stage description The execution stage where this step is executed. title Processing Stage type integer status $ref #/$defs/StepStatus description The current status of this step. invalid_details additionalProperties type string description Details about fields that are invalid (if status < 'INPUTS_READY'. title Invalid Details type object inputs additionalProperties format uuid type string description The current inputs of this step. title Inputs type object outputs additionalProperties format uuid type string description The current outputs of this step. title Outputs type object required kiara_id pipeline_id step step_id processing_stage status inputs outputs title StepDetails type object StepStatus description Enum to describe the state of a workflow. enum inputs_invalid inputs_ready results_ready title StepStatus type string StepValueAddress additionalProperties False description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. properties step_id description The id of a step within a pipeline. title Step Id type string value_name description The name of the value (output name or pipeline input name). title Value Name type string sub_value anyOf additionalProperties True type object type null default None description A reference to a subitem of a value (e.g. column, list item) title Sub Value required step_id value_name title StepValueAddress type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/PipelineInfo description The pipeline info instances for each type. title Item Infos type object required item_infos title PipelineGroupInfo type object	The (json) schema for this model data.

info.workflows

type_name	info.workflows	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object 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" } } ``` properties constants additionalProperties True description Value constants for this module. title Constants type object defaults additionalProperties True description Value defaults for this module. title Defaults type object pipeline_name description The name of this pipeline. title Pipeline Name type string steps description A list of steps/modules of this pipeline, and their connections. items $ref #/$defs/PipelineStep title Steps type array input_aliases additionalProperties type string 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. title Input Aliases type object output_aliases additionalProperties type string 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. title Output Aliases type object doc $ref #/$defs/DocumentationMetadataModel default -- n/a -- description Documentation about what the pipeline does. context additionalProperties True description Metadata for this workflow. title Context type object required pipeline_name steps input_aliases output_aliases title PipelineConfig type object PipelineInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). pipeline_config $ref #/$defs/PipelineConfig description The configuration of the pipeline. pipeline_state $ref #/$defs/PipelineState description The current input details. required type_name documentation authors context pipeline_config pipeline_state title PipelineInfo type object PipelineState additionalProperties False properties kiara_id description The id of the kiara context. format uuid title Kiara Id type string pipeline_id description The id of the pipeline. format uuid title Pipeline Id type string pipeline_status $ref #/$defs/StepStatus description The current status of this pipeline. invalid_details additionalProperties type string description Details about fields that are invalid (if status < 'INPUTS_READY'. title Invalid Details type object pipeline_inputs additionalProperties format uuid type string description The current pipeline inputs. title Pipeline Inputs type object pipeline_outputs additionalProperties format uuid type string description The current pipeline outputs. title Pipeline Outputs type object step_states additionalProperties $ref #/$defs/StepDetails description The state of each step within this pipeline. title Step States type object required kiara_id pipeline_id pipeline_status pipeline_inputs pipeline_outputs step_states title PipelineState type object PipelineStep additionalProperties False description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The module config. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean step_id description Locally unique id (within a pipeline) of this step. title Step Id type string manifest_src $ref #/$defs/Manifest description The original manfifest provided by the user. input_links additionalProperties items $ref #/$defs/StepValueAddress type array description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. title Input Links type object module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. doc $ref #/$defs/DocumentationMetadataModel description A description what this step does. required module_type step_id manifest_src module_details doc title PipelineStep type object StepDetails properties kiara_id description The id of the kiara context. format uuid title Kiara Id type string pipeline_id description The id of the pipeline. format uuid title Pipeline Id type string step $ref #/$defs/PipelineStep description The pipeline step details. step_id description The id of the step. title Step Id type string processing_stage description The execution stage where this step is executed. title Processing Stage type integer status $ref #/$defs/StepStatus description The current status of this step. invalid_details additionalProperties type string description Details about fields that are invalid (if status < 'INPUTS_READY'. title Invalid Details type object inputs additionalProperties format uuid type string description The current inputs of this step. title Inputs type object outputs additionalProperties format uuid type string description The current outputs of this step. title Outputs type object required kiara_id pipeline_id step step_id processing_stage status inputs outputs title StepDetails type object StepStatus description Enum to describe the state of a workflow. enum inputs_invalid inputs_ready results_ready title StepStatus type string StepValueAddress additionalProperties False description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. properties step_id description The id of a step within a pipeline. title Step Id type string value_name description The name of the value (output name or pipeline input name). title Value Name type string sub_value anyOf additionalProperties True type object type null default None description A reference to a subitem of a value (e.g. column, list item) title Sub Value required step_id value_name title StepValueAddress type object ValueMap additionalProperties False properties values_schema additionalProperties $ref #/$defs/ValueSchema description The schemas for all the values in this set. title Values Schema type object required values_schema title ValueMap type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object WorkflowInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). workflow_metadata $ref #/$defs/WorkflowMetadata description The workflow details. workflow_state_ids description All states for this workflow. items type string title Workflow State Ids type array pipeline_info $ref #/$defs/PipelineInfo description The current state of the workflows' pipeline. current_input_values $ref #/$defs/ValueMap description The current workflow inputs (after aliasing). current_output_values $ref #/$defs/ValueMap description The current workflow outputs (after aliasing). input_aliases additionalProperties type string description The (current) input aliases for this workflow. title Input Aliases type object output_aliases additionalProperties type string description The (current) output aliases for this workflow. title Output Aliases type object required type_name documentation authors context workflow_metadata workflow_state_ids pipeline_info current_input_values current_output_values input_aliases output_aliases title WorkflowInfo type object WorkflowMetadata additionalProperties False properties workflow_id description The globaly unique uuid for this workflow. format uuid title Workflow Id type string documentation $ref #/$defs/DocumentationMetadataModel description A description for this workflow. authors $ref #/$defs/AuthorsMetadataModel description The author(s) of this workflow. context $ref #/$defs/ContextMetadataModel description Workflow context details. current_state anyOf type string type null default None description A reference to the current state of this workflow. title Current State workflow_history additionalProperties type string description A history of all the states of this workflow. propertyNames format date-time title Workflow History type object input_aliases additionalProperties type string description A set of aliases that can be used to forward inputs to their (unaliased) pipeline inputs. title Input Aliases type object output_aliases additionalProperties type string description A set of aliases to make output field names more user friendly. title Output Aliases type object is_persisted default False description Whether this workflow is persisted in it's current state in a kiara store. title Is Persisted type boolean required workflow_id title WorkflowMetadata type object additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/WorkflowInfo description The workflow infos objects for each workflow. title Item Infos type object aliases additionalProperties format uuid type string description The available aliases. title Aliases type object required item_infos title WorkflowGroupInfo type object	The (json) schema for this model data.

context_info

type_name	context_info	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs ArchiveDetails additionalProperties True title ArchiveDetails type object ArchiveGroupInfo additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/ArchiveInfo description The info for each archive. title Item Infos type object required item_infos title ArchiveGroupInfo type object ArchiveInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). archive_id description The (globally unique) archive id. format uuid title Archive Id type string archive_alias description The archive alias. title Archive Alias type string archive_type_info $ref #/$defs/ArchiveTypeInfo description Information about this archives' type. config additionalProperties True description The configuration of this archive. title Config type object details $ref #/$defs/ArchiveDetails description Type dependent (runtime) details for this archive. metadata $ref #/$defs/ArchiveMetadata description Metadata for this archive. required type_name documentation authors context archive_id archive_alias archive_type_info config details metadata title ArchiveInfo type object ArchiveMetadata additionalProperties True title ArchiveMetadata type object ArchiveTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. is_writable default False description Whether this archive is writeable. title Is Writable type boolean supported_item_types description The item types this archive suports. items type string title Supported Item Types type array required type_name documentation authors context python_class supported_item_types title ArchiveTypeInfo type object AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object additionalProperties False properties kiara_id description The (globally unique) id of the kiara context. format uuid title Kiara Id type string context_name anyOf type string type null description The local alias for this context. title Context Name value_ids description The ids of all stored values in this context. items format uuid type string title Value Ids type array aliases additionalProperties format uuid type string description All available aliases within this context (and the value ids they refer to). title Aliases type object archives $ref #/$defs/ArchiveGroupInfo description The archives registered in this context. invalid default False description Whether this context has errors. title Invalid type boolean comment anyOf type string type null default None description (Optional) comment about this context. title Comment required kiara_id context_name value_ids aliases archives title ContextInfo type object	The (json) schema for this model data.

kiara_metadata

type_name	kiara_metadata	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name KiaraMetadata The name of the Python class. python_module_name kiara.models.metadata The name of the Python module this class lives in. full_name kiara.models.metadata.KiaraMetadata The full class namespace.	The python class that implements this module type.
metadata_schema	additionalProperties False properties title KiaraMetadata type object	The (json) schema for this model data.

instance.kiara_metadata.comment

type_name	instance.kiara_metadata.comment	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name CommentMetadata The name of the Python class. python_module_name kiara.models.metadata The name of the Python module this class lives in. full_name kiara.models.metadata.CommentMetadata The full class namespace.	The python class that implements this module type.
metadata_schema	additionalProperties False properties comment description A note/comment. title Comment type string required comment title CommentMetadata type object	The (json) schema for this model data.

info.runtime.python

type_name	info.runtime.python	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs PythonPackage properties name description The name of the Python package. title Name type string version description The version of the package. title Version type string required name version title PythonPackage type object additionalProperties False properties environment_type const python title Environment Type type string python_version description The version of Python. title Python Version type string packages description The packages installed in the Python (virtual) environment. items $ref #/$defs/PythonPackage title Packages type array required environment_type python_version packages title PythonRuntimeEnvironment type object	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	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs PythonPackage properties name description The name of the Python package. title Name type string version description The version of the package. title Version type string required name version title PythonPackage type object additionalProperties False properties environment_type const kiara_plugins title Environment Type type string kiara_plugins description The kiara plugin packages installed in the Python (virtual) environment. items $ref #/$defs/PythonPackage title Kiara Plugins type array required environment_type kiara_plugins title KiaraPluginsRuntimeEnvironment type object	The (json) schema for this model data.

info.runtime.os

type_name	info.runtime.os	The registered name for this item type.
documentation	Manages information about the OS this kiara instance is running in. TODO: details for other OS's (mainly BSDs)	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	additionalProperties False description Manages information about the OS this kiara instance is running in. # TODO: details for other OS's (mainly BSDs) properties environment_type const operating_system title Environment Type type string operation_system description The operation system name. title Operation System type string platform description The platform name. title Platform type string release description The platform release name. title Release type string version description The platform version name. title Version type string machine description The architecture. title Machine type string os_specific additionalProperties True description OS specific platform metadata. title Os Specific type object required environment_type operation_system platform release version machine title OSRuntimeEnvironment type object	The (json) schema for this model data.

instance.render_scene

type_name	instance.render_scene	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs RenderScene additionalProperties False properties title description The title of this scene. title Title type string disabled default False description Whether this scene should be displayed as 'disabled' in a UI. title Disabled type boolean description default -- n/a -- description Description of what this scene renders. title Description type string manifest_hash description The hash of the manifest of the referenced render scene. title Manifest Hash type string render_config additionalProperties True description The inputs used with the referenced manifest. title Render Config type object related_scenes additionalProperties anyOf $ref #/$defs/RenderScene type null description Other render scenes, related to this one. title Related Scenes type object required title manifest_hash title RenderScene type object $ref #/$defs/RenderScene	The (json) schema for this model data.

render_value_result

type_name	render_value_result	The registered name for this item type.
documentation	Object containing all the result properties of a 'render_value' operation.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object RenderScene additionalProperties False properties title description The title of this scene. title Title type string disabled default False description Whether this scene should be displayed as 'disabled' in a UI. title Disabled type boolean description default -- n/a -- description Description of what this scene renders. title Description type string manifest_hash description The hash of the manifest of the referenced render scene. title Manifest Hash type string render_config additionalProperties True description The inputs used with the referenced manifest. title Render Config type object related_scenes additionalProperties anyOf $ref #/$defs/RenderScene type null description Other render scenes, related to this one. title Related Scenes type object required title manifest_hash title RenderScene type object additionalProperties False description Object containing all the result properties of a 'render_value' operation. properties value_id description The value that was rendered. format uuid title Value Id type string render_config additionalProperties True description The config that was used to render this. title Render Config type object render_manifest description The id of the manifest that was used to render this. title Render Manifest type string related_scenes additionalProperties anyOf $ref #/$defs/RenderScene type null description Other render scenes, related to this one. title Related Scenes type object manifest_lookup additionalProperties $ref #/$defs/Manifest description The manifests referenced in this model, indexed by the hashes. title Manifest Lookup type object rendered description The rendered object. title Rendered required value_id render_manifest rendered title RenderValueResult type object	The (json) schema for this model data.

value_matcher

type_name	value_matcher	The registered name for this item type.
documentation	An object describing requirements values should satisfy in order to be included in a query result.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	additionalProperties False description An object describing requirements values should satisfy in order to be included in a query result. properties data_types description The data type. items type string title Data Types type array allow_sub_types default True description Allow subtypes. title Allow Sub Types type boolean min_size default 0 description The minimum size for the dataset. title Min Size type integer max_size anyOf type integer type null default None description The maximum size for the dataset. title Max Size allow_internal default False description Allow internal data types. title Allow Internal type boolean has_alias default True description Value must have at least one alias. title Has Alias type boolean alias_matchers anyOf items type string type array type null default None description Values must have an alias that matches one of the provided matchers. Assumes 'has_alias' is set to 'True'. title Alias Matchers in_data_archives anyOf items type string type array type null default None description A list of registered names of archives the value must be in. If 'None', all archives will be used. title In Data Archives title ValueMatcher type object	The (json) schema for this model data.

metadata.python_class

type_name	metadata.python_class	The registered name for this item type.
documentation	Python class and module information.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object additionalProperties False description Python class and module information. properties python_class $ref #/$defs/PythonClass description Details about the Python class that backs this value. required python_class title PythonClassMetadata type object	The (json) schema for this model data.

metadata.file

type_name	metadata.file	The registered name for this item type.
documentation	File stats.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs KiaraFile additionalProperties False description Describes properties for the 'file' value type. properties mime_type description The mime type of the file. title Mime Type type string file_name default The name of the file. title File Name type string size description The size of the file. title Size type integer metadata additionalProperties True description Additional, unstructured, user-defined metadata. title Metadata type object metadata_schemas additionalProperties type string description The metadata schemas for each of the metadata values (if available). title Metadata Schemas type object required mime_type size title KiaraFile type object additionalProperties False description File stats. properties file $ref #/$defs/KiaraFile description The file-specific metadata. required file title FileMetadata type object	The (json) schema for this model data.

metadata.file_bundle

type_name	metadata.file_bundle	The registered name for this item type.
documentation	File bundle stats.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs KiaraFile additionalProperties False description Describes properties for the 'file' value type. properties mime_type description The mime type of the file. title Mime Type type string file_name default The name of the file. title File Name type string size description The size of the file. title Size type integer metadata additionalProperties True description Additional, unstructured, user-defined metadata. title Metadata type object metadata_schemas additionalProperties type string description The metadata schemas for each of the metadata values (if available). title Metadata Schemas type object required mime_type size title KiaraFile type object KiaraFileBundle additionalProperties False description Describes properties for the 'file_bundle' value type. properties bundle_name description The name of this bundle. title Bundle Name type string number_of_files description How many files are included in this bundle. title Number Of Files type integer included_files additionalProperties $ref #/$defs/KiaraFile description A map of all the included files, incl. their properties. Uses the relative path of each file as key. title Included Files type object size description The size of all files in this folder, combined. title Size type integer metadata additionalProperties True description Additional, ustructured, user-defined metadata. title Metadata type object metadata_schemas additionalProperties type string description The metadata schemas for each metadata value (if available). title Metadata Schemas type object required bundle_name number_of_files included_files size title KiaraFileBundle type object additionalProperties False description File bundle stats. properties file_bundle $ref #/$defs/KiaraFileBundle description The file-specific metadata. required file_bundle title FileBundleMetadata type object	The (json) schema for this model data.

instance.pipeline_state

type_name	instance.pipeline_state	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object PipelineStep additionalProperties False description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The module config. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean step_id description Locally unique id (within a pipeline) of this step. title Step Id type string manifest_src $ref #/$defs/Manifest description The original manfifest provided by the user. input_links additionalProperties items $ref #/$defs/StepValueAddress type array description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. title Input Links type object module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. doc $ref #/$defs/DocumentationMetadataModel description A description what this step does. required module_type step_id manifest_src module_details doc title PipelineStep type object StepDetails properties kiara_id description The id of the kiara context. format uuid title Kiara Id type string pipeline_id description The id of the pipeline. format uuid title Pipeline Id type string step $ref #/$defs/PipelineStep description The pipeline step details. step_id description The id of the step. title Step Id type string processing_stage description The execution stage where this step is executed. title Processing Stage type integer status $ref #/$defs/StepStatus description The current status of this step. invalid_details additionalProperties type string description Details about fields that are invalid (if status < 'INPUTS_READY'. title Invalid Details type object inputs additionalProperties format uuid type string description The current inputs of this step. title Inputs type object outputs additionalProperties format uuid type string description The current outputs of this step. title Outputs type object required kiara_id pipeline_id step step_id processing_stage status inputs outputs title StepDetails type object StepStatus description Enum to describe the state of a workflow. enum inputs_invalid inputs_ready results_ready title StepStatus type string StepValueAddress additionalProperties False description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. properties step_id description The id of a step within a pipeline. title Step Id type string value_name description The name of the value (output name or pipeline input name). title Value Name type string sub_value anyOf additionalProperties True type object type null default None description A reference to a subitem of a value (e.g. column, list item) title Sub Value required step_id value_name title StepValueAddress type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object additionalProperties False properties kiara_id description The id of the kiara context. format uuid title Kiara Id type string pipeline_id description The id of the pipeline. format uuid title Pipeline Id type string pipeline_status $ref #/$defs/StepStatus description The current status of this pipeline. invalid_details additionalProperties type string description Details about fields that are invalid (if status < 'INPUTS_READY'. title Invalid Details type object pipeline_inputs additionalProperties format uuid type string description The current pipeline inputs. title Pipeline Inputs type object pipeline_outputs additionalProperties format uuid type string description The current pipeline outputs. title Pipeline Outputs type object step_states additionalProperties $ref #/$defs/StepDetails description The state of each step within this pipeline. title Step States type object required kiara_id pipeline_id pipeline_status pipeline_inputs pipeline_outputs step_states title PipelineState type object	The (json) schema for this model data.

workflow_state

type_name	workflow_state	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object 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" } } ``` properties constants additionalProperties True description Value constants for this module. title Constants type object defaults additionalProperties True description Value defaults for this module. title Defaults type object pipeline_name description The name of this pipeline. title Pipeline Name type string steps description A list of steps/modules of this pipeline, and their connections. items $ref #/$defs/PipelineStep title Steps type array input_aliases additionalProperties type string 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. title Input Aliases type object output_aliases additionalProperties type string 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. title Output Aliases type object doc $ref #/$defs/DocumentationMetadataModel default -- n/a -- description Documentation about what the pipeline does. context additionalProperties True description Metadata for this workflow. title Context type object required pipeline_name steps input_aliases output_aliases title PipelineConfig type object PipelineInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). pipeline_config $ref #/$defs/PipelineConfig description The configuration of the pipeline. pipeline_state $ref #/$defs/PipelineState description The current input details. required type_name documentation authors context pipeline_config pipeline_state title PipelineInfo type object PipelineState additionalProperties False properties kiara_id description The id of the kiara context. format uuid title Kiara Id type string pipeline_id description The id of the pipeline. format uuid title Pipeline Id type string pipeline_status $ref #/$defs/StepStatus description The current status of this pipeline. invalid_details additionalProperties type string description Details about fields that are invalid (if status < 'INPUTS_READY'. title Invalid Details type object pipeline_inputs additionalProperties format uuid type string description The current pipeline inputs. title Pipeline Inputs type object pipeline_outputs additionalProperties format uuid type string description The current pipeline outputs. title Pipeline Outputs type object step_states additionalProperties $ref #/$defs/StepDetails description The state of each step within this pipeline. title Step States type object required kiara_id pipeline_id pipeline_status pipeline_inputs pipeline_outputs step_states title PipelineState type object PipelineStep additionalProperties False description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The module config. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean step_id description Locally unique id (within a pipeline) of this step. title Step Id type string manifest_src $ref #/$defs/Manifest description The original manfifest provided by the user. input_links additionalProperties items $ref #/$defs/StepValueAddress type array description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. title Input Links type object module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. doc $ref #/$defs/DocumentationMetadataModel description A description what this step does. required module_type step_id manifest_src module_details doc title PipelineStep type object StepDetails properties kiara_id description The id of the kiara context. format uuid title Kiara Id type string pipeline_id description The id of the pipeline. format uuid title Pipeline Id type string step $ref #/$defs/PipelineStep description The pipeline step details. step_id description The id of the step. title Step Id type string processing_stage description The execution stage where this step is executed. title Processing Stage type integer status $ref #/$defs/StepStatus description The current status of this step. invalid_details additionalProperties type string description Details about fields that are invalid (if status < 'INPUTS_READY'. title Invalid Details type object inputs additionalProperties format uuid type string description The current inputs of this step. title Inputs type object outputs additionalProperties format uuid type string description The current outputs of this step. title Outputs type object required kiara_id pipeline_id step step_id processing_stage status inputs outputs title StepDetails type object StepStatus description Enum to describe the state of a workflow. enum inputs_invalid inputs_ready results_ready title StepStatus type string StepValueAddress additionalProperties False description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. properties step_id description The id of a step within a pipeline. title Step Id type string value_name description The name of the value (output name or pipeline input name). title Value Name type string sub_value anyOf additionalProperties True type object type null default None description A reference to a subitem of a value (e.g. column, list item) title Sub Value required step_id value_name title StepValueAddress type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object additionalProperties False properties steps description The current steps in the workflow. items $ref #/$defs/PipelineStep title Steps type array inputs additionalProperties format uuid type string description The current (pipeline) input values. title Inputs type object pipeline_info $ref #/$defs/PipelineInfo description Details about the pipeline and its state. required pipeline_info title WorkflowState type object	The (json) schema for this model data.

instance.workflow

type_name	instance.workflow	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object additionalProperties False properties workflow_id description The globaly unique uuid for this workflow. format uuid title Workflow Id type string documentation $ref #/$defs/DocumentationMetadataModel description A description for this workflow. authors $ref #/$defs/AuthorsMetadataModel description The author(s) of this workflow. context $ref #/$defs/ContextMetadataModel description Workflow context details. current_state anyOf type string type null default None description A reference to the current state of this workflow. title Current State workflow_history additionalProperties type string description A history of all the states of this workflow. propertyNames format date-time title Workflow History type object input_aliases additionalProperties type string description A set of aliases that can be used to forward inputs to their (unaliased) pipeline inputs. title Input Aliases type object output_aliases additionalProperties type string description A set of aliases to make output field names more user friendly. title Output Aliases type object is_persisted default False description Whether this workflow is persisted in it's current state in a kiara store. title Is Persisted type boolean required workflow_id title WorkflowMetadata type object	The (json) schema for this model data.

instance.data.file

type_name	instance.data.file	The registered name for this item type.
documentation	Describes properties for the 'file' value type.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	additionalProperties False description Describes properties for the 'file' value type. properties mime_type description The mime type of the file. title Mime Type type string file_name default The name of the file. title File Name type string size description The size of the file. title Size type integer metadata additionalProperties True description Additional, unstructured, user-defined metadata. title Metadata type object metadata_schemas additionalProperties type string description The metadata schemas for each of the metadata values (if available). title Metadata Schemas type object required mime_type size title KiaraFile type object	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	Describes properties for the 'file_bundle' value type.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs KiaraFile additionalProperties False description Describes properties for the 'file' value type. properties mime_type description The mime type of the file. title Mime Type type string file_name default The name of the file. title File Name type string size description The size of the file. title Size type integer metadata additionalProperties True description Additional, unstructured, user-defined metadata. title Metadata type object metadata_schemas additionalProperties type string description The metadata schemas for each of the metadata values (if available). title Metadata Schemas type object required mime_type size title KiaraFile type object additionalProperties False description Describes properties for the 'file_bundle' value type. properties bundle_name description The name of this bundle. title Bundle Name type string number_of_files description How many files are included in this bundle. title Number Of Files type integer included_files additionalProperties $ref #/$defs/KiaraFile description A map of all the included files, incl. their properties. Uses the relative path of each file as key. title Included Files type object size description The size of all files in this folder, combined. title Size type integer metadata additionalProperties True description Additional, ustructured, user-defined metadata. title Metadata type object metadata_schemas additionalProperties type string description The metadata schemas for each metadata value (if available). title Metadata Schemas type object required bundle_name number_of_files included_files size title KiaraFileBundle type object	The (json) schema for this model data.

info.kiara_model

type_name	info.kiara_model	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. metadata_schema additionalProperties True description The (json) schema for this model data. title Metadata Schema type object required type_name documentation authors context python_class metadata_schema title KiaraModelTypeInfo type object	The (json) schema for this model data.

info.metadata_type

type_name	info.metadata_type	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.MetadataTypeInfo The full class namespace.	The python class that implements this module type.
metadata_schema	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. metadata_schema additionalProperties True description The (json) schema for this metadata value. title Metadata Schema type object required type_name documentation authors context python_class metadata_schema title MetadataTypeInfo type object	The (json) schema for this model data.

info.data_type

type_name	info.data_type	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object MetadataTypeClassesInfo additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/MetadataTypeInfo description The value metadata info instances for each type. title Item Infos type object type_name const value_metadata default value_metadata title Type Name type string required item_infos title MetadataTypeClassesInfo type object MetadataTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. metadata_schema additionalProperties True description The (json) schema for this metadata value. title Metadata Schema type object required type_name documentation authors context python_class metadata_schema title MetadataTypeInfo type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. value_cls $ref #/$defs/PythonClass description The python class of the value itself. data_type_config_cls $ref #/$defs/PythonClass description The python class holding the schema for configuring this type. lineage anyOf items type string type array type null description This types lineage. title Lineage qualifier_profiles anyOf additionalProperties additionalProperties True type object type object type null description A map of qualifier profiles for this data types. title Qualifier Profiles supported_properties $ref #/$defs/MetadataTypeClassesInfo description The supported property types for this data type. required type_name documentation authors context python_class value_cls data_type_config_cls lineage qualifier_profiles supported_properties title DataTypeClassInfo type object	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	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object KiaraModuleConfigMetadata additionalProperties False properties python_class $ref #/$defs/PythonClass description The config model python class. config_values additionalProperties $ref #/$defs/ValueTypeAndDescription description The available configuration values. title Config Values type object required python_class config_values title KiaraModuleConfigMetadata type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object ValueTypeAndDescription properties description description The description for the value. title Description type string type description The value type. title Type type string value_default default None description Default for the value. title Value Default required description Whether this value is required title Required type boolean required description type required title ValueTypeAndDescription type object additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. module_config $ref #/$defs/KiaraModuleConfigMetadata description The module config metadata. module_src description The source code of the process method of the module. title Module Src type string required type_name documentation authors context python_class module_config module_src title ModuleTypeInfo type object	The (json) schema for this model data.

info.operation_type

type_name	info.operation_type	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. required type_name documentation authors context python_class title OperationTypeInfo type object	The (json) schema for this model data.

info.value

type_name	info.value	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DataTypeCharacteristics properties is_scalar default False description Whether the data desribed by this data type behaves like a skalar. title Is Scalar type boolean is_json_serializable default False description Whether the data can be serialized to json without information loss. title Is Json Serializable type boolean title DataTypeCharacteristics type object DataTypeInfo additionalProperties False properties data_type_name description The registered name of this data type. title Data Type Name type string data_type_config additionalProperties True description The (optional) configuration for this data type. title Data Type Config type object characteristics $ref #/$defs/DataTypeCharacteristics description Characteristics of this data type. data_type_class $ref #/$defs/PythonClass description The python class that is associated with this model. required data_type_name characteristics data_type_class title DataTypeInfo type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object PersistedData additionalProperties False properties data_type description The name of the data type for this serialized value. title Data Type type string data_type_config additionalProperties True description The (optional) config for the data type for this serialized value. title Data Type Config type object serialization_profile description An identifying name for the serialization method used. title Serialization Profile type string metadata $ref #/$defs/SerializationMetadata description Optional metadata describing aspects of the serialization used. hash_codec default sha2-256 description The codec used to hash the value. title Hash Codec type string archive_id description The id of the store that persisted the data. format uuid title Archive Id type string chunk_id_map additionalProperties $ref #/$defs/SerializedChunkIDs description Reference-ids that resolve to the values' serialized chunks. title Chunk Id Map type object required data_type serialization_profile archive_id chunk_id_map title PersistedData type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object SerializationMetadata additionalProperties False properties environment additionalProperties type integer description Hash(es) for the environments the value was created/serialized. title Environment type object deserialize additionalProperties $ref #/$defs/Manifest description Suggested manifest configs to use to de-serialize the data. title Deserialize type object title SerializationMetadata type object SerializedChunkIDs additionalProperties False properties type const chunk-ids default chunk-ids title Type type string chunk_id_list description A list of chunk ids, which will be resolved via the attached data registry. items type string title Chunk Id List type array archive_id anyOf format uuid type string type null default None description The preferred data archive to get the chunks from. title Archive Id size description The size of all chunks combined. title Size type integer required chunk_id_list size title SerializedChunkIDs type object ValuePedigree additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean inputs additionalProperties format uuid type string description A map of all the input fields and value references. title Inputs type object kiara_id description The id of the kiara context a value was created in. format uuid title Kiara Id type string environments additionalProperties type string description References to the runtime environment details a value was created in. title Environments type object required module_type inputs kiara_id environments title ValuePedigree type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object ValueStatus enum unknown not set none default set title ValueStatus type string additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). value_id description The id of the value. format uuid title Value Id type string kiara_id description The id of the kiara context this value belongs to. format uuid title Kiara Id type string value_schema $ref #/$defs/ValueSchema description The schema that was used for this Value. value_created description The time this value was created. format date-time title Value Created type string value_status $ref #/$defs/ValueStatus description The set/unset status of this value. value_size description The size of this value, in bytes. title Value Size type integer value_hash description The hash of this value. title Value Hash type string pedigree $ref #/$defs/ValuePedigree description Information about the module and inputs that went into creating this value. pedigree_output_name description The output name that produced this value (using the manifest inside the pedigree). title Pedigree Output Name type string data_type_info $ref #/$defs/DataTypeInfo description Information about the underlying data type and it's configuration. aliases anyOf items type string type array type null description The aliases that are registered for this value. title Aliases serialized anyOf $ref #/$defs/PersistedData type null description Details for the serialization process that was used for this value. properties anyOf additionalProperties True type object type null default None description Property data for this value. title Properties destiny_links anyOf additionalProperties format uuid type string type object type null description References to all the values that act as destiny for this value in this context. title Destiny Links environment_hashes additionalProperties additionalProperties type string type object description Hashes for the environments this value was created in. title Environment Hashes type object enviroments anyOf additionalProperties additionalProperties True type object type object type null default None description Information about the environments this value was created in. title Enviroments property_links additionalProperties format uuid type string description Links to values that are properties of this value. title Property Links type object destiny_backlinks additionalProperties type string description Backlinks to values that this value acts as destiny/or property for. propertyNames format uuid title Destiny Backlinks type object is_internal default False description Whether this value is only used internally in kiara. title Is Internal type boolean is_persisted description Whether this value is stored in at least one data store. title Is Persisted type boolean required type_name documentation authors context value_id kiara_id value_schema value_created value_status value_size value_hash pedigree pedigree_output_name data_type_info aliases serialized destiny_links environment_hashes is_persisted title ValueInfo type object	The (json) schema for this model data.

info.pipeline_structure

type_name	info.pipeline_structure	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DataTypeCharacteristics properties is_scalar default False description Whether the data desribed by this data type behaves like a skalar. title Is Scalar type boolean is_json_serializable default False description Whether the data can be serialized to json without information loss. title Is Json Serializable type boolean title DataTypeCharacteristics type object DataTypeInfo additionalProperties False properties data_type_name description The registered name of this data type. title Data Type Name type string data_type_config additionalProperties True description The (optional) configuration for this data type. title Data Type Config type object characteristics $ref #/$defs/DataTypeCharacteristics description Characteristics of this data type. data_type_class $ref #/$defs/PythonClass description The python class that is associated with this model. required data_type_name characteristics data_type_class title DataTypeInfo type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object FieldInfo properties field_name description The field name. title Field Name type string field_schema $ref #/$defs/ValueSchema description The schema of the field. data_type_info $ref #/$defs/DataTypeInfo description Information about the data type instance of the associated value. value_required description Whether user input is required (meaning: 'optional' is False, and no default set). title Value Required type boolean required field_name field_schema data_type_info value_required title FieldInfo type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object 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" } } ``` properties constants additionalProperties True description Value constants for this module. title Constants type object defaults additionalProperties True description Value defaults for this module. title Defaults type object pipeline_name description The name of this pipeline. title Pipeline Name type string steps description A list of steps/modules of this pipeline, and their connections. items $ref #/$defs/PipelineStep title Steps type array input_aliases additionalProperties type string 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. title Input Aliases type object output_aliases additionalProperties type string 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. title Output Aliases type object doc $ref #/$defs/DocumentationMetadataModel default -- n/a -- description Documentation about what the pipeline does. context additionalProperties True description Metadata for this workflow. title Context type object required pipeline_name steps input_aliases output_aliases title PipelineConfig type object PipelineInputRef additionalProperties False description An input to a pipeline. properties value_name title Value Name type string value_schema $ref #/$defs/ValueSchema connected_inputs description The step inputs that are connected to this pipeline input items $ref #/$defs/StepValueAddress title Connected Inputs type array is_constant description Whether this input is a constant and can't be changed by the user. title Is Constant type boolean required value_name value_schema is_constant title PipelineInputRef type object PipelineOutputRef additionalProperties False description An output to a pipeline. properties value_name title Value Name type string value_schema $ref #/$defs/ValueSchema connected_output $ref #/$defs/StepValueAddress description Connected step outputs. required value_name value_schema connected_output title PipelineOutputRef type object PipelineStep additionalProperties False description A step within a pipeline-structure, includes information about it's connection(s) and other metadata. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The module config. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean step_id description Locally unique id (within a pipeline) of this step. title Step Id type string manifest_src $ref #/$defs/Manifest description The original manfifest provided by the user. input_links additionalProperties items $ref #/$defs/StepValueAddress type array description The links that connect to inputs of the module. Keys are field names, value(s) are connected outputs. title Input Links type object module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. doc $ref #/$defs/DocumentationMetadataModel description A description what this step does. required module_type step_id manifest_src module_details doc title PipelineStep type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object StepInfo additionalProperties False properties step $ref #/$defs/PipelineStep description The pipeline step object. inputs additionalProperties $ref #/$defs/StepInputRef description Reference(s) to the fields that feed this steps inputs. title Inputs type object outputs additionalProperties $ref #/$defs/StepOutputRef description Reference(s) to the fields that are fed by this steps outputs. title Outputs type object required description Whether this step is always required or whether all his outputs feed into optional input fields. title Required type boolean doc $ref #/$defs/DocumentationMetadataModel description The step documentation. required step inputs outputs required title StepInfo type object StepInputRef additionalProperties False description An input to a step. This object can either have a 'connected_outputs' set, or a 'connected_pipeline_input', not both. properties value_name title Value Name type string value_schema $ref #/$defs/ValueSchema step_id description The step id. title Step Id type string connected_outputs anyOf items $ref #/$defs/StepValueAddress type array type null default None description A potential connected list of one or several module outputs. title Connected Outputs connected_pipeline_input anyOf type string type null default None description A potential pipeline input. title Connected Pipeline Input is_constant description Whether this input is a constant and can't be changed by the user. title Is Constant type boolean required value_name value_schema step_id is_constant title StepInputRef type object StepOutputRef additionalProperties False description An output to a step. properties value_name title Value Name type string value_schema $ref #/$defs/ValueSchema step_id description The step id. title Step Id type string pipeline_output anyOf type string type null description The connected pipeline output. title Pipeline Output connected_inputs description The step inputs that are connected to this step output items $ref #/$defs/StepValueAddress title Connected Inputs type array required value_name value_schema step_id pipeline_output title StepOutputRef type object StepValueAddress additionalProperties False description Small model to describe the address of a value of a step, within a Pipeline/PipelineStructure. properties step_id description The id of a step within a pipeline. title Step Id type string value_name description The name of the value (output name or pipeline input name). title Value Name type string sub_value anyOf additionalProperties True type object type null default None description A reference to a subitem of a value (e.g. column, list item) title Sub Value required step_id value_name title StepValueAddress type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). pipeline_config $ref #/$defs/PipelineConfig description The underlying pipeline config. pipeline_config_orig additionalProperties True description The original, user-provided pipeline config. title Pipeline Config Orig type object step_details additionalProperties $ref #/$defs/StepInfo description Additional information for each step. title Step Details type object input_aliases additionalProperties type string description The input aliases. title Input Aliases type object output_aliases additionalProperties type string description The output aliases. title Output Aliases type object constants additionalProperties True description The input constants for this pipeline. title Constants type object defaults additionalProperties True description The default inputs for this pipeline. title Defaults type object pipeline_input_fields additionalProperties $ref #/$defs/FieldInfo description The pipeline inputs schema. title Pipeline Input Fields type object pipeline_output_fields additionalProperties $ref #/$defs/FieldInfo description The pipeline outputs schema. title Pipeline Output Fields type object pipeline_input_refs additionalProperties $ref #/$defs/PipelineInputRef description References to the step inputs that are linked to pipeline inputs. title Pipeline Input Refs type object pipeline_output_refs additionalProperties $ref #/$defs/PipelineOutputRef description References to the step outputs that are linked to pipeline outputs. title Pipeline Output Refs type object execution_graph additionalProperties True description Data describing the execution graph of this pipeline. title Execution Graph type object data_flow_graph additionalProperties True description Data describing the data flow of this pipeline. title Data Flow Graph type object data_flow_graph_simple additionalProperties True description Data describing the (simplified) data flow of this pipeline. title Data Flow Graph Simple type object processing_stages description A list of lists, containing all the step_ids per stage, in the order of execution. items items type string type array title Processing Stages type array 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 title PipelineStructureInfo type object	The (json) schema for this model data.

info.operation

type_name	info.operation	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DataTypeCharacteristics properties is_scalar default False description Whether the data desribed by this data type behaves like a skalar. title Is Scalar type boolean is_json_serializable default False description Whether the data can be serialized to json without information loss. title Is Json Serializable type boolean title DataTypeCharacteristics type object DataTypeInfo additionalProperties False properties data_type_name description The registered name of this data type. title Data Type Name type string data_type_config additionalProperties True description The (optional) configuration for this data type. title Data Type Config type object characteristics $ref #/$defs/DataTypeCharacteristics description Characteristics of this data type. data_type_class $ref #/$defs/PythonClass description The python class that is associated with this model. required data_type_name characteristics data_type_class title DataTypeInfo type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object FieldInfo properties field_name description The field name. title Field Name type string field_schema $ref #/$defs/ValueSchema description The schema of the field. data_type_info $ref #/$defs/DataTypeInfo description Information about the data type instance of the associated value. value_required description Whether user input is required (meaning: 'optional' is False, and no default set). title Value Required type boolean required field_name field_schema data_type_info value_required title FieldInfo type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object Operation additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean operation_id description The (unique) id of this operation. title Operation Id type string operation_details $ref #/$defs/OperationDetails description The operation specific details of this operation. doc $ref #/$defs/DocumentationMetadataModel description Documentation for this operation. module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. metadata additionalProperties True description Additional metadata for this operation. title Metadata type object required module_type operation_id operation_details doc module_details title Operation type object OperationDetails additionalProperties False properties operation_id description The id of the operation. title Operation Id type string is_internal_operation default False description Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). title Is Internal Operation type boolean required operation_id title OperationDetails type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). operation $ref #/$defs/Operation description The operation instance. operation_types description The operation types this operation belongs to. items type string title Operation Types type array input_fields additionalProperties $ref #/$defs/FieldInfo description The inputs schema for this operation. title Input Fields type object output_fields additionalProperties $ref #/$defs/FieldInfo description The outputs schema for this operation. title Output Fields type object required type_name documentation authors context operation operation_types input_fields output_fields title OperationInfo type object	The (json) schema for this model data.

renderer_info

type_name	renderer_info	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). renderer_config additionalProperties True description The renderer config. title Renderer Config type object renderer_cls $ref #/$defs/PythonClass description The Python class that implements the renderer. supported_inputs description Descriptions of the supported inputs. items type string title Supported Inputs type array supported_source_types description Descriptions of the supported source types. items type string title Supported Source Types type array supported_target_types description Descriptions of the supported target types. items type string title Supported Target Types type array supported_python_classes description A list of supported Python types that are acceptable as inputs. items $ref #/$defs/PythonClass title Supported Python Classes type array required type_name documentation authors context renderer_config renderer_cls supported_inputs supported_source_types supported_target_types supported_python_classes title RendererInfo type object	The (json) schema for this model data.

kiara_plugin_info

type_name	kiara_plugin_info	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name KiaraPluginInfo 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.KiaraPluginInfo The full class namespace.	The python class that implements this module type.
metadata_schema	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DataTypeCharacteristics properties is_scalar default False description Whether the data desribed by this data type behaves like a skalar. title Is Scalar type boolean is_json_serializable default False description Whether the data can be serialized to json without information loss. title Is Json Serializable type boolean title DataTypeCharacteristics type object DataTypeClassInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. value_cls $ref #/$defs/PythonClass description The python class of the value itself. data_type_config_cls $ref #/$defs/PythonClass description The python class holding the schema for configuring this type. lineage anyOf items type string type array type null description This types lineage. title Lineage qualifier_profiles anyOf additionalProperties additionalProperties True type object type object type null description A map of qualifier profiles for this data types. title Qualifier Profiles supported_properties $ref #/$defs/MetadataTypeClassesInfo description The supported property types for this data type. required type_name documentation authors context python_class value_cls data_type_config_cls lineage qualifier_profiles supported_properties title DataTypeClassInfo type object DataTypeClassesInfo additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/DataTypeClassInfo description The data_type info instances for each type. title Item Infos type object type_name const data_type default data_type title Type Name type string required item_infos title DataTypeClassesInfo type object DataTypeInfo additionalProperties False properties data_type_name description The registered name of this data type. title Data Type Name type string data_type_config additionalProperties True description The (optional) configuration for this data type. title Data Type Config type object characteristics $ref #/$defs/DataTypeCharacteristics description Characteristics of this data type. data_type_class $ref #/$defs/PythonClass description The python class that is associated with this model. required data_type_name characteristics data_type_class title DataTypeInfo type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object FieldInfo properties field_name description The field name. title Field Name type string field_schema $ref #/$defs/ValueSchema description The schema of the field. data_type_info $ref #/$defs/DataTypeInfo description Information about the data type instance of the associated value. value_required description Whether user input is required (meaning: 'optional' is False, and no default set). title Value Required type boolean required field_name field_schema data_type_info value_required title FieldInfo type object KiaraModelClassesInfo additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/KiaraModelTypeInfo description The value metadata info instances for each type. title Item Infos type object type_name const kiara_model default kiara_model title Type Name type string required item_infos title KiaraModelClassesInfo type object KiaraModelTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. metadata_schema additionalProperties True description The (json) schema for this model data. title Metadata Schema type object required type_name documentation authors context python_class metadata_schema title KiaraModelTypeInfo type object KiaraModuleConfigMetadata additionalProperties False properties python_class $ref #/$defs/PythonClass description The config model python class. config_values additionalProperties $ref #/$defs/ValueTypeAndDescription description The available configuration values. title Config Values type object required python_class config_values title KiaraModuleConfigMetadata type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object MetadataTypeClassesInfo additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/MetadataTypeInfo description The value metadata info instances for each type. title Item Infos type object type_name const value_metadata default value_metadata title Type Name type string required item_infos title MetadataTypeClassesInfo type object MetadataTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. metadata_schema additionalProperties True description The (json) schema for this metadata value. title Metadata Schema type object required type_name documentation authors context python_class metadata_schema title MetadataTypeInfo type object ModuleTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. module_config $ref #/$defs/KiaraModuleConfigMetadata description The module config metadata. module_src description The source code of the process method of the module. title Module Src type string required type_name documentation authors context python_class module_config module_src title ModuleTypeInfo type object ModuleTypesInfo additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/ModuleTypeInfo description The module type info instances for each type. title Item Infos type object type_name const module_type default module_type title Type Name type string required item_infos title ModuleTypesInfo type object Operation additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean operation_id description The (unique) id of this operation. title Operation Id type string operation_details $ref #/$defs/OperationDetails description The operation specific details of this operation. doc $ref #/$defs/DocumentationMetadataModel description Documentation for this operation. module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. metadata additionalProperties True description Additional metadata for this operation. title Metadata type object required module_type operation_id operation_details doc module_details title Operation type object OperationDetails additionalProperties False properties operation_id description The id of the operation. title Operation Id type string is_internal_operation default False description Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). title Is Internal Operation type boolean required operation_id title OperationDetails type object OperationGroupInfo additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/OperationInfo description The operation info instances for each type. title Item Infos type object required item_infos title OperationGroupInfo type object OperationInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). operation $ref #/$defs/Operation description The operation instance. operation_types description The operation types this operation belongs to. items type string title Operation Types type array input_fields additionalProperties $ref #/$defs/FieldInfo description The inputs schema for this operation. title Input Fields type object output_fields additionalProperties $ref #/$defs/FieldInfo description The outputs schema for this operation. title Output Fields type object required type_name documentation authors context operation operation_types input_fields output_fields title OperationInfo type object OperationTypeClassesInfo additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/OperationTypeInfo description The operation info instances for each type. title Item Infos type object type_name const operation_type default operation_type title Type Name type string required item_infos title OperationTypeClassesInfo type object OperationTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. required type_name documentation authors context python_class title OperationTypeInfo type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object ValueTypeAndDescription properties description description The description for the value. title Description type string type description The value type. title Type type string value_default default None description Default for the value. title Value Default required description Whether this value is required title Required type boolean required description type required title ValueTypeAndDescription type object additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). version description The version of the plugin. title Version type string data_types $ref #/$defs/DataTypeClassesInfo description The included data types. module_types $ref #/$defs/ModuleTypesInfo description The included kiara module types. kiara_model_types $ref #/$defs/KiaraModelClassesInfo description The included model classes. operation_types $ref #/$defs/OperationTypeClassesInfo description The included operation types. operations $ref #/$defs/OperationGroupInfo description The included operations. required type_name documentation authors context version data_types module_types kiara_model_types operation_types operations title KiaraPluginInfo type object	The (json) schema for this model data.

job_info

type_name	job_info	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name JobInfo 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.JobInfo The full class namespace.	The python class that implements this module type.
metadata_schema	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DataTypeCharacteristics properties is_scalar default False description Whether the data desribed by this data type behaves like a skalar. title Is Scalar type boolean is_json_serializable default False description Whether the data can be serialized to json without information loss. title Is Json Serializable type boolean title DataTypeCharacteristics type object DataTypeInfo additionalProperties False properties data_type_name description The registered name of this data type. title Data Type Name type string data_type_config additionalProperties True description The (optional) configuration for this data type. title Data Type Config type object characteristics $ref #/$defs/DataTypeCharacteristics description Characteristics of this data type. data_type_class $ref #/$defs/PythonClass description The python class that is associated with this model. required data_type_name characteristics data_type_class title DataTypeInfo type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object FieldInfo properties field_name description The field name. title Field Name type string field_schema $ref #/$defs/ValueSchema description The schema of the field. data_type_info $ref #/$defs/DataTypeInfo description Information about the data type instance of the associated value. value_required description Whether user input is required (meaning: 'optional' is False, and no default set). title Value Required type boolean required field_name field_schema data_type_info value_required title FieldInfo type object JobLog properties log description The logs for this job. items $ref #/$defs/LogMessage title Log type array percent_finished default -1 description Describes how much of the job is finished. A negative number means the module does not support progress tracking. title Percent Finished type integer title JobLog type object JobRecord additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean inputs additionalProperties format uuid type string description A map of all the input fields and value references. title Inputs type object pipeline_metadata anyOf $ref #/$defs/PipelineMetadata type null default None description Metadata for the pipeline this job is part of. job_id description The globally unique id for this job. format uuid title Job Id type string job_submitted description When the job was submitted. format date-time title Job Submitted type string environment_hashes additionalProperties type string description Hashes for the environments this value was created in. title Environment Hashes type object is_internal description Whether this job was created by the system. title Is Internal type boolean inputs_data_hash description A map of the hashes of this jobs inputs (the hashes of field names and the actual bytes). title Inputs Data Hash type string outputs additionalProperties format uuid type string description References to the job outputs. title Outputs type object runtime_details anyOf $ref #/$defs/JobRuntimeDetails type null description Runtime details for the job. required module_type inputs job_id job_submitted environment_hashes is_internal inputs_data_hash outputs runtime_details title JobRecord type object JobRuntimeDetails properties job_log $ref #/$defs/JobLog description The lob jog. submitted description When the job was submitted. format date-time title Submitted type string started description When the job was started. format date-time title Started type string finished description When the job was finished. format date-time title Finished type string runtime description The duration of the job (in seconds). title Runtime type number required job_log submitted started finished runtime title JobRuntimeDetails type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object LogMessage properties timestamp description The time the message was logged. format date-time title Timestamp type string log_level description The log level. title Log Level type integer msg description The log message title Msg type string required log_level msg title LogMessage type object Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object Operation additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean operation_id description The (unique) id of this operation. title Operation Id type string operation_details $ref #/$defs/OperationDetails description The operation specific details of this operation. doc $ref #/$defs/DocumentationMetadataModel description Documentation for this operation. module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. metadata additionalProperties True description Additional metadata for this operation. title Metadata type object required module_type operation_id operation_details doc module_details title Operation type object OperationDetails additionalProperties False properties operation_id description The id of the operation. title Operation Id type string is_internal_operation default False description Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). title Is Internal Operation type boolean required operation_id title OperationDetails type object OperationInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). operation $ref #/$defs/Operation description The operation instance. operation_types description The operation types this operation belongs to. items type string title Operation Types type array input_fields additionalProperties $ref #/$defs/FieldInfo description The inputs schema for this operation. title Input Fields type object output_fields additionalProperties $ref #/$defs/FieldInfo description The outputs schema for this operation. title Output Fields type object required type_name documentation authors context operation operation_types input_fields output_fields title OperationInfo type object PersistedData additionalProperties False properties data_type description The name of the data type for this serialized value. title Data Type type string data_type_config additionalProperties True description The (optional) config for the data type for this serialized value. title Data Type Config type object serialization_profile description An identifying name for the serialization method used. title Serialization Profile type string metadata $ref #/$defs/SerializationMetadata description Optional metadata describing aspects of the serialization used. hash_codec default sha2-256 description The codec used to hash the value. title Hash Codec type string archive_id description The id of the store that persisted the data. format uuid title Archive Id type string chunk_id_map additionalProperties $ref #/$defs/SerializedChunkIDs description Reference-ids that resolve to the values' serialized chunks. title Chunk Id Map type object required data_type serialization_profile archive_id chunk_id_map title PersistedData type object PipelineMetadata properties pipeline_id description The id of the pipeline. format uuid title Pipeline Id type string step_id description The id of the step in the pipeline. title Step Id type string required pipeline_id step_id title PipelineMetadata type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object SerializationMetadata additionalProperties False properties environment additionalProperties type integer description Hash(es) for the environments the value was created/serialized. title Environment type object deserialize additionalProperties $ref #/$defs/Manifest description Suggested manifest configs to use to de-serialize the data. title Deserialize type object title SerializationMetadata type object SerializedChunkIDs additionalProperties False properties type const chunk-ids default chunk-ids title Type type string chunk_id_list description A list of chunk ids, which will be resolved via the attached data registry. items type string title Chunk Id List type array archive_id anyOf format uuid type string type null default None description The preferred data archive to get the chunks from. title Archive Id size description The size of all chunks combined. title Size type integer required chunk_id_list size title SerializedChunkIDs type object ValueInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). value_id description The id of the value. format uuid title Value Id type string kiara_id description The id of the kiara context this value belongs to. format uuid title Kiara Id type string value_schema $ref #/$defs/ValueSchema description The schema that was used for this Value. value_created description The time this value was created. format date-time title Value Created type string value_status $ref #/$defs/ValueStatus description The set/unset status of this value. value_size description The size of this value, in bytes. title Value Size type integer value_hash description The hash of this value. title Value Hash type string pedigree $ref #/$defs/ValuePedigree description Information about the module and inputs that went into creating this value. pedigree_output_name description The output name that produced this value (using the manifest inside the pedigree). title Pedigree Output Name type string data_type_info $ref #/$defs/DataTypeInfo description Information about the underlying data type and it's configuration. aliases anyOf items type string type array type null description The aliases that are registered for this value. title Aliases serialized anyOf $ref #/$defs/PersistedData type null description Details for the serialization process that was used for this value. properties anyOf additionalProperties True type object type null default None description Property data for this value. title Properties destiny_links anyOf additionalProperties format uuid type string type object type null description References to all the values that act as destiny for this value in this context. title Destiny Links environment_hashes additionalProperties additionalProperties type string type object description Hashes for the environments this value was created in. title Environment Hashes type object enviroments anyOf additionalProperties additionalProperties True type object type object type null default None description Information about the environments this value was created in. title Enviroments property_links additionalProperties format uuid type string description Links to values that are properties of this value. title Property Links type object destiny_backlinks additionalProperties type string description Backlinks to values that this value acts as destiny/or property for. propertyNames format uuid title Destiny Backlinks type object is_internal default False description Whether this value is only used internally in kiara. title Is Internal type boolean is_persisted description Whether this value is stored in at least one data store. title Is Persisted type boolean required type_name documentation authors context value_id kiara_id value_schema value_created value_status value_size value_hash pedigree pedigree_output_name data_type_info aliases serialized destiny_links environment_hashes is_persisted title ValueInfo type object ValuePedigree additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean inputs additionalProperties format uuid type string description A map of all the input fields and value references. title Inputs type object kiara_id description The id of the kiara context a value was created in. format uuid title Kiara Id type string environments additionalProperties type string description References to the runtime environment details a value was created in. title Environments type object required module_type inputs kiara_id environments title ValuePedigree type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object ValueStatus enum unknown not set none default set title ValueStatus type string additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). job_record $ref #/$defs/JobRecord description The job record instance. operation $ref #/$defs/OperationInfo description The operation info instance. inputs additionalProperties $ref #/$defs/ValueInfo description The inputs. title Inputs type object outputs additionalProperties $ref #/$defs/ValueInfo description The result(s). title Outputs type object required type_name documentation authors context job_record operation inputs outputs title JobInfo type object	The (json) schema for this model data.

info.kiara_models

type_name	info.kiara_models	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object KiaraModelTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. metadata_schema additionalProperties True description The (json) schema for this model data. title Metadata Schema type object required type_name documentation authors context python_class metadata_schema title KiaraModelTypeInfo type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/KiaraModelTypeInfo description The value metadata info instances for each type. title Item Infos type object type_name const kiara_model default kiara_model title Type Name type string required item_infos title KiaraModelClassesInfo type object	The (json) schema for this model data.

info.metadata_types

type_name	info.metadata_types	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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.interfaces.python_api.models.info The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.info.MetadataTypeClassesInfo The full class namespace.	The python class that implements this module type.
metadata_schema	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object MetadataTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. metadata_schema additionalProperties True description The (json) schema for this metadata value. title Metadata Schema type object required type_name documentation authors context python_class metadata_schema title MetadataTypeInfo type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/MetadataTypeInfo description The value metadata info instances for each type. title Item Infos type object type_name const value_metadata default value_metadata title Type Name type string required item_infos title MetadataTypeClassesInfo type object	The (json) schema for this model data.

info.data_types

type_name	info.data_types	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DataTypeClassInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. value_cls $ref #/$defs/PythonClass description The python class of the value itself. data_type_config_cls $ref #/$defs/PythonClass description The python class holding the schema for configuring this type. lineage anyOf items type string type array type null description This types lineage. title Lineage qualifier_profiles anyOf additionalProperties additionalProperties True type object type object type null description A map of qualifier profiles for this data types. title Qualifier Profiles supported_properties $ref #/$defs/MetadataTypeClassesInfo description The supported property types for this data type. required type_name documentation authors context python_class value_cls data_type_config_cls lineage qualifier_profiles supported_properties title DataTypeClassInfo type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object MetadataTypeClassesInfo additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/MetadataTypeInfo description The value metadata info instances for each type. title Item Infos type object type_name const value_metadata default value_metadata title Type Name type string required item_infos title MetadataTypeClassesInfo type object MetadataTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. metadata_schema additionalProperties True description The (json) schema for this metadata value. title Metadata Schema type object required type_name documentation authors context python_class metadata_schema title MetadataTypeInfo type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/DataTypeClassInfo description The data_type info instances for each type. title Item Infos type object type_name const data_type default data_type title Type Name type string required item_infos title DataTypeClassesInfo type object	The (json) schema for this model data.

info.module_types

type_name	info.module_types	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object KiaraModuleConfigMetadata additionalProperties False properties python_class $ref #/$defs/PythonClass description The config model python class. config_values additionalProperties $ref #/$defs/ValueTypeAndDescription description The available configuration values. title Config Values type object required python_class config_values title KiaraModuleConfigMetadata type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object ModuleTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. module_config $ref #/$defs/KiaraModuleConfigMetadata description The module config metadata. module_src description The source code of the process method of the module. title Module Src type string required type_name documentation authors context python_class module_config module_src title ModuleTypeInfo type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object ValueTypeAndDescription properties description description The description for the value. title Description type string type description The value type. title Type type string value_default default None description Default for the value. title Value Default required description Whether this value is required title Required type boolean required description type required title ValueTypeAndDescription type object additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/ModuleTypeInfo description The module type info instances for each type. title Item Infos type object type_name const module_type default module_type title Type Name type string required item_infos title ModuleTypesInfo type object	The (json) schema for this model data.

info.operation_types

type_name	info.operation_types	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object OperationTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. required type_name documentation authors context python_class title OperationTypeInfo type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/OperationTypeInfo description The operation info instances for each type. title Item Infos type object type_name const operation_type default operation_type title Type Name type string required item_infos title OperationTypeClassesInfo type object	The (json) schema for this model data.

values_info

type_name	values_info	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DataTypeCharacteristics properties is_scalar default False description Whether the data desribed by this data type behaves like a skalar. title Is Scalar type boolean is_json_serializable default False description Whether the data can be serialized to json without information loss. title Is Json Serializable type boolean title DataTypeCharacteristics type object DataTypeInfo additionalProperties False properties data_type_name description The registered name of this data type. title Data Type Name type string data_type_config additionalProperties True description The (optional) configuration for this data type. title Data Type Config type object characteristics $ref #/$defs/DataTypeCharacteristics description Characteristics of this data type. data_type_class $ref #/$defs/PythonClass description The python class that is associated with this model. required data_type_name characteristics data_type_class title DataTypeInfo type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object PersistedData additionalProperties False properties data_type description The name of the data type for this serialized value. title Data Type type string data_type_config additionalProperties True description The (optional) config for the data type for this serialized value. title Data Type Config type object serialization_profile description An identifying name for the serialization method used. title Serialization Profile type string metadata $ref #/$defs/SerializationMetadata description Optional metadata describing aspects of the serialization used. hash_codec default sha2-256 description The codec used to hash the value. title Hash Codec type string archive_id description The id of the store that persisted the data. format uuid title Archive Id type string chunk_id_map additionalProperties $ref #/$defs/SerializedChunkIDs description Reference-ids that resolve to the values' serialized chunks. title Chunk Id Map type object required data_type serialization_profile archive_id chunk_id_map title PersistedData type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object SerializationMetadata additionalProperties False properties environment additionalProperties type integer description Hash(es) for the environments the value was created/serialized. title Environment type object deserialize additionalProperties $ref #/$defs/Manifest description Suggested manifest configs to use to de-serialize the data. title Deserialize type object title SerializationMetadata type object SerializedChunkIDs additionalProperties False properties type const chunk-ids default chunk-ids title Type type string chunk_id_list description A list of chunk ids, which will be resolved via the attached data registry. items type string title Chunk Id List type array archive_id anyOf format uuid type string type null default None description The preferred data archive to get the chunks from. title Archive Id size description The size of all chunks combined. title Size type integer required chunk_id_list size title SerializedChunkIDs type object ValueInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). value_id description The id of the value. format uuid title Value Id type string kiara_id description The id of the kiara context this value belongs to. format uuid title Kiara Id type string value_schema $ref #/$defs/ValueSchema description The schema that was used for this Value. value_created description The time this value was created. format date-time title Value Created type string value_status $ref #/$defs/ValueStatus description The set/unset status of this value. value_size description The size of this value, in bytes. title Value Size type integer value_hash description The hash of this value. title Value Hash type string pedigree $ref #/$defs/ValuePedigree description Information about the module and inputs that went into creating this value. pedigree_output_name description The output name that produced this value (using the manifest inside the pedigree). title Pedigree Output Name type string data_type_info $ref #/$defs/DataTypeInfo description Information about the underlying data type and it's configuration. aliases anyOf items type string type array type null description The aliases that are registered for this value. title Aliases serialized anyOf $ref #/$defs/PersistedData type null description Details for the serialization process that was used for this value. properties anyOf additionalProperties True type object type null default None description Property data for this value. title Properties destiny_links anyOf additionalProperties format uuid type string type object type null description References to all the values that act as destiny for this value in this context. title Destiny Links environment_hashes additionalProperties additionalProperties type string type object description Hashes for the environments this value was created in. title Environment Hashes type object enviroments anyOf additionalProperties additionalProperties True type object type object type null default None description Information about the environments this value was created in. title Enviroments property_links additionalProperties format uuid type string description Links to values that are properties of this value. title Property Links type object destiny_backlinks additionalProperties type string description Backlinks to values that this value acts as destiny/or property for. propertyNames format uuid title Destiny Backlinks type object is_internal default False description Whether this value is only used internally in kiara. title Is Internal type boolean is_persisted description Whether this value is stored in at least one data store. title Is Persisted type boolean required type_name documentation authors context value_id kiara_id value_schema value_created value_status value_size value_hash pedigree pedigree_output_name data_type_info aliases serialized destiny_links environment_hashes is_persisted title ValueInfo type object ValuePedigree additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean inputs additionalProperties format uuid type string description A map of all the input fields and value references. title Inputs type object kiara_id description The id of the kiara context a value was created in. format uuid title Kiara Id type string environments additionalProperties type string description References to the runtime environment details a value was created in. title Environments type object required module_type inputs kiara_id environments title ValuePedigree type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object ValueStatus enum unknown not set none default set title ValueStatus type string additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/ValueInfo description The info items. title Item Infos type object required item_infos title ValuesInfo type object	The (json) schema for this model data.

info.operations

type_name	info.operations	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DataTypeCharacteristics properties is_scalar default False description Whether the data desribed by this data type behaves like a skalar. title Is Scalar type boolean is_json_serializable default False description Whether the data can be serialized to json without information loss. title Is Json Serializable type boolean title DataTypeCharacteristics type object DataTypeInfo additionalProperties False properties data_type_name description The registered name of this data type. title Data Type Name type string data_type_config additionalProperties True description The (optional) configuration for this data type. title Data Type Config type object characteristics $ref #/$defs/DataTypeCharacteristics description Characteristics of this data type. data_type_class $ref #/$defs/PythonClass description The python class that is associated with this model. required data_type_name characteristics data_type_class title DataTypeInfo type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object FieldInfo properties field_name description The field name. title Field Name type string field_schema $ref #/$defs/ValueSchema description The schema of the field. data_type_info $ref #/$defs/DataTypeInfo description Information about the data type instance of the associated value. value_required description Whether user input is required (meaning: 'optional' is False, and no default set). title Value Required type boolean required field_name field_schema data_type_info value_required title FieldInfo type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object Operation additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean operation_id description The (unique) id of this operation. title Operation Id type string operation_details $ref #/$defs/OperationDetails description The operation specific details of this operation. doc $ref #/$defs/DocumentationMetadataModel description Documentation for this operation. module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. metadata additionalProperties True description Additional metadata for this operation. title Metadata type object required module_type operation_id operation_details doc module_details title Operation type object OperationDetails additionalProperties False properties operation_id description The id of the operation. title Operation Id type string is_internal_operation default False description Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). title Is Internal Operation type boolean required operation_id title OperationDetails type object OperationInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). operation $ref #/$defs/Operation description The operation instance. operation_types description The operation types this operation belongs to. items type string title Operation Types type array input_fields additionalProperties $ref #/$defs/FieldInfo description The inputs schema for this operation. title Input Fields type object output_fields additionalProperties $ref #/$defs/FieldInfo description The outputs schema for this operation. title Output Fields type object required type_name documentation authors context operation operation_types input_fields output_fields title OperationInfo type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/OperationInfo description The operation info instances for each type. title Item Infos type object required item_infos title OperationGroupInfo type object	The (json) schema for this model data.

renderer_infos

type_name	renderer_infos	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object RendererInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). renderer_config additionalProperties True description The renderer config. title Renderer Config type object renderer_cls $ref #/$defs/PythonClass description The Python class that implements the renderer. supported_inputs description Descriptions of the supported inputs. items type string title Supported Inputs type array supported_source_types description Descriptions of the supported source types. items type string title Supported Source Types type array supported_target_types description Descriptions of the supported target types. items type string title Supported Target Types type array supported_python_classes description A list of supported Python types that are acceptable as inputs. items $ref #/$defs/PythonClass title Supported Python Classes type array required type_name documentation authors context renderer_config renderer_cls supported_inputs supported_source_types supported_target_types supported_python_classes title RendererInfo type object additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/RendererInfo description The info items. title Item Infos type object required item_infos title RendererInfos type object	The (json) schema for this model data.

kiara_plugin_infos

type_name	kiara_plugin_infos	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name KiaraPluginInfos 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.KiaraPluginInfos The full class namespace.	The python class that implements this module type.
metadata_schema	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DataTypeCharacteristics properties is_scalar default False description Whether the data desribed by this data type behaves like a skalar. title Is Scalar type boolean is_json_serializable default False description Whether the data can be serialized to json without information loss. title Is Json Serializable type boolean title DataTypeCharacteristics type object DataTypeClassInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. value_cls $ref #/$defs/PythonClass description The python class of the value itself. data_type_config_cls $ref #/$defs/PythonClass description The python class holding the schema for configuring this type. lineage anyOf items type string type array type null description This types lineage. title Lineage qualifier_profiles anyOf additionalProperties additionalProperties True type object type object type null description A map of qualifier profiles for this data types. title Qualifier Profiles supported_properties $ref #/$defs/MetadataTypeClassesInfo description The supported property types for this data type. required type_name documentation authors context python_class value_cls data_type_config_cls lineage qualifier_profiles supported_properties title DataTypeClassInfo type object DataTypeClassesInfo additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/DataTypeClassInfo description The data_type info instances for each type. title Item Infos type object type_name const data_type default data_type title Type Name type string required item_infos title DataTypeClassesInfo type object DataTypeInfo additionalProperties False properties data_type_name description The registered name of this data type. title Data Type Name type string data_type_config additionalProperties True description The (optional) configuration for this data type. title Data Type Config type object characteristics $ref #/$defs/DataTypeCharacteristics description Characteristics of this data type. data_type_class $ref #/$defs/PythonClass description The python class that is associated with this model. required data_type_name characteristics data_type_class title DataTypeInfo type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object FieldInfo properties field_name description The field name. title Field Name type string field_schema $ref #/$defs/ValueSchema description The schema of the field. data_type_info $ref #/$defs/DataTypeInfo description Information about the data type instance of the associated value. value_required description Whether user input is required (meaning: 'optional' is False, and no default set). title Value Required type boolean required field_name field_schema data_type_info value_required title FieldInfo type object KiaraModelClassesInfo additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/KiaraModelTypeInfo description The value metadata info instances for each type. title Item Infos type object type_name const kiara_model default kiara_model title Type Name type string required item_infos title KiaraModelClassesInfo type object KiaraModelTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. metadata_schema additionalProperties True description The (json) schema for this model data. title Metadata Schema type object required type_name documentation authors context python_class metadata_schema title KiaraModelTypeInfo type object KiaraModuleConfigMetadata additionalProperties False properties python_class $ref #/$defs/PythonClass description The config model python class. config_values additionalProperties $ref #/$defs/ValueTypeAndDescription description The available configuration values. title Config Values type object required python_class config_values title KiaraModuleConfigMetadata type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object KiaraPluginInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). version description The version of the plugin. title Version type string data_types $ref #/$defs/DataTypeClassesInfo description The included data types. module_types $ref #/$defs/ModuleTypesInfo description The included kiara module types. kiara_model_types $ref #/$defs/KiaraModelClassesInfo description The included model classes. operation_types $ref #/$defs/OperationTypeClassesInfo description The included operation types. operations $ref #/$defs/OperationGroupInfo description The included operations. required type_name documentation authors context version data_types module_types kiara_model_types operation_types operations title KiaraPluginInfo type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object MetadataTypeClassesInfo additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/MetadataTypeInfo description The value metadata info instances for each type. title Item Infos type object type_name const value_metadata default value_metadata title Type Name type string required item_infos title MetadataTypeClassesInfo type object MetadataTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. metadata_schema additionalProperties True description The (json) schema for this metadata value. title Metadata Schema type object required type_name documentation authors context python_class metadata_schema title MetadataTypeInfo type object ModuleTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. module_config $ref #/$defs/KiaraModuleConfigMetadata description The module config metadata. module_src description The source code of the process method of the module. title Module Src type string required type_name documentation authors context python_class module_config module_src title ModuleTypeInfo type object ModuleTypesInfo additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/ModuleTypeInfo description The module type info instances for each type. title Item Infos type object type_name const module_type default module_type title Type Name type string required item_infos title ModuleTypesInfo type object Operation additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean operation_id description The (unique) id of this operation. title Operation Id type string operation_details $ref #/$defs/OperationDetails description The operation specific details of this operation. doc $ref #/$defs/DocumentationMetadataModel description Documentation for this operation. module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. metadata additionalProperties True description Additional metadata for this operation. title Metadata type object required module_type operation_id operation_details doc module_details title Operation type object OperationDetails additionalProperties False properties operation_id description The id of the operation. title Operation Id type string is_internal_operation default False description Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). title Is Internal Operation type boolean required operation_id title OperationDetails type object OperationGroupInfo additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/OperationInfo description The operation info instances for each type. title Item Infos type object required item_infos title OperationGroupInfo type object OperationInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). operation $ref #/$defs/Operation description The operation instance. operation_types description The operation types this operation belongs to. items type string title Operation Types type array input_fields additionalProperties $ref #/$defs/FieldInfo description The inputs schema for this operation. title Input Fields type object output_fields additionalProperties $ref #/$defs/FieldInfo description The outputs schema for this operation. title Output Fields type object required type_name documentation authors context operation operation_types input_fields output_fields title OperationInfo type object OperationTypeClassesInfo additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/OperationTypeInfo description The operation info instances for each type. title Item Infos type object type_name const operation_type default operation_type title Type Name type string required item_infos title OperationTypeClassesInfo type object OperationTypeInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). python_class $ref #/$defs/PythonClass description The python class that implements this module type. required type_name documentation authors context python_class title OperationTypeInfo type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object ValueTypeAndDescription properties description description The description for the value. title Description type string type description The value type. title Type type string value_default default None description Default for the value. title Value Default required description Whether this value is required title Required type boolean required description type required title ValueTypeAndDescription type object additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/KiaraPluginInfo description The info items. title Item Infos type object required item_infos title KiaraPluginInfos type object	The (json) schema for this model data.

jobs_info

type_name	jobs_info	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name JobsInfo 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.JobsInfo The full class namespace.	The python class that implements this module type.
metadata_schema	$defs AuthorModel description Details about an author of a resource. properties name description The full name of the author. title Name type string email anyOf format email type string type null default None description The email address of the author title Email required name title Author type object AuthorsMetadataModel description Information about all authors of a resource. properties authors description The authors/creators of this item. items $ref #/$defs/AuthorModel title Authors type array title Authors type object ContextMetadataModel description Information about the context of a resource. properties references additionalProperties $ref #/$defs/LinkModel description References for the item. title References type object tags description A list of tags for the item. items type string title Tags type array labels additionalProperties type string description A list of labels for the item. title Labels type object title Context type object DataTypeCharacteristics properties is_scalar default False description Whether the data desribed by this data type behaves like a skalar. title Is Scalar type boolean is_json_serializable default False description Whether the data can be serialized to json without information loss. title Is Json Serializable type boolean title DataTypeCharacteristics type object DataTypeInfo additionalProperties False properties data_type_name description The registered name of this data type. title Data Type Name type string data_type_config additionalProperties True description The (optional) configuration for this data type. title Data Type Config type object characteristics $ref #/$defs/DataTypeCharacteristics description Characteristics of this data type. data_type_class $ref #/$defs/PythonClass description The python class that is associated with this model. required data_type_name characteristics data_type_class title DataTypeInfo type object DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object FieldInfo properties field_name description The field name. title Field Name type string field_schema $ref #/$defs/ValueSchema description The schema of the field. data_type_info $ref #/$defs/DataTypeInfo description Information about the data type instance of the associated value. value_required description Whether user input is required (meaning: 'optional' is False, and no default set). title Value Required type boolean required field_name field_schema data_type_info value_required title FieldInfo type object JobInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). job_record $ref #/$defs/JobRecord description The job record instance. operation $ref #/$defs/OperationInfo description The operation info instance. inputs additionalProperties $ref #/$defs/ValueInfo description The inputs. title Inputs type object outputs additionalProperties $ref #/$defs/ValueInfo description The result(s). title Outputs type object required type_name documentation authors context job_record operation inputs outputs title JobInfo type object JobLog properties log description The logs for this job. items $ref #/$defs/LogMessage title Log type array percent_finished default -1 description Describes how much of the job is finished. A negative number means the module does not support progress tracking. title Percent Finished type integer title JobLog type object JobRecord additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean inputs additionalProperties format uuid type string description A map of all the input fields and value references. title Inputs type object pipeline_metadata anyOf $ref #/$defs/PipelineMetadata type null default None description Metadata for the pipeline this job is part of. job_id description The globally unique id for this job. format uuid title Job Id type string job_submitted description When the job was submitted. format date-time title Job Submitted type string environment_hashes additionalProperties type string description Hashes for the environments this value was created in. title Environment Hashes type object is_internal description Whether this job was created by the system. title Is Internal type boolean inputs_data_hash description A map of the hashes of this jobs inputs (the hashes of field names and the actual bytes). title Inputs Data Hash type string outputs additionalProperties format uuid type string description References to the job outputs. title Outputs type object runtime_details anyOf $ref #/$defs/JobRuntimeDetails type null description Runtime details for the job. required module_type inputs job_id job_submitted environment_hashes is_internal inputs_data_hash outputs runtime_details title JobRecord type object JobRuntimeDetails properties job_log $ref #/$defs/JobLog description The lob jog. submitted description When the job was submitted. format date-time title Submitted type string started description When the job was started. format date-time title Started type string finished description When the job was finished. format date-time title Finished type string runtime description The duration of the job (in seconds). title Runtime type number required job_log submitted started finished runtime title JobRuntimeDetails type object KiaraModuleInstance additionalProperties False properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string module_config additionalProperties True description The module config. title Module Config type object inputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module input(s). title Inputs Schema type object outputs_schema additionalProperties $ref #/$defs/ValueSchema description The schema for the module output(s). title Outputs Schema type object required python_class_name python_module_name full_name module_config inputs_schema outputs_schema title KiaraModuleInstance type object LinkModel description A description and url for a reference of any kind. properties url description The url. title Url type string desc anyOf type string type null default -- n/a -- description A short description of the link content. title Desc required url title Link type object LogMessage properties timestamp description The time the message was logged. format date-time title Timestamp type string log_level description The log level. title Log Level type integer msg description The log message title Msg type string required log_level msg title LogMessage type object Manifest additionalProperties False description A class to hold the type and configuration for a module instance. properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean required module_type title Manifest type object Operation additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean operation_id description The (unique) id of this operation. title Operation Id type string operation_details $ref #/$defs/OperationDetails description The operation specific details of this operation. doc $ref #/$defs/DocumentationMetadataModel description Documentation for this operation. module_details $ref #/$defs/KiaraModuleInstance description The class of the underlying module. metadata additionalProperties True description Additional metadata for this operation. title Metadata type object required module_type operation_id operation_details doc module_details title Operation type object OperationDetails additionalProperties False properties operation_id description The id of the operation. title Operation Id type string is_internal_operation default False description Whether this operation is mainly used kiara-internally. Helps to hide it in UIs (operation lists etc.). title Is Internal Operation type boolean required operation_id title OperationDetails type object OperationInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). operation $ref #/$defs/Operation description The operation instance. operation_types description The operation types this operation belongs to. items type string title Operation Types type array input_fields additionalProperties $ref #/$defs/FieldInfo description The inputs schema for this operation. title Input Fields type object output_fields additionalProperties $ref #/$defs/FieldInfo description The outputs schema for this operation. title Output Fields type object required type_name documentation authors context operation operation_types input_fields output_fields title OperationInfo type object PersistedData additionalProperties False properties data_type description The name of the data type for this serialized value. title Data Type type string data_type_config additionalProperties True description The (optional) config for the data type for this serialized value. title Data Type Config type object serialization_profile description An identifying name for the serialization method used. title Serialization Profile type string metadata $ref #/$defs/SerializationMetadata description Optional metadata describing aspects of the serialization used. hash_codec default sha2-256 description The codec used to hash the value. title Hash Codec type string archive_id description The id of the store that persisted the data. format uuid title Archive Id type string chunk_id_map additionalProperties $ref #/$defs/SerializedChunkIDs description Reference-ids that resolve to the values' serialized chunks. title Chunk Id Map type object required data_type serialization_profile archive_id chunk_id_map title PersistedData type object PipelineMetadata properties pipeline_id description The id of the pipeline. format uuid title Pipeline Id type string step_id description The id of the step in the pipeline. title Step Id type string required pipeline_id step_id title PipelineMetadata type object PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object SerializationMetadata additionalProperties False properties environment additionalProperties type integer description Hash(es) for the environments the value was created/serialized. title Environment type object deserialize additionalProperties $ref #/$defs/Manifest description Suggested manifest configs to use to de-serialize the data. title Deserialize type object title SerializationMetadata type object SerializedChunkIDs additionalProperties False properties type const chunk-ids default chunk-ids title Type type string chunk_id_list description A list of chunk ids, which will be resolved via the attached data registry. items type string title Chunk Id List type array archive_id anyOf format uuid type string type null default None description The preferred data archive to get the chunks from. title Archive Id size description The size of all chunks combined. title Size type integer required chunk_id_list size title SerializedChunkIDs type object ValueInfo additionalProperties False properties type_name description The registered name for this item type. title Type Name type string documentation $ref #/$defs/DocumentationMetadataModel description Documentation for the item. authors $ref #/$defs/AuthorsMetadataModel description Information about authorship for the item. context $ref #/$defs/ContextMetadataModel description Generic properties of this item (description, tags, labels, references, ...). value_id description The id of the value. format uuid title Value Id type string kiara_id description The id of the kiara context this value belongs to. format uuid title Kiara Id type string value_schema $ref #/$defs/ValueSchema description The schema that was used for this Value. value_created description The time this value was created. format date-time title Value Created type string value_status $ref #/$defs/ValueStatus description The set/unset status of this value. value_size description The size of this value, in bytes. title Value Size type integer value_hash description The hash of this value. title Value Hash type string pedigree $ref #/$defs/ValuePedigree description Information about the module and inputs that went into creating this value. pedigree_output_name description The output name that produced this value (using the manifest inside the pedigree). title Pedigree Output Name type string data_type_info $ref #/$defs/DataTypeInfo description Information about the underlying data type and it's configuration. aliases anyOf items type string type array type null description The aliases that are registered for this value. title Aliases serialized anyOf $ref #/$defs/PersistedData type null description Details for the serialization process that was used for this value. properties anyOf additionalProperties True type object type null default None description Property data for this value. title Properties destiny_links anyOf additionalProperties format uuid type string type object type null description References to all the values that act as destiny for this value in this context. title Destiny Links environment_hashes additionalProperties additionalProperties type string type object description Hashes for the environments this value was created in. title Environment Hashes type object enviroments anyOf additionalProperties additionalProperties True type object type object type null default None description Information about the environments this value was created in. title Enviroments property_links additionalProperties format uuid type string description Links to values that are properties of this value. title Property Links type object destiny_backlinks additionalProperties type string description Backlinks to values that this value acts as destiny/or property for. propertyNames format uuid title Destiny Backlinks type object is_internal default False description Whether this value is only used internally in kiara. title Is Internal type boolean is_persisted description Whether this value is stored in at least one data store. title Is Persisted type boolean required type_name documentation authors context value_id kiara_id value_schema value_created value_status value_size value_hash pedigree pedigree_output_name data_type_info aliases serialized destiny_links environment_hashes is_persisted title ValueInfo type object ValuePedigree additionalProperties False properties module_type description The module type. title Module Type type string module_config additionalProperties True description The configuration for the module. title Module Config type object is_resolved default False description Whether the configuration of this module was augmented with the module type defaults etc. title Is Resolved type boolean inputs additionalProperties format uuid type string description A map of all the input fields and value references. title Inputs type object kiara_id description The id of the kiara context a value was created in. format uuid title Kiara Id type string environments additionalProperties type string description References to the runtime environment details a value was created in. title Environments type object required module_type inputs kiara_id environments title ValuePedigree type object ValueSchema additionalProperties False 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. properties type description The type of the value. title Type type string type_config additionalProperties True description Configuration for the type, in case it's complex. title Type Config type object default default __not_set__ description A default value. title Default optional default False description Whether this value is required (True), or whether 'None' value is allowed (False). title Optional type boolean is_constant default False description Whether the value is a constant. title Is Constant type boolean doc $ref #/$defs/DocumentationMetadataModel description A description for the value of this input field. required type title ValueSchema type object ValueStatus enum unknown not set none default set title ValueStatus type string additionalProperties False properties group_title anyOf type string type null default None description The group alias. title Group Title item_infos additionalProperties $ref #/$defs/JobInfo description The info items. title Item Infos type object required item_infos title JobsInfo type object	The (json) schema for this model data.

metadata.module_config

type_name	metadata.module_config	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs PythonClass additionalProperties False description Python class and module information. properties python_class_name description The name of the Python class. title Python Class Name type string python_module_name description The name of the Python module this class lives in. title Python Module Name type string full_name description The full class namespace. title Full Name type string required python_class_name python_module_name full_name title PythonClass type object ValueTypeAndDescription properties description description The description for the value. title Description type string type description The value type. title Type type string value_default default None description Default for the value. title Value Default required description Whether this value is required title Required type boolean required description type required title ValueTypeAndDescription type object additionalProperties False properties python_class $ref #/$defs/PythonClass description The config model python class. config_values additionalProperties $ref #/$defs/ValueTypeAndDescription description The available configuration values. title Config Values type object required python_class config_values title KiaraModuleConfigMetadata type object	The (json) schema for this model data.

instance.job_desc

type_name	instance.job_desc	The registered name for this item type.
documentation	An object describing a compute job with both raw or referenced inputs.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	$defs DocumentationMetadataModel additionalProperties False description Documentation about a resource. properties description default -- n/a -- description Short description of the item. title Description type string doc anyOf type string type null default None description Detailed documentation of the item (in markdown). title Doc title Documentation type object additionalProperties False description An object describing a compute job with both raw or referenced inputs. properties job_alias default default description The alias for the job. title Job Alias type string operation description The operation id or module type. title Operation type string module_config anyOf additionalProperties True type object type null default None description The configuration for the module. title Module Config inputs additionalProperties True description The inputs for the job. title Inputs type object doc $ref #/$defs/DocumentationMetadataModel description A description/doc for this job. save additionalProperties type string description Configuration on how/whether to save the job results. Key is the output field name, value is the alias to use for saving. title Save type object required operation title JobDesc type object	The (json) schema for this model data.

instance.kiarchive

type_name	instance.kiarchive	The registered name for this item type.
documentation	-- n/a --	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	Generic properties of this item (description, tags, labels, references, ...).
python_class	python_class_name KiArchive The name of the Python class. python_module_name kiara.interfaces.python_api.models.archive The name of the Python module this class lives in. full_name kiara.interfaces.python_api.models.archive.KiArchive The full class namespace.	The python class that implements this module type.
metadata_schema	additionalProperties False properties archive_id description The unique identifier of the archive. format uuid title Archive Id type string archive_name description The alias of the archive. title Archive Name type string archive_base_path description The base path/uri of the store. title Archive Base Path type string archive_file_name description The (file-)name of the store. title Archive File Name type string allow_write_access default False description Whether the store allows write access. title Allow Write Access type boolean metadata_archive_config anyOf additionalProperties True type object type null default None description The archive to store metadata in. title Metadata Archive Config data_archive_config anyOf additionalProperties True type object type null default None description The archive to store the data in. title Data Archive Config alias_archive_config anyOf additionalProperties True type object type null default None description The archive to store aliases in. title Alias Archive Config job_archive_config anyOf additionalProperties True type object type null default None description The archive to store jobs in. title Job Archive Config required archive_id archive_name archive_base_path archive_file_name title KiArchive type object	The (json) schema for this model data.

workflow_matcher

type_name	workflow_matcher	The registered name for this item type.
documentation	An object describing requirements values should satisfy in order to be included in a query result.	Documentation for the item.
authors	Markus Binsteiner ( markus@frkl.dev )	Information about authorship for the item.
context	tags labels package: kiara references source_repo: The kiara project git repository. documentation: The url for kiara documentation.	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	additionalProperties False description An object describing requirements values should satisfy in order to be included in a query result. properties has_alias default False description Workflow must have at least one alias. title Has Alias type boolean title WorkflowMatcher type object	The (json) schema for this model data.