Interface
- pydantic model dakota.spec.interface.InterfaceConfig
Specifies how function evaluations will be performed in order to map the variables into the responses.
Show JSON schema
{ "title": "InterfaceConfig", "description": "Specifies how function evaluations will be performed in order to map the variables into the responses.", "type": "object", "properties": { "id_interface": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name the interface block; helpful when there are multiple", "title": "Id Interface", "x-materialization": [ { "ir_key": "interface.id", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "analysis_drivers": { "anyOf": [ { "$ref": "#/$defs/AnalysisDrivers" }, { "type": "null" } ], "argument": "drivers", "default": null, "description": "Define how Dakota should run a function evaluation" }, "algebraic_mappings": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Use AMPL to define algebraic input-output mappings", "title": "Algebraic Mappings", "x-materialization": [ { "ir_key": "interface.algebraic_mappings", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "failure_capture": { "anyOf": [ { "$ref": "#/$defs/Abort" }, { "$ref": "#/$defs/Retry" }, { "$ref": "#/$defs/Recover" }, { "$ref": "#/$defs/Continuation" } ], "description": "Determine how Dakota responds to analysis driver failure", "title": "Failure Capture", "x-model-default": "Abort", "x-union-pattern": 1 }, "deactivate": { "anyOf": [ { "$ref": "#/$defs/Deactivate" }, { "type": "null" } ], "default": null, "description": "Deactivate Dakota interface features for simplicity or efficiency" }, "concurrency": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/Batch" }, { "$ref": "#/$defs/Asynchronous" }, { "type": "null" } ], "default": null, "description": "Concurrency Strategy", "title": "Concurrency", "x-union-pattern": 2 }, "evaluation_servers": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Specify the number of evaluation servers when Dakota is run in parallel", "title": "Evaluation Servers", "x-materialization": [ { "ir_key": "interface.evaluation_servers", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "evaluation_scheduling": { "anyOf": [ { "$ref": "#/$defs/EvaluationSchedulingDedicated" }, { "$ref": "#/$defs/EvaluationSchedulingPeer" }, { "type": "null" } ], "default": null, "description": "Specify the scheduling of concurrent evaluations when Dakota is run in parallel", "title": "Evaluation Scheduling", "x-union-pattern": 2 }, "processors_per_evaluation": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Specify the number of processors per evaluation server when Dakota is run in parallel", "title": "Processors Per Evaluation", "x-materialization": [ { "ir_key": "interface.processors_per_evaluation", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "analysis_servers": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Specify the number of analysis servers when Dakota is run in parallel", "title": "Analysis Servers", "x-materialization": [ { "ir_key": "interface.analysis_servers", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "analysis_scheduling": { "anyOf": [ { "$ref": "#/$defs/AnalysisSchedulingDedicated" }, { "$ref": "#/$defs/AnalysisSchedulingPeer" }, { "type": "null" } ], "default": null, "description": "Specify the scheduling of concurrent analyses when Dakota is run in parallel", "title": "Analysis Scheduling", "x-union-pattern": 2 } }, "$defs": { "Abort": { "additionalProperties": false, "description": "(Default) Abort the Dakota job", "properties": { "abort": { "const": true, "default": true, "description": "(Default) Abort the Dakota job", "title": "Abort", "type": "boolean", "x-materialization": [ { "ir_key": "interface.failure_capture.action", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "abort" } ] } }, "title": "Abort", "type": "object" }, "AnalysisDrivers": { "additionalProperties": false, "description": "Define how Dakota should run a function evaluation", "properties": { "drivers": { "description": "Define how Dakota should run a function evaluation", "items": { "type": "string" }, "title": "Drivers", "type": "array", "x-materialization": [ { "ir_key": "interface.application.analysis_drivers", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "input_filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Run a pre-processing script before the analysis drivers", "title": "Input Filter", "x-materialization": [ { "ir_key": "interface.application.input_filter", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "output_filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Run a post-processing script after the analysis drivers", "title": "Output Filter", "x-materialization": [ { "ir_key": "interface.application.output_filter", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "interface_type": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/System" }, { "$ref": "#/$defs/Fork" }, { "$ref": "#/$defs/Direct" }, { "$ref": "#/$defs/Plugin" }, { "$ref": "#/$defs/Matlab" }, { "$ref": "#/$defs/Python" }, { "$ref": "#/$defs/Scilab" }, { "$ref": "#/$defs/AnalysisDriversGrid" } ], "description": "Interface Type", "title": "Interface Type", "x-union-pattern": 4 }, "analysis_components": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Provide additional identifiers to analysis drivers.", "title": "Analysis Components", "x-materialization": [ { "ir_key": "interface.application.analysis_components", "ir_value_type": "String2DArray", "storage_type": "ANALYSIS_COMPONENTS" } ] } }, "required": [ "drivers", "interface_type" ], "title": "AnalysisDrivers", "type": "object", "x-model-validations": [ { "validationContext": "analysis_drivers", "validationErrorMessage": "For analysis_drivers, some block parameters are invalid", "validationFields": [], "validationLiterals": [], "validationRuleName": "check_analysis_drivers" } ] }, "AnalysisDriversGrid": { "additionalProperties": false, "description": "Deprecated grid computing interface", "properties": { "grid": { "const": true, "default": true, "description": "Deprecated grid computing interface", "title": "Grid", "type": "boolean", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "GRID_INTERFACE" } ] } }, "title": "AnalysisDriversGrid", "type": "object" }, "AnalysisSchedulingDedicated": { "additionalProperties": false, "description": "Specify a dedicated scheduler partition for concurrent analysis executions", "properties": { "dedicated": { "const": true, "default": true, "description": "Specify a dedicated scheduler partition for concurrent analysis executions", "title": "Dedicated", "type": "boolean", "x-materialization": [ { "ir_key": "interface.analysis_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "DEDICATED_SCHEDULER_DYNAMIC" } ] } }, "title": "AnalysisSchedulingDedicated", "type": "object" }, "AnalysisSchedulingPeer": { "additionalProperties": false, "description": "Specify a peer partition for parallel analysis scheduling", "properties": { "peer": { "const": true, "default": true, "description": "Specify a peer partition for parallel analysis scheduling", "title": "Peer", "type": "boolean", "x-materialization": [ { "ir_key": "interface.analysis_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "PEER_SCHEDULING" } ] } }, "title": "AnalysisSchedulingPeer", "type": "object" }, "Asynchronous": { "additionalProperties": false, "description": "Specify local evaluation or analysis concurrency", "properties": { "asynchronous": { "$ref": "#/$defs/AsynchronousConfig", "x-materialization": [ { "ir_key": "interface.asynch", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "asynchronous" ], "title": "Asynchronous", "type": "object" }, "AsynchronousConfig": { "additionalProperties": false, "description": "Specify local evaluation or analysis concurrency", "properties": { "evaluation_concurrency": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Determine how many concurrent evaluations Dakota will schedule", "title": "Evaluation Concurrency", "x-materialization": [ { "ir_key": "interface.asynch_local_evaluation_concurrency", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "local_evaluation_scheduling": { "anyOf": [ { "$ref": "#/$defs/LocalEvaluationSchedulingDynamic" }, { "$ref": "#/$defs/LocalEvaluationSchedulingStatic" }, { "type": "null" } ], "default": null, "description": "Control how local asynchronous jobs are scheduled", "title": "Local Evaluation Scheduling", "x-union-pattern": 2 }, "analysis_concurrency": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Limit the number of analysis drivers within an evaluation that Dakota will schedule", "title": "Analysis Concurrency", "x-materialization": [ { "ir_key": "interface.asynch_local_analysis_concurrency", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "title": "AsynchronousConfig", "type": "object" }, "Batch": { "additionalProperties": false, "description": "Perform evaluations in batches", "properties": { "batch": { "$ref": "#/$defs/BatchConfig", "x-materialization": [ { "ir_key": "interface.batch", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "batch" ], "title": "Batch", "type": "object" }, "BatchConfig": { "additionalProperties": false, "description": "Perform evaluations in batches", "properties": { "size": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Limit the number of evaluations in a batch", "title": "Size", "x-materialization": [ { "ir_key": "interface.asynch_local_evaluation_concurrency", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "title": "BatchConfig", "type": "object" }, "Continuation": { "additionalProperties": false, "description": "Cause Dakota to step toward the failed \\\"target\\\" simulation from a nearby successful \\\"source\\\"", "properties": { "continuation": { "const": true, "default": true, "description": "Cause Dakota to step toward the failed \"target\" simulation from a nearby successful \"source\"", "title": "Continuation", "type": "boolean", "x-materialization": [ { "ir_key": "interface.failure_capture.action", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "continuation" } ] } }, "title": "Continuation", "type": "object" }, "Deactivate": { "additionalProperties": false, "description": "Deactivate Dakota interface features for simplicity or efficiency", "properties": { "active_set_vector": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Deactivate the Active Set Vector", "title": "Active Set Vector", "x-materialization": [ { "ir_key": "interface.active_set_vector", "ir_value_type": "bool", "storage_type": "PRESENCE_FALSE" } ] }, "evaluation_cache": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Do not retain function evaluation history in memory", "title": "Evaluation Cache", "x-materialization": [ { "ir_key": "interface.evaluation_cache", "ir_value_type": "bool", "storage_type": "PRESENCE_FALSE" } ] }, "strict_cache_equality": { "anyOf": [ { "$ref": "#/$defs/StrictCacheEquality" }, { "type": "null" } ], "default": null, "description": "Do not require strict cache equality when finding duplicates", "x-materialization": [ { "ir_key": "interface.nearby_evaluation_cache", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "restart_file": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Deactivate writing to the restart file", "title": "Restart File", "x-materialization": [ { "ir_key": "interface.restart_file", "ir_value_type": "bool", "storage_type": "PRESENCE_FALSE" } ] } }, "title": "Deactivate", "type": "object" }, "Direct": { "additionalProperties": false, "description": "Run analysis drivers that are linked-to or compiled-with Dakota", "properties": { "direct": { "$ref": "#/$defs/DirectConfig", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TEST_INTERFACE" } ] } }, "required": [ "direct" ], "title": "Direct", "type": "object" }, "DirectConfig": { "additionalProperties": false, "description": "Run analysis drivers that are linked-to or compiled-with Dakota", "properties": { "processors_per_analysis": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Specify the number of processors per analysis when Dakota is run in parallel", "title": "Processors Per Analysis", "x-materialization": [ { "ir_key": "interface.direct.processors_per_analysis", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "title": "DirectConfig", "type": "object" }, "EvaluationSchedulingDedicated": { "additionalProperties": false, "description": "Specify a dedicated scheduler partition for concurrent evaluation scheduling", "properties": { "dedicated": { "const": true, "default": true, "description": "Specify a dedicated scheduler partition for concurrent evaluation scheduling", "title": "Dedicated", "type": "boolean", "x-materialization": [ { "ir_key": "interface.evaluation_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "DEDICATED_SCHEDULER_DYNAMIC" } ] } }, "title": "EvaluationSchedulingDedicated", "type": "object" }, "EvaluationSchedulingPeer": { "additionalProperties": false, "description": "Specify a peer partition for parallel evaluation scheduling", "properties": { "peer": { "anyOf": [ { "$ref": "#/$defs/PeerDynamic" }, { "$ref": "#/$defs/PeerStatic" } ], "description": "Specify a peer partition for parallel evaluation scheduling", "title": "Peer" } }, "required": [ "peer" ], "title": "EvaluationSchedulingPeer", "type": "object" }, "Fork": { "additionalProperties": false, "description": "Launch analysis drivers using fork command", "properties": { "fork": { "$ref": "#/$defs/ForkConfig", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "FORK_INTERFACE" } ] } }, "required": [ "fork" ], "title": "Fork", "type": "object" }, "ForkConfig": { "additionalProperties": false, "description": "Launch analysis drivers using fork command", "properties": { "parameters_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify the name of the parameters file", "title": "Parameters File", "x-materialization": [ { "ir_key": "interface.application.parameters_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "results_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify the name of the results file", "title": "Results File", "x-materialization": [ { "ir_key": "interface.application.results_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "parameters_format": { "anyOf": [ { "$ref": "#/$defs/ForkParametersFormatStandard" }, { "$ref": "#/$defs/ForkParametersFormatAprepro" }, { "$ref": "#/$defs/ForkParametersFormatJsonFormat" }, { "type": "null" } ], "default": null, "description": "Format of the parameters file", "title": "Parameters Format", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ], "x-union-pattern": 2 }, "results_format": { "anyOf": [ { "$ref": "#/$defs/ForkResultsFormatStandard" }, { "$ref": "#/$defs/ForkResultsFormatJsonFormat" }, { "type": "null" } ], "default": null, "description": "Format of the results file", "title": "Results Format", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ], "x-union-pattern": 2 }, "file_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each parameters & results file name with the function evaluation number", "title": "File Tag", "x-materialization": [ { "ir_key": "interface.application.file_tag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "file_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Keep the parameters & results files after the analysis driver completes", "title": "File Save", "x-materialization": [ { "ir_key": "interface.application.file_save", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "work_directory": { "anyOf": [ { "$ref": "#/$defs/ForkWorkDirectory" }, { "type": "null" } ], "default": null, "description": "Perform each function evaluation in a separate working directory", "x-materialization": [ { "ir_key": "interface.useWorkdir", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "allow_existing_results": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Change how Dakota deals with existing results files", "title": "Allow Existing Results", "x-materialization": [ { "ir_key": "interface.allow_existing_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "verbatim": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Specify the command Dakota uses to launch analysis driver(s) and filters", "title": "Verbatim", "x-materialization": [ { "ir_key": "interface.application.verbatim", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ForkConfig", "type": "object" }, "ForkParametersFormatAprepro": { "additionalProperties": false, "description": "Use the APREPRO format for parameters files", "properties": { "aprepro": { "const": true, "default": true, "description": "Use the APREPRO format for parameters files", "title": "Aprepro", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_APREPRO" } ] } }, "title": "ForkParametersFormatAprepro", "type": "object" }, "ForkParametersFormatJsonFormat": { "additionalProperties": false, "description": "Use the JSON format for parameters files", "properties": { "json_format": { "const": true, "default": true, "description": "Use the JSON format for parameters files", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_JSON" } ] } }, "title": "ForkParametersFormatJsonFormat", "type": "object" }, "ForkParametersFormatStandard": { "additionalProperties": false, "description": "Use the standard format for parameters files", "properties": { "standard": { "const": true, "default": true, "description": "Use the standard format for parameters files", "title": "Standard", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ] } }, "title": "ForkParametersFormatStandard", "type": "object" }, "ForkResultsFormatJsonFormat": { "additionalProperties": false, "description": "Expect results files in JSON format", "properties": { "json_format": { "const": true, "default": true, "description": "Expect results files in JSON format", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_JSON" } ] } }, "title": "ForkResultsFormatJsonFormat", "type": "object" }, "ForkResultsFormatStandard": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "standard": { "$ref": "#/$defs/ForkResultsFormatStandardConfig", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ] } }, "required": [ "standard" ], "title": "ForkResultsFormatStandard", "type": "object" }, "ForkResultsFormatStandardConfig": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "labeled": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Requires correct function value labels in results file", "title": "Labeled", "x-materialization": [ { "ir_key": "interface.labeled_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ForkResultsFormatStandardConfig", "type": "object" }, "ForkWorkDirectory": { "additionalProperties": false, "description": "Perform each function evaluation in a separate working directory", "properties": { "named": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The base name of the work directory created by Dakota", "title": "Named", "x-materialization": [ { "ir_key": "interface.workDir", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "directory_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each work directory with the function evaluation number", "title": "Directory Tag", "x-aliases": [ "dir_tag" ], "x-materialization": [ { "ir_key": "interface.dirTag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "directory_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Preserve the work directory after function evaluation completion", "title": "Directory Save", "x-aliases": [ "dir_save" ], "x-materialization": [ { "ir_key": "interface.dirSave", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "link_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Paths to be linked into each working directory", "title": "Link Files", "x-materialization": [ { "ir_key": "interface.linkFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "copy_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Files and directories to be copied into each working directory", "title": "Copy Files", "x-materialization": [ { "ir_key": "interface.copyFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "replace": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Overwrite existing files within a work directory", "title": "Replace", "x-materialization": [ { "ir_key": "interface.templateReplace", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ForkWorkDirectory", "type": "object" }, "LocalEvaluationSchedulingDynamic": { "additionalProperties": false, "description": "Dynamic local scheduling (sequential)", "properties": { "dynamic": { "const": true, "default": true, "description": "Dynamic local scheduling (sequential)", "title": "Dynamic", "type": "boolean", "x-materialization": [ { "ir_key": "interface.local_evaluation_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "DYNAMIC_SCHEDULING" } ] } }, "title": "LocalEvaluationSchedulingDynamic", "type": "object" }, "LocalEvaluationSchedulingStatic": { "additionalProperties": false, "description": "Static local scheduling (tiled)", "properties": { "static": { "const": true, "default": true, "description": "Static local scheduling (tiled)", "title": "Static", "type": "boolean", "x-materialization": [ { "ir_key": "interface.local_evaluation_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "STATIC_SCHEDULING" } ] } }, "title": "LocalEvaluationSchedulingStatic", "type": "object" }, "Matlab": { "additionalProperties": false, "description": "Run Matlab through a direct interface - requires special Dakota build", "properties": { "matlab": { "const": true, "default": true, "description": "Run Matlab through a direct interface - requires special Dakota build", "title": "Matlab", "type": "boolean", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "MATLAB_INTERFACE" } ] } }, "title": "Matlab", "type": "object" }, "PeerDynamic": { "additionalProperties": false, "description": "Specify dynamic scheduling in a peer partition when Dakota is run in parallel.", "properties": { "dynamic": { "const": true, "default": true, "description": "Specify dynamic scheduling in a peer partition when Dakota is run in parallel.", "title": "Dynamic", "type": "boolean", "x-materialization": [ { "ir_key": "interface.evaluation_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "PEER_DYNAMIC_SCHEDULING" } ] } }, "title": "PeerDynamic", "type": "object" }, "PeerStatic": { "additionalProperties": false, "description": "Specify static scheduling in a peer partition when Dakota is run in parallel.", "properties": { "static": { "const": true, "default": true, "description": "Specify static scheduling in a peer partition when Dakota is run in parallel.", "title": "Static", "type": "boolean", "x-materialization": [ { "ir_key": "interface.evaluation_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "PEER_STATIC_SCHEDULING" } ] } }, "title": "PeerStatic", "type": "object" }, "Plugin": { "additionalProperties": false, "description": "Dynamically load a plugin analysis driver", "properties": { "plugin": { "$ref": "#/$defs/PluginConfig", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PLUGIN_INTERFACE" } ] } }, "required": [ "plugin" ], "title": "Plugin", "type": "object" }, "PluginConfig": { "additionalProperties": false, "description": "Dynamically load a plugin analysis driver", "properties": { "library_path": { "description": "Path to the plugin shared object file", "title": "Library Path", "type": "string", "x-materialization": [ { "ir_key": "interface.plugin_library_path", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "library_path" ], "title": "PluginConfig", "type": "object" }, "Python": { "additionalProperties": false, "description": "Run Python through a Pybind11-based direct interface - requires a special Dakota build", "properties": { "python": { "$ref": "#/$defs/PythonConfig", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PYTHON_INTERFACE" } ] } }, "required": [ "python" ], "title": "Python", "type": "object" }, "PythonConfig": { "additionalProperties": false, "description": "Run Python through a Pybind11-based direct interface - requires a special Dakota build", "properties": { "numpy": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Enable the use of numpy in Dakota's Python interface", "title": "Numpy", "x-materialization": [ { "ir_key": "interface.python.numpy", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "PythonConfig", "type": "object" }, "Recover": { "additionalProperties": false, "description": "Substitute dummy values for the responses", "properties": { "recover": { "description": "Substitute dummy values for the responses", "items": { "type": "number" }, "title": "Recover", "type": "array", "x-materialization": [ { "ir_key": "interface.failure_capture.action", "ir_value_type": "String", "secondary_ir_key": "interface.failure_capture.recovery_fn_vals", "secondary_ir_value_type": "RealVector", "storage_type": "TYPE_DATA_COMBINED", "stored_value": "recover" } ] } }, "required": [ "recover" ], "title": "Recover", "type": "object" }, "Retry": { "additionalProperties": false, "description": "Rerun failed analyses", "properties": { "retry": { "description": "Rerun failed analyses", "title": "Retry", "type": "integer", "x-materialization": [ { "ir_key": "interface.failure_capture.action", "ir_value_type": "String", "secondary_ir_key": "interface.failure_capture.retry_limit", "secondary_ir_value_type": "int", "storage_type": "TYPE_DATA_COMBINED", "stored_value": "retry" } ] } }, "required": [ "retry" ], "title": "Retry", "type": "object" }, "Scilab": { "additionalProperties": false, "description": "Run Scilab through a direct interface - requires special Dakota build", "properties": { "scilab": { "const": true, "default": true, "description": "Run Scilab through a direct interface - requires special Dakota build", "title": "Scilab", "type": "boolean", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "SCILAB_INTERFACE" } ] } }, "title": "Scilab", "type": "object" }, "StrictCacheEquality": { "additionalProperties": false, "description": "Do not require strict cache equality when finding duplicates", "properties": { "cache_tolerance": { "default": 2.220446049250313e-16, "description": "Specify tolerance when identifying duplicate function evaluations", "title": "Cache Tolerance", "type": "number", "x-materialization": [ { "ir_key": "interface.nearby_evaluation_cache_tolerance", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] } }, "title": "StrictCacheEquality", "type": "object" }, "System": { "additionalProperties": false, "description": "(Not recommended) Launch analysis drivers with a system call", "properties": { "system": { "$ref": "#/$defs/SystemConfig", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "SYSTEM_INTERFACE" } ] } }, "required": [ "system" ], "title": "System", "type": "object" }, "SystemConfig": { "additionalProperties": false, "description": "(Not recommended) Launch analysis drivers with a system call", "properties": { "parameters_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify the name of the parameters file", "title": "Parameters File", "x-materialization": [ { "ir_key": "interface.application.parameters_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "results_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify the name of the results file", "title": "Results File", "x-materialization": [ { "ir_key": "interface.application.results_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "parameters_format": { "anyOf": [ { "$ref": "#/$defs/SystemParametersFormatStandard" }, { "$ref": "#/$defs/SystemParametersFormatAprepro" }, { "$ref": "#/$defs/SystemParametersFormatJsonFormat" }, { "type": "null" } ], "default": null, "description": "Format of the parameters file", "title": "Parameters Format", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ], "x-union-pattern": 2 }, "results_format": { "anyOf": [ { "$ref": "#/$defs/SystemResultsFormatStandard" }, { "$ref": "#/$defs/SystemResultsFormatJsonFormat" }, { "type": "null" } ], "default": null, "description": "Format of the results file", "title": "Results Format", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ], "x-union-pattern": 2 }, "file_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each parameters & results file name with the function evaluation number", "title": "File Tag", "x-materialization": [ { "ir_key": "interface.application.file_tag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "file_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Keep the parameters & results files after the analysis driver completes", "title": "File Save", "x-materialization": [ { "ir_key": "interface.application.file_save", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "work_directory": { "anyOf": [ { "$ref": "#/$defs/SystemWorkDirectory" }, { "type": "null" } ], "default": null, "description": "Perform each function evaluation in a separate working directory", "x-materialization": [ { "ir_key": "interface.useWorkdir", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "allow_existing_results": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Change how Dakota deals with existing results files", "title": "Allow Existing Results", "x-materialization": [ { "ir_key": "interface.allow_existing_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "verbatim": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Specify the command Dakota uses to launch analysis driver(s) and filters", "title": "Verbatim", "x-materialization": [ { "ir_key": "interface.application.verbatim", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "SystemConfig", "type": "object" }, "SystemParametersFormatAprepro": { "additionalProperties": false, "description": "Use the APREPRO format for parameters files", "properties": { "aprepro": { "const": true, "default": true, "description": "Use the APREPRO format for parameters files", "title": "Aprepro", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_APREPRO" } ] } }, "title": "SystemParametersFormatAprepro", "type": "object" }, "SystemParametersFormatJsonFormat": { "additionalProperties": false, "description": "Use the JSON format for parameters files", "properties": { "json_format": { "const": true, "default": true, "description": "Use the JSON format for parameters files", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_JSON" } ] } }, "title": "SystemParametersFormatJsonFormat", "type": "object" }, "SystemParametersFormatStandard": { "additionalProperties": false, "description": "Use the standard format for parameters files", "properties": { "standard": { "const": true, "default": true, "description": "Use the standard format for parameters files", "title": "Standard", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ] } }, "title": "SystemParametersFormatStandard", "type": "object" }, "SystemResultsFormatJsonFormat": { "additionalProperties": false, "description": "Expect results files in JSON format", "properties": { "json_format": { "const": true, "default": true, "description": "Expect results files in JSON format", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_JSON" } ] } }, "title": "SystemResultsFormatJsonFormat", "type": "object" }, "SystemResultsFormatStandard": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "standard": { "$ref": "#/$defs/SystemResultsFormatStandardConfig", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ] } }, "required": [ "standard" ], "title": "SystemResultsFormatStandard", "type": "object" }, "SystemResultsFormatStandardConfig": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "labeled": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Requires correct function value labels in results file", "title": "Labeled", "x-materialization": [ { "ir_key": "interface.labeled_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "SystemResultsFormatStandardConfig", "type": "object" }, "SystemWorkDirectory": { "additionalProperties": false, "description": "Perform each function evaluation in a separate working directory", "properties": { "named": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The base name of the work directory created by Dakota", "title": "Named", "x-materialization": [ { "ir_key": "interface.workDir", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "directory_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each work directory with the function evaluation number", "title": "Directory Tag", "x-aliases": [ "dir_tag" ], "x-materialization": [ { "ir_key": "interface.dirTag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "directory_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Preserve the work directory after function evaluation completion", "title": "Directory Save", "x-aliases": [ "dir_save" ], "x-materialization": [ { "ir_key": "interface.dirSave", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "link_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Paths to be linked into each working directory", "title": "Link Files", "x-materialization": [ { "ir_key": "interface.linkFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "copy_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Files and directories to be copied into each working directory", "title": "Copy Files", "x-materialization": [ { "ir_key": "interface.copyFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "replace": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Overwrite existing files within a work directory", "title": "Replace", "x-materialization": [ { "ir_key": "interface.templateReplace", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "SystemWorkDirectory", "type": "object" } }, "additionalProperties": false, "x-model-validations": [ { "validationContext": "interface", "validationErrorMessage": "For interface, some block parameters are invalid", "validationFields": [], "validationLiterals": [], "validationRuleName": "check_interface_block" } ] }
- Fields:
- field algebraic_mappings: str | None = None
Use AMPL to define algebraic input-output mappings
- field analysis_drivers: AnalysisDrivers | None = None
Define how Dakota should run a function evaluation
- field analysis_scheduling: AnalysisSchedulingDedicated | AnalysisSchedulingPeer | None = None
Specify the scheduling of concurrent analyses when Dakota is run in parallel
- field analysis_servers: int | None = None
Specify the number of analysis servers when Dakota is run in parallel
- Constraints:
gt = 0
- field concurrency: Batch | Asynchronous | None = None
Concurrency Strategy
- field deactivate: Deactivate | None = None
Deactivate Dakota interface features for simplicity or efficiency
- field evaluation_scheduling: EvaluationSchedulingDedicated | EvaluationSchedulingPeer | None = None
Specify the scheduling of concurrent evaluations when Dakota is run in parallel
- field evaluation_servers: int | None = None
Specify the number of evaluation servers when Dakota is run in parallel
- Constraints:
gt = 0
- field failure_capture: Abort | Retry | Recover | Continuation [Optional]
Determine how Dakota responds to analysis driver failure
- field id_interface: str | None = None
Name the interface block; helpful when there are multiple
- field processors_per_evaluation: int | None = None
Specify the number of processors per evaluation server when Dakota is run in parallel
- Constraints:
gt = 0
Generated Pydantic models for interface
- pydantic model dakota.spec.interface.Abort
(Default) Abort the Dakota job
Show JSON schema
{ "title": "Abort", "description": "(Default) Abort the Dakota job", "type": "object", "properties": { "abort": { "const": true, "default": true, "description": "(Default) Abort the Dakota job", "title": "Abort", "type": "boolean", "x-materialization": [ { "ir_key": "interface.failure_capture.action", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "abort" } ] } }, "additionalProperties": false }
- Fields:
- field abort: Literal[True] = True
(Default) Abort the Dakota job
- pydantic model dakota.spec.interface.AnalysisDrivers
Define how Dakota should run a function evaluation
Show JSON schema
{ "title": "AnalysisDrivers", "description": "Define how Dakota should run a function evaluation", "type": "object", "properties": { "drivers": { "description": "Define how Dakota should run a function evaluation", "items": { "type": "string" }, "title": "Drivers", "type": "array", "x-materialization": [ { "ir_key": "interface.application.analysis_drivers", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "input_filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Run a pre-processing script before the analysis drivers", "title": "Input Filter", "x-materialization": [ { "ir_key": "interface.application.input_filter", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "output_filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Run a post-processing script after the analysis drivers", "title": "Output Filter", "x-materialization": [ { "ir_key": "interface.application.output_filter", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "interface_type": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/System" }, { "$ref": "#/$defs/Fork" }, { "$ref": "#/$defs/Direct" }, { "$ref": "#/$defs/Plugin" }, { "$ref": "#/$defs/Matlab" }, { "$ref": "#/$defs/Python" }, { "$ref": "#/$defs/Scilab" }, { "$ref": "#/$defs/AnalysisDriversGrid" } ], "description": "Interface Type", "title": "Interface Type", "x-union-pattern": 4 }, "analysis_components": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Provide additional identifiers to analysis drivers.", "title": "Analysis Components", "x-materialization": [ { "ir_key": "interface.application.analysis_components", "ir_value_type": "String2DArray", "storage_type": "ANALYSIS_COMPONENTS" } ] } }, "$defs": { "AnalysisDriversGrid": { "additionalProperties": false, "description": "Deprecated grid computing interface", "properties": { "grid": { "const": true, "default": true, "description": "Deprecated grid computing interface", "title": "Grid", "type": "boolean", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "GRID_INTERFACE" } ] } }, "title": "AnalysisDriversGrid", "type": "object" }, "Direct": { "additionalProperties": false, "description": "Run analysis drivers that are linked-to or compiled-with Dakota", "properties": { "direct": { "$ref": "#/$defs/DirectConfig", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TEST_INTERFACE" } ] } }, "required": [ "direct" ], "title": "Direct", "type": "object" }, "DirectConfig": { "additionalProperties": false, "description": "Run analysis drivers that are linked-to or compiled-with Dakota", "properties": { "processors_per_analysis": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Specify the number of processors per analysis when Dakota is run in parallel", "title": "Processors Per Analysis", "x-materialization": [ { "ir_key": "interface.direct.processors_per_analysis", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "title": "DirectConfig", "type": "object" }, "Fork": { "additionalProperties": false, "description": "Launch analysis drivers using fork command", "properties": { "fork": { "$ref": "#/$defs/ForkConfig", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "FORK_INTERFACE" } ] } }, "required": [ "fork" ], "title": "Fork", "type": "object" }, "ForkConfig": { "additionalProperties": false, "description": "Launch analysis drivers using fork command", "properties": { "parameters_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify the name of the parameters file", "title": "Parameters File", "x-materialization": [ { "ir_key": "interface.application.parameters_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "results_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify the name of the results file", "title": "Results File", "x-materialization": [ { "ir_key": "interface.application.results_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "parameters_format": { "anyOf": [ { "$ref": "#/$defs/ForkParametersFormatStandard" }, { "$ref": "#/$defs/ForkParametersFormatAprepro" }, { "$ref": "#/$defs/ForkParametersFormatJsonFormat" }, { "type": "null" } ], "default": null, "description": "Format of the parameters file", "title": "Parameters Format", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ], "x-union-pattern": 2 }, "results_format": { "anyOf": [ { "$ref": "#/$defs/ForkResultsFormatStandard" }, { "$ref": "#/$defs/ForkResultsFormatJsonFormat" }, { "type": "null" } ], "default": null, "description": "Format of the results file", "title": "Results Format", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ], "x-union-pattern": 2 }, "file_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each parameters & results file name with the function evaluation number", "title": "File Tag", "x-materialization": [ { "ir_key": "interface.application.file_tag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "file_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Keep the parameters & results files after the analysis driver completes", "title": "File Save", "x-materialization": [ { "ir_key": "interface.application.file_save", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "work_directory": { "anyOf": [ { "$ref": "#/$defs/ForkWorkDirectory" }, { "type": "null" } ], "default": null, "description": "Perform each function evaluation in a separate working directory", "x-materialization": [ { "ir_key": "interface.useWorkdir", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "allow_existing_results": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Change how Dakota deals with existing results files", "title": "Allow Existing Results", "x-materialization": [ { "ir_key": "interface.allow_existing_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "verbatim": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Specify the command Dakota uses to launch analysis driver(s) and filters", "title": "Verbatim", "x-materialization": [ { "ir_key": "interface.application.verbatim", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ForkConfig", "type": "object" }, "ForkParametersFormatAprepro": { "additionalProperties": false, "description": "Use the APREPRO format for parameters files", "properties": { "aprepro": { "const": true, "default": true, "description": "Use the APREPRO format for parameters files", "title": "Aprepro", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_APREPRO" } ] } }, "title": "ForkParametersFormatAprepro", "type": "object" }, "ForkParametersFormatJsonFormat": { "additionalProperties": false, "description": "Use the JSON format for parameters files", "properties": { "json_format": { "const": true, "default": true, "description": "Use the JSON format for parameters files", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_JSON" } ] } }, "title": "ForkParametersFormatJsonFormat", "type": "object" }, "ForkParametersFormatStandard": { "additionalProperties": false, "description": "Use the standard format for parameters files", "properties": { "standard": { "const": true, "default": true, "description": "Use the standard format for parameters files", "title": "Standard", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ] } }, "title": "ForkParametersFormatStandard", "type": "object" }, "ForkResultsFormatJsonFormat": { "additionalProperties": false, "description": "Expect results files in JSON format", "properties": { "json_format": { "const": true, "default": true, "description": "Expect results files in JSON format", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_JSON" } ] } }, "title": "ForkResultsFormatJsonFormat", "type": "object" }, "ForkResultsFormatStandard": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "standard": { "$ref": "#/$defs/ForkResultsFormatStandardConfig", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ] } }, "required": [ "standard" ], "title": "ForkResultsFormatStandard", "type": "object" }, "ForkResultsFormatStandardConfig": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "labeled": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Requires correct function value labels in results file", "title": "Labeled", "x-materialization": [ { "ir_key": "interface.labeled_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ForkResultsFormatStandardConfig", "type": "object" }, "ForkWorkDirectory": { "additionalProperties": false, "description": "Perform each function evaluation in a separate working directory", "properties": { "named": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The base name of the work directory created by Dakota", "title": "Named", "x-materialization": [ { "ir_key": "interface.workDir", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "directory_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each work directory with the function evaluation number", "title": "Directory Tag", "x-aliases": [ "dir_tag" ], "x-materialization": [ { "ir_key": "interface.dirTag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "directory_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Preserve the work directory after function evaluation completion", "title": "Directory Save", "x-aliases": [ "dir_save" ], "x-materialization": [ { "ir_key": "interface.dirSave", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "link_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Paths to be linked into each working directory", "title": "Link Files", "x-materialization": [ { "ir_key": "interface.linkFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "copy_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Files and directories to be copied into each working directory", "title": "Copy Files", "x-materialization": [ { "ir_key": "interface.copyFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "replace": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Overwrite existing files within a work directory", "title": "Replace", "x-materialization": [ { "ir_key": "interface.templateReplace", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ForkWorkDirectory", "type": "object" }, "Matlab": { "additionalProperties": false, "description": "Run Matlab through a direct interface - requires special Dakota build", "properties": { "matlab": { "const": true, "default": true, "description": "Run Matlab through a direct interface - requires special Dakota build", "title": "Matlab", "type": "boolean", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "MATLAB_INTERFACE" } ] } }, "title": "Matlab", "type": "object" }, "Plugin": { "additionalProperties": false, "description": "Dynamically load a plugin analysis driver", "properties": { "plugin": { "$ref": "#/$defs/PluginConfig", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PLUGIN_INTERFACE" } ] } }, "required": [ "plugin" ], "title": "Plugin", "type": "object" }, "PluginConfig": { "additionalProperties": false, "description": "Dynamically load a plugin analysis driver", "properties": { "library_path": { "description": "Path to the plugin shared object file", "title": "Library Path", "type": "string", "x-materialization": [ { "ir_key": "interface.plugin_library_path", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "library_path" ], "title": "PluginConfig", "type": "object" }, "Python": { "additionalProperties": false, "description": "Run Python through a Pybind11-based direct interface - requires a special Dakota build", "properties": { "python": { "$ref": "#/$defs/PythonConfig", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PYTHON_INTERFACE" } ] } }, "required": [ "python" ], "title": "Python", "type": "object" }, "PythonConfig": { "additionalProperties": false, "description": "Run Python through a Pybind11-based direct interface - requires a special Dakota build", "properties": { "numpy": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Enable the use of numpy in Dakota's Python interface", "title": "Numpy", "x-materialization": [ { "ir_key": "interface.python.numpy", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "PythonConfig", "type": "object" }, "Scilab": { "additionalProperties": false, "description": "Run Scilab through a direct interface - requires special Dakota build", "properties": { "scilab": { "const": true, "default": true, "description": "Run Scilab through a direct interface - requires special Dakota build", "title": "Scilab", "type": "boolean", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "SCILAB_INTERFACE" } ] } }, "title": "Scilab", "type": "object" }, "System": { "additionalProperties": false, "description": "(Not recommended) Launch analysis drivers with a system call", "properties": { "system": { "$ref": "#/$defs/SystemConfig", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "SYSTEM_INTERFACE" } ] } }, "required": [ "system" ], "title": "System", "type": "object" }, "SystemConfig": { "additionalProperties": false, "description": "(Not recommended) Launch analysis drivers with a system call", "properties": { "parameters_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify the name of the parameters file", "title": "Parameters File", "x-materialization": [ { "ir_key": "interface.application.parameters_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "results_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify the name of the results file", "title": "Results File", "x-materialization": [ { "ir_key": "interface.application.results_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "parameters_format": { "anyOf": [ { "$ref": "#/$defs/SystemParametersFormatStandard" }, { "$ref": "#/$defs/SystemParametersFormatAprepro" }, { "$ref": "#/$defs/SystemParametersFormatJsonFormat" }, { "type": "null" } ], "default": null, "description": "Format of the parameters file", "title": "Parameters Format", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ], "x-union-pattern": 2 }, "results_format": { "anyOf": [ { "$ref": "#/$defs/SystemResultsFormatStandard" }, { "$ref": "#/$defs/SystemResultsFormatJsonFormat" }, { "type": "null" } ], "default": null, "description": "Format of the results file", "title": "Results Format", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ], "x-union-pattern": 2 }, "file_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each parameters & results file name with the function evaluation number", "title": "File Tag", "x-materialization": [ { "ir_key": "interface.application.file_tag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "file_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Keep the parameters & results files after the analysis driver completes", "title": "File Save", "x-materialization": [ { "ir_key": "interface.application.file_save", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "work_directory": { "anyOf": [ { "$ref": "#/$defs/SystemWorkDirectory" }, { "type": "null" } ], "default": null, "description": "Perform each function evaluation in a separate working directory", "x-materialization": [ { "ir_key": "interface.useWorkdir", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "allow_existing_results": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Change how Dakota deals with existing results files", "title": "Allow Existing Results", "x-materialization": [ { "ir_key": "interface.allow_existing_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "verbatim": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Specify the command Dakota uses to launch analysis driver(s) and filters", "title": "Verbatim", "x-materialization": [ { "ir_key": "interface.application.verbatim", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "SystemConfig", "type": "object" }, "SystemParametersFormatAprepro": { "additionalProperties": false, "description": "Use the APREPRO format for parameters files", "properties": { "aprepro": { "const": true, "default": true, "description": "Use the APREPRO format for parameters files", "title": "Aprepro", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_APREPRO" } ] } }, "title": "SystemParametersFormatAprepro", "type": "object" }, "SystemParametersFormatJsonFormat": { "additionalProperties": false, "description": "Use the JSON format for parameters files", "properties": { "json_format": { "const": true, "default": true, "description": "Use the JSON format for parameters files", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_JSON" } ] } }, "title": "SystemParametersFormatJsonFormat", "type": "object" }, "SystemParametersFormatStandard": { "additionalProperties": false, "description": "Use the standard format for parameters files", "properties": { "standard": { "const": true, "default": true, "description": "Use the standard format for parameters files", "title": "Standard", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ] } }, "title": "SystemParametersFormatStandard", "type": "object" }, "SystemResultsFormatJsonFormat": { "additionalProperties": false, "description": "Expect results files in JSON format", "properties": { "json_format": { "const": true, "default": true, "description": "Expect results files in JSON format", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_JSON" } ] } }, "title": "SystemResultsFormatJsonFormat", "type": "object" }, "SystemResultsFormatStandard": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "standard": { "$ref": "#/$defs/SystemResultsFormatStandardConfig", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ] } }, "required": [ "standard" ], "title": "SystemResultsFormatStandard", "type": "object" }, "SystemResultsFormatStandardConfig": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "labeled": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Requires correct function value labels in results file", "title": "Labeled", "x-materialization": [ { "ir_key": "interface.labeled_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "SystemResultsFormatStandardConfig", "type": "object" }, "SystemWorkDirectory": { "additionalProperties": false, "description": "Perform each function evaluation in a separate working directory", "properties": { "named": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The base name of the work directory created by Dakota", "title": "Named", "x-materialization": [ { "ir_key": "interface.workDir", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "directory_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each work directory with the function evaluation number", "title": "Directory Tag", "x-aliases": [ "dir_tag" ], "x-materialization": [ { "ir_key": "interface.dirTag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "directory_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Preserve the work directory after function evaluation completion", "title": "Directory Save", "x-aliases": [ "dir_save" ], "x-materialization": [ { "ir_key": "interface.dirSave", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "link_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Paths to be linked into each working directory", "title": "Link Files", "x-materialization": [ { "ir_key": "interface.linkFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "copy_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Files and directories to be copied into each working directory", "title": "Copy Files", "x-materialization": [ { "ir_key": "interface.copyFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "replace": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Overwrite existing files within a work directory", "title": "Replace", "x-materialization": [ { "ir_key": "interface.templateReplace", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "SystemWorkDirectory", "type": "object" } }, "additionalProperties": false, "required": [ "drivers", "interface_type" ], "x-model-validations": [ { "validationContext": "analysis_drivers", "validationErrorMessage": "For analysis_drivers, some block parameters are invalid", "validationFields": [], "validationLiterals": [], "validationRuleName": "check_analysis_drivers" } ] }
- Fields:
- field analysis_components: list[str] | None = None
Provide additional identifiers to analysis drivers.
- field drivers: list[str] [Required]
Define how Dakota should run a function evaluation
- field input_filter: str | None = None
Run a pre-processing script before the analysis drivers
- field interface_type: System | Fork | Direct | Plugin | Matlab | Python | Scilab | AnalysisDriversGrid [Required]
Interface Type
- field output_filter: str | None = None
Run a post-processing script after the analysis drivers
- pydantic model dakota.spec.interface.AnalysisDriversGrid
Deprecated grid computing interface
Show JSON schema
{ "title": "AnalysisDriversGrid", "description": "Deprecated grid computing interface", "type": "object", "properties": { "grid": { "const": true, "default": true, "description": "Deprecated grid computing interface", "title": "Grid", "type": "boolean", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "GRID_INTERFACE" } ] } }, "additionalProperties": false }
- Fields:
- field grid: Literal[True] = True
Deprecated grid computing interface
- pydantic model dakota.spec.interface.AnalysisSchedulingDedicated
Specify a dedicated scheduler partition for concurrent analysis executions
Show JSON schema
{ "title": "AnalysisSchedulingDedicated", "description": "Specify a dedicated scheduler partition for concurrent analysis executions", "type": "object", "properties": { "dedicated": { "const": true, "default": true, "description": "Specify a dedicated scheduler partition for concurrent analysis executions", "title": "Dedicated", "type": "boolean", "x-materialization": [ { "ir_key": "interface.analysis_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "DEDICATED_SCHEDULER_DYNAMIC" } ] } }, "additionalProperties": false }
- Fields:
- field dedicated: Literal[True] = True
Specify a dedicated scheduler partition for concurrent analysis executions
- pydantic model dakota.spec.interface.AnalysisSchedulingPeer
Specify a peer partition for parallel analysis scheduling
Show JSON schema
{ "title": "AnalysisSchedulingPeer", "description": "Specify a peer partition for parallel analysis scheduling", "type": "object", "properties": { "peer": { "const": true, "default": true, "description": "Specify a peer partition for parallel analysis scheduling", "title": "Peer", "type": "boolean", "x-materialization": [ { "ir_key": "interface.analysis_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "PEER_SCHEDULING" } ] } }, "additionalProperties": false }
- Fields:
- field peer: Literal[True] = True
Specify a peer partition for parallel analysis scheduling
- pydantic model dakota.spec.interface.Asynchronous
Specify local evaluation or analysis concurrency
Show JSON schema
{ "title": "Asynchronous", "description": "Specify local evaluation or analysis concurrency", "type": "object", "properties": { "asynchronous": { "$ref": "#/$defs/AsynchronousConfig", "x-materialization": [ { "ir_key": "interface.asynch", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "$defs": { "AsynchronousConfig": { "additionalProperties": false, "description": "Specify local evaluation or analysis concurrency", "properties": { "evaluation_concurrency": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Determine how many concurrent evaluations Dakota will schedule", "title": "Evaluation Concurrency", "x-materialization": [ { "ir_key": "interface.asynch_local_evaluation_concurrency", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "local_evaluation_scheduling": { "anyOf": [ { "$ref": "#/$defs/LocalEvaluationSchedulingDynamic" }, { "$ref": "#/$defs/LocalEvaluationSchedulingStatic" }, { "type": "null" } ], "default": null, "description": "Control how local asynchronous jobs are scheduled", "title": "Local Evaluation Scheduling", "x-union-pattern": 2 }, "analysis_concurrency": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Limit the number of analysis drivers within an evaluation that Dakota will schedule", "title": "Analysis Concurrency", "x-materialization": [ { "ir_key": "interface.asynch_local_analysis_concurrency", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "title": "AsynchronousConfig", "type": "object" }, "LocalEvaluationSchedulingDynamic": { "additionalProperties": false, "description": "Dynamic local scheduling (sequential)", "properties": { "dynamic": { "const": true, "default": true, "description": "Dynamic local scheduling (sequential)", "title": "Dynamic", "type": "boolean", "x-materialization": [ { "ir_key": "interface.local_evaluation_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "DYNAMIC_SCHEDULING" } ] } }, "title": "LocalEvaluationSchedulingDynamic", "type": "object" }, "LocalEvaluationSchedulingStatic": { "additionalProperties": false, "description": "Static local scheduling (tiled)", "properties": { "static": { "const": true, "default": true, "description": "Static local scheduling (tiled)", "title": "Static", "type": "boolean", "x-materialization": [ { "ir_key": "interface.local_evaluation_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "STATIC_SCHEDULING" } ] } }, "title": "LocalEvaluationSchedulingStatic", "type": "object" } }, "additionalProperties": false, "required": [ "asynchronous" ] }
- field asynchronous: AsynchronousConfig [Required]
Specify local evaluation or analysis concurrency
- pydantic model dakota.spec.interface.AsynchronousConfig
Specify local evaluation or analysis concurrency
Show JSON schema
{ "title": "AsynchronousConfig", "description": "Specify local evaluation or analysis concurrency", "type": "object", "properties": { "evaluation_concurrency": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Determine how many concurrent evaluations Dakota will schedule", "title": "Evaluation Concurrency", "x-materialization": [ { "ir_key": "interface.asynch_local_evaluation_concurrency", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "local_evaluation_scheduling": { "anyOf": [ { "$ref": "#/$defs/LocalEvaluationSchedulingDynamic" }, { "$ref": "#/$defs/LocalEvaluationSchedulingStatic" }, { "type": "null" } ], "default": null, "description": "Control how local asynchronous jobs are scheduled", "title": "Local Evaluation Scheduling", "x-union-pattern": 2 }, "analysis_concurrency": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Limit the number of analysis drivers within an evaluation that Dakota will schedule", "title": "Analysis Concurrency", "x-materialization": [ { "ir_key": "interface.asynch_local_analysis_concurrency", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "$defs": { "LocalEvaluationSchedulingDynamic": { "additionalProperties": false, "description": "Dynamic local scheduling (sequential)", "properties": { "dynamic": { "const": true, "default": true, "description": "Dynamic local scheduling (sequential)", "title": "Dynamic", "type": "boolean", "x-materialization": [ { "ir_key": "interface.local_evaluation_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "DYNAMIC_SCHEDULING" } ] } }, "title": "LocalEvaluationSchedulingDynamic", "type": "object" }, "LocalEvaluationSchedulingStatic": { "additionalProperties": false, "description": "Static local scheduling (tiled)", "properties": { "static": { "const": true, "default": true, "description": "Static local scheduling (tiled)", "title": "Static", "type": "boolean", "x-materialization": [ { "ir_key": "interface.local_evaluation_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "STATIC_SCHEDULING" } ] } }, "title": "LocalEvaluationSchedulingStatic", "type": "object" } }, "additionalProperties": false }
- Fields:
- field analysis_concurrency: int | None = None
Limit the number of analysis drivers within an evaluation that Dakota will schedule
- Constraints:
gt = 0
- field evaluation_concurrency: int | None = None
Determine how many concurrent evaluations Dakota will schedule
- Constraints:
gt = 0
- field local_evaluation_scheduling: LocalEvaluationSchedulingDynamic | LocalEvaluationSchedulingStatic | None = None
Control how local asynchronous jobs are scheduled
- pydantic model dakota.spec.interface.Batch
Perform evaluations in batches
Show JSON schema
{ "title": "Batch", "description": "Perform evaluations in batches", "type": "object", "properties": { "batch": { "$ref": "#/$defs/BatchConfig", "x-materialization": [ { "ir_key": "interface.batch", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "$defs": { "BatchConfig": { "additionalProperties": false, "description": "Perform evaluations in batches", "properties": { "size": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Limit the number of evaluations in a batch", "title": "Size", "x-materialization": [ { "ir_key": "interface.asynch_local_evaluation_concurrency", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "title": "BatchConfig", "type": "object" } }, "additionalProperties": false, "required": [ "batch" ] }
- field batch: BatchConfig [Required]
Perform evaluations in batches
- pydantic model dakota.spec.interface.BatchConfig
Perform evaluations in batches
Show JSON schema
{ "title": "BatchConfig", "description": "Perform evaluations in batches", "type": "object", "properties": { "size": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Limit the number of evaluations in a batch", "title": "Size", "x-materialization": [ { "ir_key": "interface.asynch_local_evaluation_concurrency", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "additionalProperties": false }
- Fields:
- field size: int | None = None
Limit the number of evaluations in a batch
- Constraints:
gt = 0
- pydantic model dakota.spec.interface.Continuation
Cause Dakota to step toward the failed "target" simulation from a nearby successful "source"
Show JSON schema
{ "title": "Continuation", "description": "Cause Dakota to step toward the failed \\\"target\\\" simulation from a nearby successful \\\"source\\\"", "type": "object", "properties": { "continuation": { "const": true, "default": true, "description": "Cause Dakota to step toward the failed \"target\" simulation from a nearby successful \"source\"", "title": "Continuation", "type": "boolean", "x-materialization": [ { "ir_key": "interface.failure_capture.action", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "continuation" } ] } }, "additionalProperties": false }
- Fields:
- field continuation: Literal[True] = True
Cause Dakota to step toward the failed “target” simulation from a nearby successful “source”
- pydantic model dakota.spec.interface.Deactivate
Deactivate Dakota interface features for simplicity or efficiency
Show JSON schema
{ "title": "Deactivate", "description": "Deactivate Dakota interface features for simplicity or efficiency", "type": "object", "properties": { "active_set_vector": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Deactivate the Active Set Vector", "title": "Active Set Vector", "x-materialization": [ { "ir_key": "interface.active_set_vector", "ir_value_type": "bool", "storage_type": "PRESENCE_FALSE" } ] }, "evaluation_cache": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Do not retain function evaluation history in memory", "title": "Evaluation Cache", "x-materialization": [ { "ir_key": "interface.evaluation_cache", "ir_value_type": "bool", "storage_type": "PRESENCE_FALSE" } ] }, "strict_cache_equality": { "anyOf": [ { "$ref": "#/$defs/StrictCacheEquality" }, { "type": "null" } ], "default": null, "description": "Do not require strict cache equality when finding duplicates", "x-materialization": [ { "ir_key": "interface.nearby_evaluation_cache", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "restart_file": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Deactivate writing to the restart file", "title": "Restart File", "x-materialization": [ { "ir_key": "interface.restart_file", "ir_value_type": "bool", "storage_type": "PRESENCE_FALSE" } ] } }, "$defs": { "StrictCacheEquality": { "additionalProperties": false, "description": "Do not require strict cache equality when finding duplicates", "properties": { "cache_tolerance": { "default": 2.220446049250313e-16, "description": "Specify tolerance when identifying duplicate function evaluations", "title": "Cache Tolerance", "type": "number", "x-materialization": [ { "ir_key": "interface.nearby_evaluation_cache_tolerance", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] } }, "title": "StrictCacheEquality", "type": "object" } }, "additionalProperties": false }
- Fields:
- field active_set_vector: Literal[True] | None = None
Deactivate the Active Set Vector
- field evaluation_cache: Literal[True] | None = None
Do not retain function evaluation history in memory
- field restart_file: Literal[True] | None = None
Deactivate writing to the restart file
- field strict_cache_equality: StrictCacheEquality | None = None
Do not require strict cache equality when finding duplicates
- pydantic model dakota.spec.interface.Direct
Run analysis drivers that are linked-to or compiled-with Dakota
Show JSON schema
{ "title": "Direct", "description": "Run analysis drivers that are linked-to or compiled-with Dakota", "type": "object", "properties": { "direct": { "$ref": "#/$defs/DirectConfig", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TEST_INTERFACE" } ] } }, "$defs": { "DirectConfig": { "additionalProperties": false, "description": "Run analysis drivers that are linked-to or compiled-with Dakota", "properties": { "processors_per_analysis": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Specify the number of processors per analysis when Dakota is run in parallel", "title": "Processors Per Analysis", "x-materialization": [ { "ir_key": "interface.direct.processors_per_analysis", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "title": "DirectConfig", "type": "object" } }, "additionalProperties": false, "required": [ "direct" ] }
- field direct: DirectConfig [Required]
Run analysis drivers that are linked-to or compiled-with Dakota
- pydantic model dakota.spec.interface.DirectConfig
Run analysis drivers that are linked-to or compiled-with Dakota
Show JSON schema
{ "title": "DirectConfig", "description": "Run analysis drivers that are linked-to or compiled-with Dakota", "type": "object", "properties": { "processors_per_analysis": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Specify the number of processors per analysis when Dakota is run in parallel", "title": "Processors Per Analysis", "x-materialization": [ { "ir_key": "interface.direct.processors_per_analysis", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "additionalProperties": false }
- field processors_per_analysis: int | None = None
Specify the number of processors per analysis when Dakota is run in parallel
- Constraints:
gt = 0
- pydantic model dakota.spec.interface.EvaluationSchedulingDedicated
Specify a dedicated scheduler partition for concurrent evaluation scheduling
Show JSON schema
{ "title": "EvaluationSchedulingDedicated", "description": "Specify a dedicated scheduler partition for concurrent evaluation scheduling", "type": "object", "properties": { "dedicated": { "const": true, "default": true, "description": "Specify a dedicated scheduler partition for concurrent evaluation scheduling", "title": "Dedicated", "type": "boolean", "x-materialization": [ { "ir_key": "interface.evaluation_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "DEDICATED_SCHEDULER_DYNAMIC" } ] } }, "additionalProperties": false }
- Fields:
- field dedicated: Literal[True] = True
Specify a dedicated scheduler partition for concurrent evaluation scheduling
- pydantic model dakota.spec.interface.EvaluationSchedulingPeer
Specify a peer partition for parallel evaluation scheduling
Show JSON schema
{ "title": "EvaluationSchedulingPeer", "description": "Specify a peer partition for parallel evaluation scheduling", "type": "object", "properties": { "peer": { "anyOf": [ { "$ref": "#/$defs/PeerDynamic" }, { "$ref": "#/$defs/PeerStatic" } ], "description": "Specify a peer partition for parallel evaluation scheduling", "title": "Peer" } }, "$defs": { "PeerDynamic": { "additionalProperties": false, "description": "Specify dynamic scheduling in a peer partition when Dakota is run in parallel.", "properties": { "dynamic": { "const": true, "default": true, "description": "Specify dynamic scheduling in a peer partition when Dakota is run in parallel.", "title": "Dynamic", "type": "boolean", "x-materialization": [ { "ir_key": "interface.evaluation_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "PEER_DYNAMIC_SCHEDULING" } ] } }, "title": "PeerDynamic", "type": "object" }, "PeerStatic": { "additionalProperties": false, "description": "Specify static scheduling in a peer partition when Dakota is run in parallel.", "properties": { "static": { "const": true, "default": true, "description": "Specify static scheduling in a peer partition when Dakota is run in parallel.", "title": "Static", "type": "boolean", "x-materialization": [ { "ir_key": "interface.evaluation_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "PEER_STATIC_SCHEDULING" } ] } }, "title": "PeerStatic", "type": "object" } }, "additionalProperties": false, "required": [ "peer" ] }
- field peer: PeerDynamic | PeerStatic [Required]
Specify a peer partition for parallel evaluation scheduling
- pydantic model dakota.spec.interface.Fork
Launch analysis drivers using fork command
Show JSON schema
{ "title": "Fork", "description": "Launch analysis drivers using fork command", "type": "object", "properties": { "fork": { "$ref": "#/$defs/ForkConfig", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "FORK_INTERFACE" } ] } }, "$defs": { "ForkConfig": { "additionalProperties": false, "description": "Launch analysis drivers using fork command", "properties": { "parameters_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify the name of the parameters file", "title": "Parameters File", "x-materialization": [ { "ir_key": "interface.application.parameters_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "results_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify the name of the results file", "title": "Results File", "x-materialization": [ { "ir_key": "interface.application.results_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "parameters_format": { "anyOf": [ { "$ref": "#/$defs/ForkParametersFormatStandard" }, { "$ref": "#/$defs/ForkParametersFormatAprepro" }, { "$ref": "#/$defs/ForkParametersFormatJsonFormat" }, { "type": "null" } ], "default": null, "description": "Format of the parameters file", "title": "Parameters Format", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ], "x-union-pattern": 2 }, "results_format": { "anyOf": [ { "$ref": "#/$defs/ForkResultsFormatStandard" }, { "$ref": "#/$defs/ForkResultsFormatJsonFormat" }, { "type": "null" } ], "default": null, "description": "Format of the results file", "title": "Results Format", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ], "x-union-pattern": 2 }, "file_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each parameters & results file name with the function evaluation number", "title": "File Tag", "x-materialization": [ { "ir_key": "interface.application.file_tag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "file_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Keep the parameters & results files after the analysis driver completes", "title": "File Save", "x-materialization": [ { "ir_key": "interface.application.file_save", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "work_directory": { "anyOf": [ { "$ref": "#/$defs/ForkWorkDirectory" }, { "type": "null" } ], "default": null, "description": "Perform each function evaluation in a separate working directory", "x-materialization": [ { "ir_key": "interface.useWorkdir", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "allow_existing_results": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Change how Dakota deals with existing results files", "title": "Allow Existing Results", "x-materialization": [ { "ir_key": "interface.allow_existing_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "verbatim": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Specify the command Dakota uses to launch analysis driver(s) and filters", "title": "Verbatim", "x-materialization": [ { "ir_key": "interface.application.verbatim", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ForkConfig", "type": "object" }, "ForkParametersFormatAprepro": { "additionalProperties": false, "description": "Use the APREPRO format for parameters files", "properties": { "aprepro": { "const": true, "default": true, "description": "Use the APREPRO format for parameters files", "title": "Aprepro", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_APREPRO" } ] } }, "title": "ForkParametersFormatAprepro", "type": "object" }, "ForkParametersFormatJsonFormat": { "additionalProperties": false, "description": "Use the JSON format for parameters files", "properties": { "json_format": { "const": true, "default": true, "description": "Use the JSON format for parameters files", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_JSON" } ] } }, "title": "ForkParametersFormatJsonFormat", "type": "object" }, "ForkParametersFormatStandard": { "additionalProperties": false, "description": "Use the standard format for parameters files", "properties": { "standard": { "const": true, "default": true, "description": "Use the standard format for parameters files", "title": "Standard", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ] } }, "title": "ForkParametersFormatStandard", "type": "object" }, "ForkResultsFormatJsonFormat": { "additionalProperties": false, "description": "Expect results files in JSON format", "properties": { "json_format": { "const": true, "default": true, "description": "Expect results files in JSON format", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_JSON" } ] } }, "title": "ForkResultsFormatJsonFormat", "type": "object" }, "ForkResultsFormatStandard": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "standard": { "$ref": "#/$defs/ForkResultsFormatStandardConfig", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ] } }, "required": [ "standard" ], "title": "ForkResultsFormatStandard", "type": "object" }, "ForkResultsFormatStandardConfig": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "labeled": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Requires correct function value labels in results file", "title": "Labeled", "x-materialization": [ { "ir_key": "interface.labeled_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ForkResultsFormatStandardConfig", "type": "object" }, "ForkWorkDirectory": { "additionalProperties": false, "description": "Perform each function evaluation in a separate working directory", "properties": { "named": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The base name of the work directory created by Dakota", "title": "Named", "x-materialization": [ { "ir_key": "interface.workDir", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "directory_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each work directory with the function evaluation number", "title": "Directory Tag", "x-aliases": [ "dir_tag" ], "x-materialization": [ { "ir_key": "interface.dirTag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "directory_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Preserve the work directory after function evaluation completion", "title": "Directory Save", "x-aliases": [ "dir_save" ], "x-materialization": [ { "ir_key": "interface.dirSave", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "link_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Paths to be linked into each working directory", "title": "Link Files", "x-materialization": [ { "ir_key": "interface.linkFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "copy_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Files and directories to be copied into each working directory", "title": "Copy Files", "x-materialization": [ { "ir_key": "interface.copyFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "replace": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Overwrite existing files within a work directory", "title": "Replace", "x-materialization": [ { "ir_key": "interface.templateReplace", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ForkWorkDirectory", "type": "object" } }, "additionalProperties": false, "required": [ "fork" ] }
- field fork: ForkConfig [Required]
Launch analysis drivers using fork command
- pydantic model dakota.spec.interface.ForkConfig
Launch analysis drivers using fork command
Show JSON schema
{ "title": "ForkConfig", "description": "Launch analysis drivers using fork command", "type": "object", "properties": { "parameters_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify the name of the parameters file", "title": "Parameters File", "x-materialization": [ { "ir_key": "interface.application.parameters_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "results_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify the name of the results file", "title": "Results File", "x-materialization": [ { "ir_key": "interface.application.results_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "parameters_format": { "anyOf": [ { "$ref": "#/$defs/ForkParametersFormatStandard" }, { "$ref": "#/$defs/ForkParametersFormatAprepro" }, { "$ref": "#/$defs/ForkParametersFormatJsonFormat" }, { "type": "null" } ], "default": null, "description": "Format of the parameters file", "title": "Parameters Format", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ], "x-union-pattern": 2 }, "results_format": { "anyOf": [ { "$ref": "#/$defs/ForkResultsFormatStandard" }, { "$ref": "#/$defs/ForkResultsFormatJsonFormat" }, { "type": "null" } ], "default": null, "description": "Format of the results file", "title": "Results Format", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ], "x-union-pattern": 2 }, "file_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each parameters & results file name with the function evaluation number", "title": "File Tag", "x-materialization": [ { "ir_key": "interface.application.file_tag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "file_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Keep the parameters & results files after the analysis driver completes", "title": "File Save", "x-materialization": [ { "ir_key": "interface.application.file_save", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "work_directory": { "anyOf": [ { "$ref": "#/$defs/ForkWorkDirectory" }, { "type": "null" } ], "default": null, "description": "Perform each function evaluation in a separate working directory", "x-materialization": [ { "ir_key": "interface.useWorkdir", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "allow_existing_results": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Change how Dakota deals with existing results files", "title": "Allow Existing Results", "x-materialization": [ { "ir_key": "interface.allow_existing_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "verbatim": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Specify the command Dakota uses to launch analysis driver(s) and filters", "title": "Verbatim", "x-materialization": [ { "ir_key": "interface.application.verbatim", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "$defs": { "ForkParametersFormatAprepro": { "additionalProperties": false, "description": "Use the APREPRO format for parameters files", "properties": { "aprepro": { "const": true, "default": true, "description": "Use the APREPRO format for parameters files", "title": "Aprepro", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_APREPRO" } ] } }, "title": "ForkParametersFormatAprepro", "type": "object" }, "ForkParametersFormatJsonFormat": { "additionalProperties": false, "description": "Use the JSON format for parameters files", "properties": { "json_format": { "const": true, "default": true, "description": "Use the JSON format for parameters files", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_JSON" } ] } }, "title": "ForkParametersFormatJsonFormat", "type": "object" }, "ForkParametersFormatStandard": { "additionalProperties": false, "description": "Use the standard format for parameters files", "properties": { "standard": { "const": true, "default": true, "description": "Use the standard format for parameters files", "title": "Standard", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ] } }, "title": "ForkParametersFormatStandard", "type": "object" }, "ForkResultsFormatJsonFormat": { "additionalProperties": false, "description": "Expect results files in JSON format", "properties": { "json_format": { "const": true, "default": true, "description": "Expect results files in JSON format", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_JSON" } ] } }, "title": "ForkResultsFormatJsonFormat", "type": "object" }, "ForkResultsFormatStandard": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "standard": { "$ref": "#/$defs/ForkResultsFormatStandardConfig", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ] } }, "required": [ "standard" ], "title": "ForkResultsFormatStandard", "type": "object" }, "ForkResultsFormatStandardConfig": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "labeled": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Requires correct function value labels in results file", "title": "Labeled", "x-materialization": [ { "ir_key": "interface.labeled_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ForkResultsFormatStandardConfig", "type": "object" }, "ForkWorkDirectory": { "additionalProperties": false, "description": "Perform each function evaluation in a separate working directory", "properties": { "named": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The base name of the work directory created by Dakota", "title": "Named", "x-materialization": [ { "ir_key": "interface.workDir", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "directory_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each work directory with the function evaluation number", "title": "Directory Tag", "x-aliases": [ "dir_tag" ], "x-materialization": [ { "ir_key": "interface.dirTag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "directory_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Preserve the work directory after function evaluation completion", "title": "Directory Save", "x-aliases": [ "dir_save" ], "x-materialization": [ { "ir_key": "interface.dirSave", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "link_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Paths to be linked into each working directory", "title": "Link Files", "x-materialization": [ { "ir_key": "interface.linkFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "copy_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Files and directories to be copied into each working directory", "title": "Copy Files", "x-materialization": [ { "ir_key": "interface.copyFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "replace": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Overwrite existing files within a work directory", "title": "Replace", "x-materialization": [ { "ir_key": "interface.templateReplace", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ForkWorkDirectory", "type": "object" } }, "additionalProperties": false }
- field allow_existing_results: Literal[True] | None = None
Change how Dakota deals with existing results files
- field file_save: Literal[True] | None = None
Keep the parameters & results files after the analysis driver completes
- field file_tag: Literal[True] | None = None
Tag each parameters & results file name with the function evaluation number
- field parameters_file: str | None = None
Specify the name of the parameters file
- field parameters_format: ForkParametersFormatStandard | ForkParametersFormatAprepro | ForkParametersFormatJsonFormat | None = None
Format of the parameters file
- field results_file: str | None = None
Specify the name of the results file
- field results_format: ForkResultsFormatStandard | ForkResultsFormatJsonFormat | None = None
Format of the results file
- field verbatim: Literal[True] | None = None
Specify the command Dakota uses to launch analysis driver(s) and filters
- field work_directory: ForkWorkDirectory | None = None
Perform each function evaluation in a separate working directory
- pydantic model dakota.spec.interface.ForkParametersFormatAprepro
Use the APREPRO format for parameters files
Show JSON schema
{ "title": "ForkParametersFormatAprepro", "description": "Use the APREPRO format for parameters files", "type": "object", "properties": { "aprepro": { "const": true, "default": true, "description": "Use the APREPRO format for parameters files", "title": "Aprepro", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_APREPRO" } ] } }, "additionalProperties": false }
- Fields:
- field aprepro: Literal[True] = True
Use the APREPRO format for parameters files
- pydantic model dakota.spec.interface.ForkParametersFormatJsonFormat
Use the JSON format for parameters files
Show JSON schema
{ "title": "ForkParametersFormatJsonFormat", "description": "Use the JSON format for parameters files", "type": "object", "properties": { "json_format": { "const": true, "default": true, "description": "Use the JSON format for parameters files", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_JSON" } ] } }, "additionalProperties": false }
- Fields:
- field json_format: Literal[True] = True
Use the JSON format for parameters files
- pydantic model dakota.spec.interface.ForkParametersFormatStandard
Use the standard format for parameters files
Show JSON schema
{ "title": "ForkParametersFormatStandard", "description": "Use the standard format for parameters files", "type": "object", "properties": { "standard": { "const": true, "default": true, "description": "Use the standard format for parameters files", "title": "Standard", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ] } }, "additionalProperties": false }
- Fields:
- field standard: Literal[True] = True
Use the standard format for parameters files
- pydantic model dakota.spec.interface.ForkResultsFormatJsonFormat
Expect results files in JSON format
Show JSON schema
{ "title": "ForkResultsFormatJsonFormat", "description": "Expect results files in JSON format", "type": "object", "properties": { "json_format": { "const": true, "default": true, "description": "Expect results files in JSON format", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_JSON" } ] } }, "additionalProperties": false }
- Fields:
- field json_format: Literal[True] = True
Expect results files in JSON format
- pydantic model dakota.spec.interface.ForkResultsFormatStandard
Expect results files in standard format
Show JSON schema
{ "title": "ForkResultsFormatStandard", "description": "Expect results files in standard format", "type": "object", "properties": { "standard": { "$ref": "#/$defs/ForkResultsFormatStandardConfig", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ] } }, "$defs": { "ForkResultsFormatStandardConfig": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "labeled": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Requires correct function value labels in results file", "title": "Labeled", "x-materialization": [ { "ir_key": "interface.labeled_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ForkResultsFormatStandardConfig", "type": "object" } }, "additionalProperties": false, "required": [ "standard" ] }
- field standard: ForkResultsFormatStandardConfig [Required]
Expect results files in standard format
- pydantic model dakota.spec.interface.ForkResultsFormatStandardConfig
Expect results files in standard format
Show JSON schema
{ "title": "ForkResultsFormatStandardConfig", "description": "Expect results files in standard format", "type": "object", "properties": { "labeled": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Requires correct function value labels in results file", "title": "Labeled", "x-materialization": [ { "ir_key": "interface.labeled_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "additionalProperties": false }
- Fields:
- field labeled: Literal[True] | None = None
Requires correct function value labels in results file
- pydantic model dakota.spec.interface.ForkWorkDirectory
Perform each function evaluation in a separate working directory
Show JSON schema
{ "title": "ForkWorkDirectory", "description": "Perform each function evaluation in a separate working directory", "type": "object", "properties": { "named": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The base name of the work directory created by Dakota", "title": "Named", "x-materialization": [ { "ir_key": "interface.workDir", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "directory_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each work directory with the function evaluation number", "title": "Directory Tag", "x-aliases": [ "dir_tag" ], "x-materialization": [ { "ir_key": "interface.dirTag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "directory_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Preserve the work directory after function evaluation completion", "title": "Directory Save", "x-aliases": [ "dir_save" ], "x-materialization": [ { "ir_key": "interface.dirSave", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "link_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Paths to be linked into each working directory", "title": "Link Files", "x-materialization": [ { "ir_key": "interface.linkFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "copy_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Files and directories to be copied into each working directory", "title": "Copy Files", "x-materialization": [ { "ir_key": "interface.copyFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "replace": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Overwrite existing files within a work directory", "title": "Replace", "x-materialization": [ { "ir_key": "interface.templateReplace", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "additionalProperties": false }
- Fields:
- field copy_files: list[str] | None = None
Files and directories to be copied into each working directory
- field directory_save: Literal[True] | None = None
Preserve the work directory after function evaluation completion
- field directory_tag: Literal[True] | None = None
Tag each work directory with the function evaluation number
- field link_files: list[str] | None = None
Paths to be linked into each working directory
- field named: str | None = None
The base name of the work directory created by Dakota
- field replace: Literal[True] | None = None
Overwrite existing files within a work directory
- pydantic model dakota.spec.interface.LocalEvaluationSchedulingDynamic
Dynamic local scheduling (sequential)
Show JSON schema
{ "title": "LocalEvaluationSchedulingDynamic", "description": "Dynamic local scheduling (sequential)", "type": "object", "properties": { "dynamic": { "const": true, "default": true, "description": "Dynamic local scheduling (sequential)", "title": "Dynamic", "type": "boolean", "x-materialization": [ { "ir_key": "interface.local_evaluation_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "DYNAMIC_SCHEDULING" } ] } }, "additionalProperties": false }
- Fields:
- field dynamic: Literal[True] = True
Dynamic local scheduling (sequential)
- pydantic model dakota.spec.interface.LocalEvaluationSchedulingStatic
Static local scheduling (tiled)
Show JSON schema
{ "title": "LocalEvaluationSchedulingStatic", "description": "Static local scheduling (tiled)", "type": "object", "properties": { "static": { "const": true, "default": true, "description": "Static local scheduling (tiled)", "title": "Static", "type": "boolean", "x-materialization": [ { "ir_key": "interface.local_evaluation_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "STATIC_SCHEDULING" } ] } }, "additionalProperties": false }
- Fields:
- field static: Literal[True] = True
Static local scheduling (tiled)
- pydantic model dakota.spec.interface.Matlab
Run Matlab through a direct interface - requires special Dakota build
Show JSON schema
{ "title": "Matlab", "description": "Run Matlab through a direct interface - requires special Dakota build", "type": "object", "properties": { "matlab": { "const": true, "default": true, "description": "Run Matlab through a direct interface - requires special Dakota build", "title": "Matlab", "type": "boolean", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "MATLAB_INTERFACE" } ] } }, "additionalProperties": false }
- Fields:
- field matlab: Literal[True] = True
Run Matlab through a direct interface - requires special Dakota build
- pydantic model dakota.spec.interface.PeerDynamic
Specify dynamic scheduling in a peer partition when Dakota is run in parallel.
Show JSON schema
{ "title": "PeerDynamic", "description": "Specify dynamic scheduling in a peer partition when Dakota is run in parallel.", "type": "object", "properties": { "dynamic": { "const": true, "default": true, "description": "Specify dynamic scheduling in a peer partition when Dakota is run in parallel.", "title": "Dynamic", "type": "boolean", "x-materialization": [ { "ir_key": "interface.evaluation_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "PEER_DYNAMIC_SCHEDULING" } ] } }, "additionalProperties": false }
- Fields:
- field dynamic: Literal[True] = True
Specify dynamic scheduling in a peer partition when Dakota is run in parallel.
- pydantic model dakota.spec.interface.PeerStatic
Specify static scheduling in a peer partition when Dakota is run in parallel.
Show JSON schema
{ "title": "PeerStatic", "description": "Specify static scheduling in a peer partition when Dakota is run in parallel.", "type": "object", "properties": { "static": { "const": true, "default": true, "description": "Specify static scheduling in a peer partition when Dakota is run in parallel.", "title": "Static", "type": "boolean", "x-materialization": [ { "ir_key": "interface.evaluation_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "PEER_STATIC_SCHEDULING" } ] } }, "additionalProperties": false }
- Fields:
- field static: Literal[True] = True
Specify static scheduling in a peer partition when Dakota is run in parallel.
- pydantic model dakota.spec.interface.Plugin
Dynamically load a plugin analysis driver
Show JSON schema
{ "title": "Plugin", "description": "Dynamically load a plugin analysis driver", "type": "object", "properties": { "plugin": { "$ref": "#/$defs/PluginConfig", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PLUGIN_INTERFACE" } ] } }, "$defs": { "PluginConfig": { "additionalProperties": false, "description": "Dynamically load a plugin analysis driver", "properties": { "library_path": { "description": "Path to the plugin shared object file", "title": "Library Path", "type": "string", "x-materialization": [ { "ir_key": "interface.plugin_library_path", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "library_path" ], "title": "PluginConfig", "type": "object" } }, "additionalProperties": false, "required": [ "plugin" ] }
- field plugin: PluginConfig [Required]
Dynamically load a plugin analysis driver
- pydantic model dakota.spec.interface.PluginConfig
Dynamically load a plugin analysis driver
Show JSON schema
{ "title": "PluginConfig", "description": "Dynamically load a plugin analysis driver", "type": "object", "properties": { "library_path": { "description": "Path to the plugin shared object file", "title": "Library Path", "type": "string", "x-materialization": [ { "ir_key": "interface.plugin_library_path", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "additionalProperties": false, "required": [ "library_path" ] }
- Fields:
- field library_path: str [Required]
Path to the plugin shared object file
- pydantic model dakota.spec.interface.Python
Run Python through a Pybind11-based direct interface - requires a special Dakota build
Show JSON schema
{ "title": "Python", "description": "Run Python through a Pybind11-based direct interface - requires a special Dakota build", "type": "object", "properties": { "python": { "$ref": "#/$defs/PythonConfig", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PYTHON_INTERFACE" } ] } }, "$defs": { "PythonConfig": { "additionalProperties": false, "description": "Run Python through a Pybind11-based direct interface - requires a special Dakota build", "properties": { "numpy": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Enable the use of numpy in Dakota's Python interface", "title": "Numpy", "x-materialization": [ { "ir_key": "interface.python.numpy", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "PythonConfig", "type": "object" } }, "additionalProperties": false, "required": [ "python" ] }
- field python: PythonConfig [Required]
Run Python through a Pybind11-based direct interface - requires a special Dakota build
- pydantic model dakota.spec.interface.PythonConfig
Run Python through a Pybind11-based direct interface - requires a special Dakota build
Show JSON schema
{ "title": "PythonConfig", "description": "Run Python through a Pybind11-based direct interface - requires a special Dakota build", "type": "object", "properties": { "numpy": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Enable the use of numpy in Dakota's Python interface", "title": "Numpy", "x-materialization": [ { "ir_key": "interface.python.numpy", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "additionalProperties": false }
- Fields:
- field numpy: Literal[True] | None = None
Enable the use of numpy in Dakota’s Python interface
- pydantic model dakota.spec.interface.Recover
Substitute dummy values for the responses
Show JSON schema
{ "title": "Recover", "description": "Substitute dummy values for the responses", "type": "object", "properties": { "recover": { "description": "Substitute dummy values for the responses", "items": { "type": "number" }, "title": "Recover", "type": "array", "x-materialization": [ { "ir_key": "interface.failure_capture.action", "ir_value_type": "String", "secondary_ir_key": "interface.failure_capture.recovery_fn_vals", "secondary_ir_value_type": "RealVector", "storage_type": "TYPE_DATA_COMBINED", "stored_value": "recover" } ] } }, "additionalProperties": false, "required": [ "recover" ] }
- Fields:
- field recover: list[DakotaFloat] [Required]
Substitute dummy values for the responses
- pydantic model dakota.spec.interface.Retry
Rerun failed analyses
Show JSON schema
{ "title": "Retry", "description": "Rerun failed analyses", "type": "object", "properties": { "retry": { "description": "Rerun failed analyses", "title": "Retry", "type": "integer", "x-materialization": [ { "ir_key": "interface.failure_capture.action", "ir_value_type": "String", "secondary_ir_key": "interface.failure_capture.retry_limit", "secondary_ir_value_type": "int", "storage_type": "TYPE_DATA_COMBINED", "stored_value": "retry" } ] } }, "additionalProperties": false, "required": [ "retry" ] }
- Fields:
- field retry: int [Required]
Rerun failed analyses
- pydantic model dakota.spec.interface.Scilab
Run Scilab through a direct interface - requires special Dakota build
Show JSON schema
{ "title": "Scilab", "description": "Run Scilab through a direct interface - requires special Dakota build", "type": "object", "properties": { "scilab": { "const": true, "default": true, "description": "Run Scilab through a direct interface - requires special Dakota build", "title": "Scilab", "type": "boolean", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "SCILAB_INTERFACE" } ] } }, "additionalProperties": false }
- Fields:
- field scilab: Literal[True] = True
Run Scilab through a direct interface - requires special Dakota build
- pydantic model dakota.spec.interface.StrictCacheEquality
Do not require strict cache equality when finding duplicates
Show JSON schema
{ "title": "StrictCacheEquality", "description": "Do not require strict cache equality when finding duplicates", "type": "object", "properties": { "cache_tolerance": { "default": 2.220446049250313e-16, "description": "Specify tolerance when identifying duplicate function evaluations", "title": "Cache Tolerance", "type": "number", "x-materialization": [ { "ir_key": "interface.nearby_evaluation_cache_tolerance", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] } }, "additionalProperties": false }
- Fields:
- field cache_tolerance: DakotaFloat = 2.220446049250313e-16
Specify tolerance when identifying duplicate function evaluations
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
- pydantic model dakota.spec.interface.System
(Not recommended) Launch analysis drivers with a system call
Show JSON schema
{ "title": "System", "description": "(Not recommended) Launch analysis drivers with a system call", "type": "object", "properties": { "system": { "$ref": "#/$defs/SystemConfig", "x-materialization": [ { "ir_key": "interface.type", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "SYSTEM_INTERFACE" } ] } }, "$defs": { "SystemConfig": { "additionalProperties": false, "description": "(Not recommended) Launch analysis drivers with a system call", "properties": { "parameters_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify the name of the parameters file", "title": "Parameters File", "x-materialization": [ { "ir_key": "interface.application.parameters_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "results_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify the name of the results file", "title": "Results File", "x-materialization": [ { "ir_key": "interface.application.results_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "parameters_format": { "anyOf": [ { "$ref": "#/$defs/SystemParametersFormatStandard" }, { "$ref": "#/$defs/SystemParametersFormatAprepro" }, { "$ref": "#/$defs/SystemParametersFormatJsonFormat" }, { "type": "null" } ], "default": null, "description": "Format of the parameters file", "title": "Parameters Format", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ], "x-union-pattern": 2 }, "results_format": { "anyOf": [ { "$ref": "#/$defs/SystemResultsFormatStandard" }, { "$ref": "#/$defs/SystemResultsFormatJsonFormat" }, { "type": "null" } ], "default": null, "description": "Format of the results file", "title": "Results Format", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ], "x-union-pattern": 2 }, "file_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each parameters & results file name with the function evaluation number", "title": "File Tag", "x-materialization": [ { "ir_key": "interface.application.file_tag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "file_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Keep the parameters & results files after the analysis driver completes", "title": "File Save", "x-materialization": [ { "ir_key": "interface.application.file_save", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "work_directory": { "anyOf": [ { "$ref": "#/$defs/SystemWorkDirectory" }, { "type": "null" } ], "default": null, "description": "Perform each function evaluation in a separate working directory", "x-materialization": [ { "ir_key": "interface.useWorkdir", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "allow_existing_results": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Change how Dakota deals with existing results files", "title": "Allow Existing Results", "x-materialization": [ { "ir_key": "interface.allow_existing_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "verbatim": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Specify the command Dakota uses to launch analysis driver(s) and filters", "title": "Verbatim", "x-materialization": [ { "ir_key": "interface.application.verbatim", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "SystemConfig", "type": "object" }, "SystemParametersFormatAprepro": { "additionalProperties": false, "description": "Use the APREPRO format for parameters files", "properties": { "aprepro": { "const": true, "default": true, "description": "Use the APREPRO format for parameters files", "title": "Aprepro", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_APREPRO" } ] } }, "title": "SystemParametersFormatAprepro", "type": "object" }, "SystemParametersFormatJsonFormat": { "additionalProperties": false, "description": "Use the JSON format for parameters files", "properties": { "json_format": { "const": true, "default": true, "description": "Use the JSON format for parameters files", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_JSON" } ] } }, "title": "SystemParametersFormatJsonFormat", "type": "object" }, "SystemParametersFormatStandard": { "additionalProperties": false, "description": "Use the standard format for parameters files", "properties": { "standard": { "const": true, "default": true, "description": "Use the standard format for parameters files", "title": "Standard", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ] } }, "title": "SystemParametersFormatStandard", "type": "object" }, "SystemResultsFormatJsonFormat": { "additionalProperties": false, "description": "Expect results files in JSON format", "properties": { "json_format": { "const": true, "default": true, "description": "Expect results files in JSON format", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_JSON" } ] } }, "title": "SystemResultsFormatJsonFormat", "type": "object" }, "SystemResultsFormatStandard": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "standard": { "$ref": "#/$defs/SystemResultsFormatStandardConfig", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ] } }, "required": [ "standard" ], "title": "SystemResultsFormatStandard", "type": "object" }, "SystemResultsFormatStandardConfig": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "labeled": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Requires correct function value labels in results file", "title": "Labeled", "x-materialization": [ { "ir_key": "interface.labeled_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "SystemResultsFormatStandardConfig", "type": "object" }, "SystemWorkDirectory": { "additionalProperties": false, "description": "Perform each function evaluation in a separate working directory", "properties": { "named": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The base name of the work directory created by Dakota", "title": "Named", "x-materialization": [ { "ir_key": "interface.workDir", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "directory_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each work directory with the function evaluation number", "title": "Directory Tag", "x-aliases": [ "dir_tag" ], "x-materialization": [ { "ir_key": "interface.dirTag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "directory_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Preserve the work directory after function evaluation completion", "title": "Directory Save", "x-aliases": [ "dir_save" ], "x-materialization": [ { "ir_key": "interface.dirSave", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "link_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Paths to be linked into each working directory", "title": "Link Files", "x-materialization": [ { "ir_key": "interface.linkFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "copy_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Files and directories to be copied into each working directory", "title": "Copy Files", "x-materialization": [ { "ir_key": "interface.copyFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "replace": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Overwrite existing files within a work directory", "title": "Replace", "x-materialization": [ { "ir_key": "interface.templateReplace", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "SystemWorkDirectory", "type": "object" } }, "additionalProperties": false, "required": [ "system" ] }
- field system: SystemConfig [Required]
(Not recommended) Launch analysis drivers with a system call
- pydantic model dakota.spec.interface.SystemConfig
(Not recommended) Launch analysis drivers with a system call
Show JSON schema
{ "title": "SystemConfig", "description": "(Not recommended) Launch analysis drivers with a system call", "type": "object", "properties": { "parameters_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify the name of the parameters file", "title": "Parameters File", "x-materialization": [ { "ir_key": "interface.application.parameters_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "results_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify the name of the results file", "title": "Results File", "x-materialization": [ { "ir_key": "interface.application.results_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "parameters_format": { "anyOf": [ { "$ref": "#/$defs/SystemParametersFormatStandard" }, { "$ref": "#/$defs/SystemParametersFormatAprepro" }, { "$ref": "#/$defs/SystemParametersFormatJsonFormat" }, { "type": "null" } ], "default": null, "description": "Format of the parameters file", "title": "Parameters Format", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ], "x-union-pattern": 2 }, "results_format": { "anyOf": [ { "$ref": "#/$defs/SystemResultsFormatStandard" }, { "$ref": "#/$defs/SystemResultsFormatJsonFormat" }, { "type": "null" } ], "default": null, "description": "Format of the results file", "title": "Results Format", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ], "x-union-pattern": 2 }, "file_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each parameters & results file name with the function evaluation number", "title": "File Tag", "x-materialization": [ { "ir_key": "interface.application.file_tag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "file_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Keep the parameters & results files after the analysis driver completes", "title": "File Save", "x-materialization": [ { "ir_key": "interface.application.file_save", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "work_directory": { "anyOf": [ { "$ref": "#/$defs/SystemWorkDirectory" }, { "type": "null" } ], "default": null, "description": "Perform each function evaluation in a separate working directory", "x-materialization": [ { "ir_key": "interface.useWorkdir", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "allow_existing_results": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Change how Dakota deals with existing results files", "title": "Allow Existing Results", "x-materialization": [ { "ir_key": "interface.allow_existing_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "verbatim": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Specify the command Dakota uses to launch analysis driver(s) and filters", "title": "Verbatim", "x-materialization": [ { "ir_key": "interface.application.verbatim", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "$defs": { "SystemParametersFormatAprepro": { "additionalProperties": false, "description": "Use the APREPRO format for parameters files", "properties": { "aprepro": { "const": true, "default": true, "description": "Use the APREPRO format for parameters files", "title": "Aprepro", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_APREPRO" } ] } }, "title": "SystemParametersFormatAprepro", "type": "object" }, "SystemParametersFormatJsonFormat": { "additionalProperties": false, "description": "Use the JSON format for parameters files", "properties": { "json_format": { "const": true, "default": true, "description": "Use the JSON format for parameters files", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_JSON" } ] } }, "title": "SystemParametersFormatJsonFormat", "type": "object" }, "SystemParametersFormatStandard": { "additionalProperties": false, "description": "Use the standard format for parameters files", "properties": { "standard": { "const": true, "default": true, "description": "Use the standard format for parameters files", "title": "Standard", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ] } }, "title": "SystemParametersFormatStandard", "type": "object" }, "SystemResultsFormatJsonFormat": { "additionalProperties": false, "description": "Expect results files in JSON format", "properties": { "json_format": { "const": true, "default": true, "description": "Expect results files in JSON format", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_JSON" } ] } }, "title": "SystemResultsFormatJsonFormat", "type": "object" }, "SystemResultsFormatStandard": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "standard": { "$ref": "#/$defs/SystemResultsFormatStandardConfig", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ] } }, "required": [ "standard" ], "title": "SystemResultsFormatStandard", "type": "object" }, "SystemResultsFormatStandardConfig": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "labeled": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Requires correct function value labels in results file", "title": "Labeled", "x-materialization": [ { "ir_key": "interface.labeled_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "SystemResultsFormatStandardConfig", "type": "object" }, "SystemWorkDirectory": { "additionalProperties": false, "description": "Perform each function evaluation in a separate working directory", "properties": { "named": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The base name of the work directory created by Dakota", "title": "Named", "x-materialization": [ { "ir_key": "interface.workDir", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "directory_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each work directory with the function evaluation number", "title": "Directory Tag", "x-aliases": [ "dir_tag" ], "x-materialization": [ { "ir_key": "interface.dirTag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "directory_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Preserve the work directory after function evaluation completion", "title": "Directory Save", "x-aliases": [ "dir_save" ], "x-materialization": [ { "ir_key": "interface.dirSave", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "link_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Paths to be linked into each working directory", "title": "Link Files", "x-materialization": [ { "ir_key": "interface.linkFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "copy_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Files and directories to be copied into each working directory", "title": "Copy Files", "x-materialization": [ { "ir_key": "interface.copyFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "replace": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Overwrite existing files within a work directory", "title": "Replace", "x-materialization": [ { "ir_key": "interface.templateReplace", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "SystemWorkDirectory", "type": "object" } }, "additionalProperties": false }
- field allow_existing_results: Literal[True] | None = None
Change how Dakota deals with existing results files
- field file_save: Literal[True] | None = None
Keep the parameters & results files after the analysis driver completes
- field file_tag: Literal[True] | None = None
Tag each parameters & results file name with the function evaluation number
- field parameters_file: str | None = None
Specify the name of the parameters file
- field parameters_format: SystemParametersFormatStandard | SystemParametersFormatAprepro | SystemParametersFormatJsonFormat | None = None
Format of the parameters file
- field results_file: str | None = None
Specify the name of the results file
- field results_format: SystemResultsFormatStandard | SystemResultsFormatJsonFormat | None = None
Format of the results file
- field verbatim: Literal[True] | None = None
Specify the command Dakota uses to launch analysis driver(s) and filters
- field work_directory: SystemWorkDirectory | None = None
Perform each function evaluation in a separate working directory
- pydantic model dakota.spec.interface.SystemParametersFormatAprepro
Use the APREPRO format for parameters files
Show JSON schema
{ "title": "SystemParametersFormatAprepro", "description": "Use the APREPRO format for parameters files", "type": "object", "properties": { "aprepro": { "const": true, "default": true, "description": "Use the APREPRO format for parameters files", "title": "Aprepro", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_APREPRO" } ] } }, "additionalProperties": false }
- Fields:
- field aprepro: Literal[True] = True
Use the APREPRO format for parameters files
- pydantic model dakota.spec.interface.SystemParametersFormatJsonFormat
Use the JSON format for parameters files
Show JSON schema
{ "title": "SystemParametersFormatJsonFormat", "description": "Use the JSON format for parameters files", "type": "object", "properties": { "json_format": { "const": true, "default": true, "description": "Use the JSON format for parameters files", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_JSON" } ] } }, "additionalProperties": false }
- Fields:
- field json_format: Literal[True] = True
Use the JSON format for parameters files
- pydantic model dakota.spec.interface.SystemParametersFormatStandard
Use the standard format for parameters files
Show JSON schema
{ "title": "SystemParametersFormatStandard", "description": "Use the standard format for parameters files", "type": "object", "properties": { "standard": { "const": true, "default": true, "description": "Use the standard format for parameters files", "title": "Standard", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.parameters_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "PARAMETERS_FILE_STANDARD" } ] } }, "additionalProperties": false }
- Fields:
- field standard: Literal[True] = True
Use the standard format for parameters files
- pydantic model dakota.spec.interface.SystemResultsFormatJsonFormat
Expect results files in JSON format
Show JSON schema
{ "title": "SystemResultsFormatJsonFormat", "description": "Expect results files in JSON format", "type": "object", "properties": { "json_format": { "const": true, "default": true, "description": "Expect results files in JSON format", "title": "Json Format", "type": "boolean", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_JSON" } ] } }, "additionalProperties": false }
- Fields:
- field json_format: Literal[True] = True
Expect results files in JSON format
- pydantic model dakota.spec.interface.SystemResultsFormatStandard
Expect results files in standard format
Show JSON schema
{ "title": "SystemResultsFormatStandard", "description": "Expect results files in standard format", "type": "object", "properties": { "standard": { "$ref": "#/$defs/SystemResultsFormatStandardConfig", "x-materialization": [ { "ir_key": "interface.application.results_file_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "RESULTS_FILE_STANDARD" } ] } }, "$defs": { "SystemResultsFormatStandardConfig": { "additionalProperties": false, "description": "Expect results files in standard format", "properties": { "labeled": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Requires correct function value labels in results file", "title": "Labeled", "x-materialization": [ { "ir_key": "interface.labeled_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "SystemResultsFormatStandardConfig", "type": "object" } }, "additionalProperties": false, "required": [ "standard" ] }
- field standard: SystemResultsFormatStandardConfig [Required]
Expect results files in standard format
- pydantic model dakota.spec.interface.SystemResultsFormatStandardConfig
Expect results files in standard format
Show JSON schema
{ "title": "SystemResultsFormatStandardConfig", "description": "Expect results files in standard format", "type": "object", "properties": { "labeled": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Requires correct function value labels in results file", "title": "Labeled", "x-materialization": [ { "ir_key": "interface.labeled_results", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "additionalProperties": false }
- Fields:
- field labeled: Literal[True] | None = None
Requires correct function value labels in results file
- pydantic model dakota.spec.interface.SystemWorkDirectory
Perform each function evaluation in a separate working directory
Show JSON schema
{ "title": "SystemWorkDirectory", "description": "Perform each function evaluation in a separate working directory", "type": "object", "properties": { "named": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "The base name of the work directory created by Dakota", "title": "Named", "x-materialization": [ { "ir_key": "interface.workDir", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "directory_tag": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Tag each work directory with the function evaluation number", "title": "Directory Tag", "x-aliases": [ "dir_tag" ], "x-materialization": [ { "ir_key": "interface.dirTag", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "directory_save": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Preserve the work directory after function evaluation completion", "title": "Directory Save", "x-aliases": [ "dir_save" ], "x-materialization": [ { "ir_key": "interface.dirSave", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "link_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Paths to be linked into each working directory", "title": "Link Files", "x-materialization": [ { "ir_key": "interface.linkFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "copy_files": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Files and directories to be copied into each working directory", "title": "Copy Files", "x-materialization": [ { "ir_key": "interface.copyFiles", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "replace": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Overwrite existing files within a work directory", "title": "Replace", "x-materialization": [ { "ir_key": "interface.templateReplace", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "additionalProperties": false }
- Fields:
- field copy_files: list[str] | None = None
Files and directories to be copied into each working directory
- field directory_save: Literal[True] | None = None
Preserve the work directory after function evaluation completion
- field directory_tag: Literal[True] | None = None
Tag each work directory with the function evaluation number
- field link_files: list[str] | None = None
Paths to be linked into each working directory
- field named: str | None = None
The base name of the work directory created by Dakota
- field replace: Literal[True] | None = None
Overwrite existing files within a work directory
