Environment

pydantic model dakota.spec.environment.EnvironmentConfig

Top-level settings for Dakota execution

Show JSON schema
{
   "title": "EnvironmentConfig",
   "description": "Top-level settings for Dakota execution",
   "type": "object",
   "properties": {
      "tabular_data": {
         "anyOf": [
            {
               "$ref": "#/$defs/TabularData"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Write a tabular results file with variable and response history",
         "x-aliases": [
            "tabular_graphics_data"
         ],
         "x-materialization": [
            {
               "ir_key": "environment.tabular_graphics_data",
               "ir_value_type": "bool",
               "storage_type": "PRESENCE_TRUE"
            }
         ]
      },
      "output_file": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Base filename for output redirection",
         "title": "Output File",
         "x-materialization": [
            {
               "ir_key": "environment.output_file",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "error_file": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Base filename for error redirection",
         "title": "Error File",
         "x-materialization": [
            {
               "ir_key": "environment.error_file",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "read_restart": {
         "anyOf": [
            {
               "$ref": "#/$defs/ReadRestart"
            },
            {
               "type": "null"
            }
         ],
         "argument": "filename",
         "default": null,
         "description": "Base filename for restart file read"
      },
      "write_restart": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Base filename for restart file write",
         "title": "Write Restart",
         "x-materialization": [
            {
               "ir_key": "environment.write_restart",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "output_precision": {
         "default": 0,
         "description": "Control the output precision",
         "minimum": 0,
         "title": "Output Precision",
         "type": "integer",
         "x-materialization": [
            {
               "ir_key": "environment.output_precision",
               "ir_value_type": "int",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "results_output": {
         "anyOf": [
            {
               "$ref": "#/$defs/ResultsOutput"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "(Experimental) Write a summary file containing the final results",
         "x-materialization": [
            {
               "ir_key": "environment.results_output",
               "ir_value_type": "bool",
               "storage_type": "PRESENCE_TRUE"
            }
         ]
      },
      "graphics": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "(DEPRECATED) Display plots of variables and responses",
         "title": "Graphics",
         "x-materialization": [
            {
               "ir_key": "environment.graphics",
               "ir_value_type": "bool",
               "storage_type": "PRESENCE_TRUE"
            }
         ]
      },
      "check": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Invoke Dakota in input check mode",
         "title": "Check",
         "x-materialization": [
            {
               "ir_key": "environment.check",
               "ir_value_type": "bool",
               "storage_type": "PRESENCE_TRUE"
            }
         ]
      },
      "pre_run": {
         "anyOf": [
            {
               "$ref": "#/$defs/PreRun"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Invoke Dakota with pre-run mode active",
         "x-materialization": [
            {
               "ir_key": "environment.pre_run",
               "ir_value_type": "bool",
               "storage_type": "PRESENCE_TRUE"
            }
         ]
      },
      "run": {
         "anyOf": [
            {
               "$ref": "#/$defs/Run"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Invoke Dakota with run mode active",
         "x-materialization": [
            {
               "ir_key": "environment.run",
               "ir_value_type": "bool",
               "storage_type": "PRESENCE_TRUE"
            }
         ]
      },
      "post_run": {
         "anyOf": [
            {
               "$ref": "#/$defs/PostRun"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Invoke Dakota with post-run mode active",
         "x-materialization": [
            {
               "ir_key": "environment.post_run",
               "ir_value_type": "bool",
               "storage_type": "PRESENCE_TRUE"
            }
         ]
      },
      "top_method_pointer": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Identify which method leads the Dakota study",
         "title": "Top Method Pointer",
         "x-aliases": [
            "method_pointer"
         ],
         "x-block-pointer": "method",
         "x-materialization": [
            {
               "ir_key": "environment.top_method_pointer",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      }
   },
   "$defs": {
      "AllMethods": {
         "additionalProperties": false,
         "description": "Write evaluation data to HDF5 for all models that belong directly to methods",
         "properties": {
            "all_methods": {
               "const": true,
               "default": true,
               "description": "Write evaluation data to HDF5 for all models that belong directly to methods",
               "title": "All Methods",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.model_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "MODEL_EVAL_STORE_ALL_METHODS"
                  }
               ]
            }
         },
         "title": "AllMethods",
         "type": "object"
      },
      "Hdf5": {
         "additionalProperties": false,
         "description": "Write results to file in HDF5 format",
         "properties": {
            "model_selection": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/TopMethod"
                  },
                  {
                     "$ref": "#/$defs/ModelSelectionNone"
                  },
                  {
                     "$ref": "#/$defs/AllMethods"
                  },
                  {
                     "$ref": "#/$defs/ModelSelectionAll"
                  }
               ],
               "description": "Select the models that write evaluation data to HDF5",
               "title": "Model Selection",
               "x-model-default": "TopMethod",
               "x-union-pattern": 1
            },
            "interface_selection": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/InterfaceSelectionNone"
                  },
                  {
                     "$ref": "#/$defs/Simulation"
                  },
                  {
                     "$ref": "#/$defs/InterfaceSelectionAll"
                  }
               ],
               "description": "Select the models that write evaluation data to HDF5",
               "title": "Interface Selection",
               "x-model-default": "Simulation",
               "x-union-pattern": 1
            }
         },
         "title": "Hdf5",
         "type": "object"
      },
      "Input": {
         "additionalProperties": false,
         "description": "Base filename for post-run mode data input",
         "properties": {
            "filename": {
               "description": "Base filename for post-run mode data input",
               "title": "Filename",
               "type": "string",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "format": {
               "anchor": true,
               "anyOf": [
                  {
                     "$ref": "#/$defs/InputCustomAnnotated"
                  },
                  {
                     "$ref": "#/$defs/InputAnnotated"
                  },
                  {
                     "$ref": "#/$defs/InputFreeform"
                  }
               ],
               "description": "Tabular Format",
               "title": "Format",
               "x-model-default": "InputAnnotated",
               "x-union-pattern": 1
            }
         },
         "required": [
            "filename"
         ],
         "title": "Input",
         "type": "object"
      },
      "InputAnnotated": {
         "additionalProperties": false,
         "description": "Selects annotated tabular file format",
         "properties": {
            "annotated": {
               "const": true,
               "default": true,
               "description": "Selects annotated tabular file format",
               "title": "Annotated",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_ANNOTATED"
                  }
               ]
            }
         },
         "title": "InputAnnotated",
         "type": "object"
      },
      "InputCustomAnnotated": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "custom_annotated": {
               "$ref": "#/$defs/InputCustomAnnotatedConfig",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ],
               "x-model-default": "InputCustomAnnotatedConfig"
            }
         },
         "title": "InputCustomAnnotated",
         "type": "object"
      },
      "InputCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "InputCustomAnnotatedConfig",
         "type": "object"
      },
      "InputFreeform": {
         "additionalProperties": false,
         "description": "Selects freeform file format",
         "properties": {
            "freeform": {
               "const": true,
               "default": true,
               "description": "Selects freeform file format",
               "title": "Freeform",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ]
            }
         },
         "title": "InputFreeform",
         "type": "object"
      },
      "InterfaceSelectionAll": {
         "additionalProperties": false,
         "description": "Write evaluation data for all interfaces to HDF5",
         "properties": {
            "all": {
               "const": true,
               "default": true,
               "description": "Write evaluation data for all interfaces to HDF5",
               "title": "All",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.interface_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "INTERF_EVAL_STORE_ALL"
                  }
               ]
            }
         },
         "title": "InterfaceSelectionAll",
         "type": "object"
      },
      "InterfaceSelectionNone": {
         "additionalProperties": false,
         "description": "Write evaluation data for no interfaces to HDF5",
         "properties": {
            "none": {
               "const": true,
               "default": true,
               "description": "Write evaluation data for no interfaces to HDF5",
               "title": "None",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.interface_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "INTERF_EVAL_STORE_NONE"
                  }
               ]
            }
         },
         "title": "InterfaceSelectionNone",
         "type": "object"
      },
      "ModelSelectionAll": {
         "additionalProperties": false,
         "description": "Write evaluation data to HDF5 for all models",
         "properties": {
            "all": {
               "const": true,
               "default": true,
               "description": "Write evaluation data to HDF5 for all models",
               "title": "All",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.model_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "MODEL_EVAL_STORE_ALL"
                  }
               ]
            }
         },
         "title": "ModelSelectionAll",
         "type": "object"
      },
      "ModelSelectionNone": {
         "additionalProperties": false,
         "description": "Write evaluation data for no models to HDF5",
         "properties": {
            "none": {
               "const": true,
               "default": true,
               "description": "Write evaluation data for no models to HDF5",
               "title": "None",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.model_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "MODEL_EVAL_STORE_NONE"
                  }
               ]
            }
         },
         "title": "ModelSelectionNone",
         "type": "object"
      },
      "Output": {
         "additionalProperties": false,
         "description": "Base filename for pre-run mode data output",
         "properties": {
            "filename": {
               "description": "Base filename for pre-run mode data output",
               "title": "Filename",
               "type": "string",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "format": {
               "anchor": true,
               "anyOf": [
                  {
                     "$ref": "#/$defs/OutputCustomAnnotated"
                  },
                  {
                     "$ref": "#/$defs/OutputAnnotated"
                  },
                  {
                     "$ref": "#/$defs/OutputFreeform"
                  }
               ],
               "description": "Tabular Format",
               "title": "Format",
               "x-model-default": "OutputAnnotated",
               "x-union-pattern": 1
            }
         },
         "required": [
            "filename"
         ],
         "title": "Output",
         "type": "object"
      },
      "OutputAnnotated": {
         "additionalProperties": false,
         "description": "Selects annotated tabular file format",
         "properties": {
            "annotated": {
               "const": true,
               "default": true,
               "description": "Selects annotated tabular file format",
               "title": "Annotated",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_ANNOTATED"
                  }
               ]
            }
         },
         "title": "OutputAnnotated",
         "type": "object"
      },
      "OutputCustomAnnotated": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "custom_annotated": {
               "$ref": "#/$defs/OutputCustomAnnotatedConfig",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ],
               "x-model-default": "OutputCustomAnnotatedConfig"
            }
         },
         "title": "OutputCustomAnnotated",
         "type": "object"
      },
      "OutputCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "OutputCustomAnnotatedConfig",
         "type": "object"
      },
      "OutputFreeform": {
         "additionalProperties": false,
         "description": "Selects freeform file format",
         "properties": {
            "freeform": {
               "const": true,
               "default": true,
               "description": "Selects freeform file format",
               "title": "Freeform",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ]
            }
         },
         "title": "OutputFreeform",
         "type": "object"
      },
      "PostRun": {
         "additionalProperties": false,
         "description": "Invoke Dakota with post-run mode active",
         "properties": {
            "input": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Input"
                  },
                  {
                     "type": "null"
                  }
               ],
               "argument": "filename",
               "default": null,
               "description": "Base filename for post-run mode data input"
            },
            "output": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Base filename for post-run mode data output",
               "title": "Output",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_output",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            }
         },
         "title": "PostRun",
         "type": "object"
      },
      "PreRun": {
         "additionalProperties": false,
         "description": "Invoke Dakota with pre-run mode active",
         "properties": {
            "input": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Base filename for pre-run mode data input",
               "title": "Input",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_input",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "output": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Output"
                  },
                  {
                     "type": "null"
                  }
               ],
               "argument": "filename",
               "default": null,
               "description": "Base filename for pre-run mode data output"
            }
         },
         "title": "PreRun",
         "type": "object"
      },
      "ReadRestart": {
         "additionalProperties": false,
         "description": "Base filename for restart file read",
         "properties": {
            "filename": {
               "description": "Base filename for restart file read",
               "title": "Filename",
               "type": "string",
               "x-materialization": [
                  {
                     "ir_key": "environment.read_restart",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "stop_restart": {
               "anyOf": [
                  {
                     "minimum": 0,
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Restart record number at which to stop reading the restart file.",
               "title": "Stop Restart",
               "x-materialization": [
                  {
                     "ir_key": "environment.stop_restart",
                     "ir_value_type": "int",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            }
         },
         "required": [
            "filename"
         ],
         "title": "ReadRestart",
         "type": "object"
      },
      "ResultsOutput": {
         "additionalProperties": false,
         "description": "(Experimental) Write a summary file containing the final results",
         "properties": {
            "results_output_file": {
               "default": "dakota_results",
               "description": "The base file name of the results file",
               "title": "Results Output File",
               "type": "string",
               "x-materialization": [
                  {
                     "ir_key": "environment.results_output_file",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "text": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Write results to file in text format",
               "title": "Text",
               "x-materialization": [
                  {
                     "ir_key": "environment.results_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "RESULTS_OUTPUT_TEXT"
                  }
               ]
            },
            "hdf5": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/Hdf5"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Write results to file in HDF5 format",
               "x-materialization": [
                  {
                     "ir_key": "environment.results_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "RESULTS_OUTPUT_HDF5"
                  }
               ]
            }
         },
         "title": "ResultsOutput",
         "type": "object"
      },
      "Run": {
         "additionalProperties": false,
         "description": "Invoke Dakota with run mode active",
         "properties": {
            "input": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Base filename for run mode data input",
               "title": "Input",
               "x-materialization": [
                  {
                     "ir_key": "environment.run_input",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "output": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Base filename for run mode data output",
               "title": "Output",
               "x-materialization": [
                  {
                     "ir_key": "environment.run_output",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            }
         },
         "title": "Run",
         "type": "object"
      },
      "Simulation": {
         "additionalProperties": false,
         "description": "Write evaluation data only for simulation interfaces to HDF5",
         "properties": {
            "simulation": {
               "const": true,
               "default": true,
               "description": "Write evaluation data only for simulation interfaces to HDF5",
               "title": "Simulation",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.interface_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "INTERF_EVAL_STORE_SIMULATION"
                  }
               ]
            }
         },
         "title": "Simulation",
         "type": "object"
      },
      "TabularData": {
         "additionalProperties": false,
         "description": "Write a tabular results file with variable and response history",
         "properties": {
            "tabular_data_file": {
               "default": "dakota_tabular.dat",
               "description": "File name for tabular data output",
               "title": "Tabular Data File",
               "type": "string",
               "x-aliases": [
                  "tabular_graphics_file"
               ],
               "x-materialization": [
                  {
                     "ir_key": "environment.tabular_graphics_file",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "format": {
               "anchor": true,
               "anyOf": [
                  {
                     "$ref": "#/$defs/TabularDataCustomAnnotated"
                  },
                  {
                     "$ref": "#/$defs/TabularDataAnnotated"
                  },
                  {
                     "$ref": "#/$defs/TabularDataFreeform"
                  }
               ],
               "description": "Tabular Data Format",
               "title": "Format",
               "x-model-default": "TabularDataAnnotated",
               "x-union-pattern": 1
            }
         },
         "title": "TabularData",
         "type": "object"
      },
      "TabularDataAnnotated": {
         "additionalProperties": false,
         "description": "Selects annotated tabular file format",
         "properties": {
            "annotated": {
               "const": true,
               "default": true,
               "description": "Selects annotated tabular file format",
               "title": "Annotated",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.tabular_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_ANNOTATED"
                  }
               ]
            }
         },
         "title": "TabularDataAnnotated",
         "type": "object"
      },
      "TabularDataCustomAnnotated": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "custom_annotated": {
               "$ref": "#/$defs/TabularDataCustomAnnotatedConfig",
               "x-materialization": [
                  {
                     "ir_key": "environment.tabular_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ],
               "x-model-default": "TabularDataCustomAnnotatedConfig"
            }
         },
         "title": "TabularDataCustomAnnotated",
         "type": "object"
      },
      "TabularDataCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "environment.tabular_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.tabular_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.tabular_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "TabularDataCustomAnnotatedConfig",
         "type": "object"
      },
      "TabularDataFreeform": {
         "additionalProperties": false,
         "description": "Selects freeform file format",
         "properties": {
            "freeform": {
               "const": true,
               "default": true,
               "description": "Selects freeform file format",
               "title": "Freeform",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.tabular_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ]
            }
         },
         "title": "TabularDataFreeform",
         "type": "object"
      },
      "TopMethod": {
         "additionalProperties": false,
         "description": "Write evaluation data only for the top-level method's model to HDF5",
         "properties": {
            "top_method": {
               "const": true,
               "default": true,
               "description": "Write evaluation data only for the top-level method's model to HDF5",
               "title": "Top Method",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.model_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "MODEL_EVAL_STORE_TOP_METHOD"
                  }
               ]
            }
         },
         "title": "TopMethod",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:
field check: Literal[True] | None = None

Invoke Dakota in input check mode

field error_file: str | None = None

Base filename for error redirection

field graphics: Literal[True] | None = None

(DEPRECATED) Display plots of variables and responses

field output_file: str | None = None

Base filename for output redirection

field output_precision: int = 0

Control the output precision

Constraints:
  • ge = 0

field post_run: PostRun | None = None

Invoke Dakota with post-run mode active

field pre_run: PreRun | None = None

Invoke Dakota with pre-run mode active

field read_restart: ReadRestart | None = None

Base filename for restart file read

field results_output: ResultsOutput | None = None

(Experimental) Write a summary file containing the final results

field run: Run | None = None

Invoke Dakota with run mode active

field tabular_data: TabularData | None = None

Write a tabular results file with variable and response history

field top_method_pointer: str | None = None

Identify which method leads the Dakota study

field write_restart: str | None = None

Base filename for restart file write

Generated Pydantic models for environment

pydantic model dakota.spec.environment.AllMethods

Write evaluation data to HDF5 for all models that belong directly to methods

Show JSON schema
{
   "title": "AllMethods",
   "description": "Write evaluation data to HDF5 for all models that belong directly to methods",
   "type": "object",
   "properties": {
      "all_methods": {
         "const": true,
         "default": true,
         "description": "Write evaluation data to HDF5 for all models that belong directly to methods",
         "title": "All Methods",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "environment.model_evals_selection",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "MODEL_EVAL_STORE_ALL_METHODS"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:
field all_methods: Literal[True] = True

Write evaluation data to HDF5 for all models that belong directly to methods

pydantic model dakota.spec.environment.Hdf5

Write results to file in HDF5 format

Show JSON schema
{
   "title": "Hdf5",
   "description": "Write results to file in HDF5 format",
   "type": "object",
   "properties": {
      "model_selection": {
         "anyOf": [
            {
               "$ref": "#/$defs/TopMethod"
            },
            {
               "$ref": "#/$defs/ModelSelectionNone"
            },
            {
               "$ref": "#/$defs/AllMethods"
            },
            {
               "$ref": "#/$defs/ModelSelectionAll"
            }
         ],
         "description": "Select the models that write evaluation data to HDF5",
         "title": "Model Selection",
         "x-model-default": "TopMethod",
         "x-union-pattern": 1
      },
      "interface_selection": {
         "anyOf": [
            {
               "$ref": "#/$defs/InterfaceSelectionNone"
            },
            {
               "$ref": "#/$defs/Simulation"
            },
            {
               "$ref": "#/$defs/InterfaceSelectionAll"
            }
         ],
         "description": "Select the models that write evaluation data to HDF5",
         "title": "Interface Selection",
         "x-model-default": "Simulation",
         "x-union-pattern": 1
      }
   },
   "$defs": {
      "AllMethods": {
         "additionalProperties": false,
         "description": "Write evaluation data to HDF5 for all models that belong directly to methods",
         "properties": {
            "all_methods": {
               "const": true,
               "default": true,
               "description": "Write evaluation data to HDF5 for all models that belong directly to methods",
               "title": "All Methods",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.model_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "MODEL_EVAL_STORE_ALL_METHODS"
                  }
               ]
            }
         },
         "title": "AllMethods",
         "type": "object"
      },
      "InterfaceSelectionAll": {
         "additionalProperties": false,
         "description": "Write evaluation data for all interfaces to HDF5",
         "properties": {
            "all": {
               "const": true,
               "default": true,
               "description": "Write evaluation data for all interfaces to HDF5",
               "title": "All",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.interface_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "INTERF_EVAL_STORE_ALL"
                  }
               ]
            }
         },
         "title": "InterfaceSelectionAll",
         "type": "object"
      },
      "InterfaceSelectionNone": {
         "additionalProperties": false,
         "description": "Write evaluation data for no interfaces to HDF5",
         "properties": {
            "none": {
               "const": true,
               "default": true,
               "description": "Write evaluation data for no interfaces to HDF5",
               "title": "None",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.interface_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "INTERF_EVAL_STORE_NONE"
                  }
               ]
            }
         },
         "title": "InterfaceSelectionNone",
         "type": "object"
      },
      "ModelSelectionAll": {
         "additionalProperties": false,
         "description": "Write evaluation data to HDF5 for all models",
         "properties": {
            "all": {
               "const": true,
               "default": true,
               "description": "Write evaluation data to HDF5 for all models",
               "title": "All",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.model_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "MODEL_EVAL_STORE_ALL"
                  }
               ]
            }
         },
         "title": "ModelSelectionAll",
         "type": "object"
      },
      "ModelSelectionNone": {
         "additionalProperties": false,
         "description": "Write evaluation data for no models to HDF5",
         "properties": {
            "none": {
               "const": true,
               "default": true,
               "description": "Write evaluation data for no models to HDF5",
               "title": "None",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.model_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "MODEL_EVAL_STORE_NONE"
                  }
               ]
            }
         },
         "title": "ModelSelectionNone",
         "type": "object"
      },
      "Simulation": {
         "additionalProperties": false,
         "description": "Write evaluation data only for simulation interfaces to HDF5",
         "properties": {
            "simulation": {
               "const": true,
               "default": true,
               "description": "Write evaluation data only for simulation interfaces to HDF5",
               "title": "Simulation",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.interface_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "INTERF_EVAL_STORE_SIMULATION"
                  }
               ]
            }
         },
         "title": "Simulation",
         "type": "object"
      },
      "TopMethod": {
         "additionalProperties": false,
         "description": "Write evaluation data only for the top-level method's model to HDF5",
         "properties": {
            "top_method": {
               "const": true,
               "default": true,
               "description": "Write evaluation data only for the top-level method's model to HDF5",
               "title": "Top Method",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.model_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "MODEL_EVAL_STORE_TOP_METHOD"
                  }
               ]
            }
         },
         "title": "TopMethod",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:
field interface_selection: InterfaceSelectionNone | Simulation | InterfaceSelectionAll [Optional]

Select the models that write evaluation data to HDF5

field model_selection: TopMethod | ModelSelectionNone | AllMethods | ModelSelectionAll [Optional]

Select the models that write evaluation data to HDF5

pydantic model dakota.spec.environment.Input

Base filename for post-run mode data input

Show JSON schema
{
   "title": "Input",
   "description": "Base filename for post-run mode data input",
   "type": "object",
   "properties": {
      "filename": {
         "description": "Base filename for post-run mode data input",
         "title": "Filename",
         "type": "string",
         "x-materialization": [
            {
               "ir_key": "environment.post_run_input",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "format": {
         "anchor": true,
         "anyOf": [
            {
               "$ref": "#/$defs/InputCustomAnnotated"
            },
            {
               "$ref": "#/$defs/InputAnnotated"
            },
            {
               "$ref": "#/$defs/InputFreeform"
            }
         ],
         "description": "Tabular Format",
         "title": "Format",
         "x-model-default": "InputAnnotated",
         "x-union-pattern": 1
      }
   },
   "$defs": {
      "InputAnnotated": {
         "additionalProperties": false,
         "description": "Selects annotated tabular file format",
         "properties": {
            "annotated": {
               "const": true,
               "default": true,
               "description": "Selects annotated tabular file format",
               "title": "Annotated",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_ANNOTATED"
                  }
               ]
            }
         },
         "title": "InputAnnotated",
         "type": "object"
      },
      "InputCustomAnnotated": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "custom_annotated": {
               "$ref": "#/$defs/InputCustomAnnotatedConfig",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ],
               "x-model-default": "InputCustomAnnotatedConfig"
            }
         },
         "title": "InputCustomAnnotated",
         "type": "object"
      },
      "InputCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "InputCustomAnnotatedConfig",
         "type": "object"
      },
      "InputFreeform": {
         "additionalProperties": false,
         "description": "Selects freeform file format",
         "properties": {
            "freeform": {
               "const": true,
               "default": true,
               "description": "Selects freeform file format",
               "title": "Freeform",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ]
            }
         },
         "title": "InputFreeform",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "filename"
   ]
}

Fields:
field filename: str [Required]

Base filename for post-run mode data input

field format: InputCustomAnnotated | InputAnnotated | InputFreeform [Optional]

Tabular Format

pydantic model dakota.spec.environment.InputAnnotated

Selects annotated tabular file format

Show JSON schema
{
   "title": "InputAnnotated",
   "description": "Selects annotated tabular file format",
   "type": "object",
   "properties": {
      "annotated": {
         "const": true,
         "default": true,
         "description": "Selects annotated tabular file format",
         "title": "Annotated",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "environment.post_run_input_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_ANNOTATED"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:
field annotated: Literal[True] = True

Selects annotated tabular file format

pydantic model dakota.spec.environment.InputCustomAnnotated

Selects custom-annotated tabular file format

Show JSON schema
{
   "title": "InputCustomAnnotated",
   "description": "Selects custom-annotated tabular file format",
   "type": "object",
   "properties": {
      "custom_annotated": {
         "$ref": "#/$defs/InputCustomAnnotatedConfig",
         "x-materialization": [
            {
               "ir_key": "environment.post_run_input_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_NONE"
            }
         ],
         "x-model-default": "InputCustomAnnotatedConfig"
      }
   },
   "$defs": {
      "InputCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "InputCustomAnnotatedConfig",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:
field custom_annotated: InputCustomAnnotatedConfig [Optional]

Selects custom-annotated tabular file format

pydantic model dakota.spec.environment.InputCustomAnnotatedConfig

Selects custom-annotated tabular file format

Show JSON schema
{
   "title": "InputCustomAnnotatedConfig",
   "description": "Selects custom-annotated tabular file format",
   "type": "object",
   "properties": {
      "header": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable header row in custom-annotated tabular file",
         "title": "Header",
         "x-materialization": [
            {
               "ir_key": "environment.post_run_input_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_HEADER"
            }
         ]
      },
      "eval_id": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable evaluation ID column in custom-annotated tabular file",
         "title": "Eval Id",
         "x-materialization": [
            {
               "ir_key": "environment.post_run_input_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_EVAL_ID"
            }
         ]
      },
      "interface_id": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable interface ID column in custom-annotated tabular file",
         "title": "Interface Id",
         "x-materialization": [
            {
               "ir_key": "environment.post_run_input_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_IFACE_ID"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:
field eval_id: Literal[True] | None = None

Enable evaluation ID column in custom-annotated tabular file

field header: Literal[True] | None = None

Enable header row in custom-annotated tabular file

field interface_id: Literal[True] | None = None

Enable interface ID column in custom-annotated tabular file

pydantic model dakota.spec.environment.InputFreeform

Selects freeform file format

Show JSON schema
{
   "title": "InputFreeform",
   "description": "Selects freeform file format",
   "type": "object",
   "properties": {
      "freeform": {
         "const": true,
         "default": true,
         "description": "Selects freeform file format",
         "title": "Freeform",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "environment.post_run_input_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_NONE"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:
field freeform: Literal[True] = True

Selects freeform file format

pydantic model dakota.spec.environment.InterfaceSelectionAll

Write evaluation data for all interfaces to HDF5

Show JSON schema
{
   "title": "InterfaceSelectionAll",
   "description": "Write evaluation data for all interfaces to HDF5",
   "type": "object",
   "properties": {
      "all": {
         "const": true,
         "default": true,
         "description": "Write evaluation data for all interfaces to HDF5",
         "title": "All",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "environment.interface_evals_selection",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "INTERF_EVAL_STORE_ALL"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:
field all: Literal[True] = True

Write evaluation data for all interfaces to HDF5

pydantic model dakota.spec.environment.InterfaceSelectionNone

Write evaluation data for no interfaces to HDF5

Show JSON schema
{
   "title": "InterfaceSelectionNone",
   "description": "Write evaluation data for no interfaces to HDF5",
   "type": "object",
   "properties": {
      "none": {
         "const": true,
         "default": true,
         "description": "Write evaluation data for no interfaces to HDF5",
         "title": "None",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "environment.interface_evals_selection",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "INTERF_EVAL_STORE_NONE"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:
field none: Literal[True] = True

Write evaluation data for no interfaces to HDF5

pydantic model dakota.spec.environment.ModelSelectionAll

Write evaluation data to HDF5 for all models

Show JSON schema
{
   "title": "ModelSelectionAll",
   "description": "Write evaluation data to HDF5 for all models",
   "type": "object",
   "properties": {
      "all": {
         "const": true,
         "default": true,
         "description": "Write evaluation data to HDF5 for all models",
         "title": "All",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "environment.model_evals_selection",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "MODEL_EVAL_STORE_ALL"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:
field all: Literal[True] = True

Write evaluation data to HDF5 for all models

pydantic model dakota.spec.environment.ModelSelectionNone

Write evaluation data for no models to HDF5

Show JSON schema
{
   "title": "ModelSelectionNone",
   "description": "Write evaluation data for no models to HDF5",
   "type": "object",
   "properties": {
      "none": {
         "const": true,
         "default": true,
         "description": "Write evaluation data for no models to HDF5",
         "title": "None",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "environment.model_evals_selection",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "MODEL_EVAL_STORE_NONE"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:
field none: Literal[True] = True

Write evaluation data for no models to HDF5

pydantic model dakota.spec.environment.Output

Base filename for pre-run mode data output

Show JSON schema
{
   "title": "Output",
   "description": "Base filename for pre-run mode data output",
   "type": "object",
   "properties": {
      "filename": {
         "description": "Base filename for pre-run mode data output",
         "title": "Filename",
         "type": "string",
         "x-materialization": [
            {
               "ir_key": "environment.pre_run_output",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "format": {
         "anchor": true,
         "anyOf": [
            {
               "$ref": "#/$defs/OutputCustomAnnotated"
            },
            {
               "$ref": "#/$defs/OutputAnnotated"
            },
            {
               "$ref": "#/$defs/OutputFreeform"
            }
         ],
         "description": "Tabular Format",
         "title": "Format",
         "x-model-default": "OutputAnnotated",
         "x-union-pattern": 1
      }
   },
   "$defs": {
      "OutputAnnotated": {
         "additionalProperties": false,
         "description": "Selects annotated tabular file format",
         "properties": {
            "annotated": {
               "const": true,
               "default": true,
               "description": "Selects annotated tabular file format",
               "title": "Annotated",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_ANNOTATED"
                  }
               ]
            }
         },
         "title": "OutputAnnotated",
         "type": "object"
      },
      "OutputCustomAnnotated": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "custom_annotated": {
               "$ref": "#/$defs/OutputCustomAnnotatedConfig",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ],
               "x-model-default": "OutputCustomAnnotatedConfig"
            }
         },
         "title": "OutputCustomAnnotated",
         "type": "object"
      },
      "OutputCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "OutputCustomAnnotatedConfig",
         "type": "object"
      },
      "OutputFreeform": {
         "additionalProperties": false,
         "description": "Selects freeform file format",
         "properties": {
            "freeform": {
               "const": true,
               "default": true,
               "description": "Selects freeform file format",
               "title": "Freeform",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ]
            }
         },
         "title": "OutputFreeform",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "filename"
   ]
}

Fields:
field filename: str [Required]

Base filename for pre-run mode data output

field format: OutputCustomAnnotated | OutputAnnotated | OutputFreeform [Optional]

Tabular Format

pydantic model dakota.spec.environment.OutputAnnotated

Selects annotated tabular file format

Show JSON schema
{
   "title": "OutputAnnotated",
   "description": "Selects annotated tabular file format",
   "type": "object",
   "properties": {
      "annotated": {
         "const": true,
         "default": true,
         "description": "Selects annotated tabular file format",
         "title": "Annotated",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "environment.pre_run_output_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_ANNOTATED"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:
field annotated: Literal[True] = True

Selects annotated tabular file format

pydantic model dakota.spec.environment.OutputCustomAnnotated

Selects custom-annotated tabular file format

Show JSON schema
{
   "title": "OutputCustomAnnotated",
   "description": "Selects custom-annotated tabular file format",
   "type": "object",
   "properties": {
      "custom_annotated": {
         "$ref": "#/$defs/OutputCustomAnnotatedConfig",
         "x-materialization": [
            {
               "ir_key": "environment.pre_run_output_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_NONE"
            }
         ],
         "x-model-default": "OutputCustomAnnotatedConfig"
      }
   },
   "$defs": {
      "OutputCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "OutputCustomAnnotatedConfig",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:
field custom_annotated: OutputCustomAnnotatedConfig [Optional]

Selects custom-annotated tabular file format

pydantic model dakota.spec.environment.OutputCustomAnnotatedConfig

Selects custom-annotated tabular file format

Show JSON schema
{
   "title": "OutputCustomAnnotatedConfig",
   "description": "Selects custom-annotated tabular file format",
   "type": "object",
   "properties": {
      "header": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable header row in custom-annotated tabular file",
         "title": "Header",
         "x-materialization": [
            {
               "ir_key": "environment.pre_run_output_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_HEADER"
            }
         ]
      },
      "eval_id": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable evaluation ID column in custom-annotated tabular file",
         "title": "Eval Id",
         "x-materialization": [
            {
               "ir_key": "environment.pre_run_output_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_EVAL_ID"
            }
         ]
      },
      "interface_id": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable interface ID column in custom-annotated tabular file",
         "title": "Interface Id",
         "x-materialization": [
            {
               "ir_key": "environment.pre_run_output_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_IFACE_ID"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:
field eval_id: Literal[True] | None = None

Enable evaluation ID column in custom-annotated tabular file

field header: Literal[True] | None = None

Enable header row in custom-annotated tabular file

field interface_id: Literal[True] | None = None

Enable interface ID column in custom-annotated tabular file

pydantic model dakota.spec.environment.OutputFreeform

Selects freeform file format

Show JSON schema
{
   "title": "OutputFreeform",
   "description": "Selects freeform file format",
   "type": "object",
   "properties": {
      "freeform": {
         "const": true,
         "default": true,
         "description": "Selects freeform file format",
         "title": "Freeform",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "environment.pre_run_output_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_NONE"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:
field freeform: Literal[True] = True

Selects freeform file format

pydantic model dakota.spec.environment.PostRun

Invoke Dakota with post-run mode active

Show JSON schema
{
   "title": "PostRun",
   "description": "Invoke Dakota with post-run mode active",
   "type": "object",
   "properties": {
      "input": {
         "anyOf": [
            {
               "$ref": "#/$defs/Input"
            },
            {
               "type": "null"
            }
         ],
         "argument": "filename",
         "default": null,
         "description": "Base filename for post-run mode data input"
      },
      "output": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Base filename for post-run mode data output",
         "title": "Output",
         "x-materialization": [
            {
               "ir_key": "environment.post_run_output",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      }
   },
   "$defs": {
      "Input": {
         "additionalProperties": false,
         "description": "Base filename for post-run mode data input",
         "properties": {
            "filename": {
               "description": "Base filename for post-run mode data input",
               "title": "Filename",
               "type": "string",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "format": {
               "anchor": true,
               "anyOf": [
                  {
                     "$ref": "#/$defs/InputCustomAnnotated"
                  },
                  {
                     "$ref": "#/$defs/InputAnnotated"
                  },
                  {
                     "$ref": "#/$defs/InputFreeform"
                  }
               ],
               "description": "Tabular Format",
               "title": "Format",
               "x-model-default": "InputAnnotated",
               "x-union-pattern": 1
            }
         },
         "required": [
            "filename"
         ],
         "title": "Input",
         "type": "object"
      },
      "InputAnnotated": {
         "additionalProperties": false,
         "description": "Selects annotated tabular file format",
         "properties": {
            "annotated": {
               "const": true,
               "default": true,
               "description": "Selects annotated tabular file format",
               "title": "Annotated",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_ANNOTATED"
                  }
               ]
            }
         },
         "title": "InputAnnotated",
         "type": "object"
      },
      "InputCustomAnnotated": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "custom_annotated": {
               "$ref": "#/$defs/InputCustomAnnotatedConfig",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ],
               "x-model-default": "InputCustomAnnotatedConfig"
            }
         },
         "title": "InputCustomAnnotated",
         "type": "object"
      },
      "InputCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "InputCustomAnnotatedConfig",
         "type": "object"
      },
      "InputFreeform": {
         "additionalProperties": false,
         "description": "Selects freeform file format",
         "properties": {
            "freeform": {
               "const": true,
               "default": true,
               "description": "Selects freeform file format",
               "title": "Freeform",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.post_run_input_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ]
            }
         },
         "title": "InputFreeform",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:
field input: Input | None = None

Base filename for post-run mode data input

field output: str | None = None

Base filename for post-run mode data output

pydantic model dakota.spec.environment.PreRun

Invoke Dakota with pre-run mode active

Show JSON schema
{
   "title": "PreRun",
   "description": "Invoke Dakota with pre-run mode active",
   "type": "object",
   "properties": {
      "input": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Base filename for pre-run mode data input",
         "title": "Input",
         "x-materialization": [
            {
               "ir_key": "environment.pre_run_input",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "output": {
         "anyOf": [
            {
               "$ref": "#/$defs/Output"
            },
            {
               "type": "null"
            }
         ],
         "argument": "filename",
         "default": null,
         "description": "Base filename for pre-run mode data output"
      }
   },
   "$defs": {
      "Output": {
         "additionalProperties": false,
         "description": "Base filename for pre-run mode data output",
         "properties": {
            "filename": {
               "description": "Base filename for pre-run mode data output",
               "title": "Filename",
               "type": "string",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "format": {
               "anchor": true,
               "anyOf": [
                  {
                     "$ref": "#/$defs/OutputCustomAnnotated"
                  },
                  {
                     "$ref": "#/$defs/OutputAnnotated"
                  },
                  {
                     "$ref": "#/$defs/OutputFreeform"
                  }
               ],
               "description": "Tabular Format",
               "title": "Format",
               "x-model-default": "OutputAnnotated",
               "x-union-pattern": 1
            }
         },
         "required": [
            "filename"
         ],
         "title": "Output",
         "type": "object"
      },
      "OutputAnnotated": {
         "additionalProperties": false,
         "description": "Selects annotated tabular file format",
         "properties": {
            "annotated": {
               "const": true,
               "default": true,
               "description": "Selects annotated tabular file format",
               "title": "Annotated",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_ANNOTATED"
                  }
               ]
            }
         },
         "title": "OutputAnnotated",
         "type": "object"
      },
      "OutputCustomAnnotated": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "custom_annotated": {
               "$ref": "#/$defs/OutputCustomAnnotatedConfig",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ],
               "x-model-default": "OutputCustomAnnotatedConfig"
            }
         },
         "title": "OutputCustomAnnotated",
         "type": "object"
      },
      "OutputCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "OutputCustomAnnotatedConfig",
         "type": "object"
      },
      "OutputFreeform": {
         "additionalProperties": false,
         "description": "Selects freeform file format",
         "properties": {
            "freeform": {
               "const": true,
               "default": true,
               "description": "Selects freeform file format",
               "title": "Freeform",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.pre_run_output_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ]
            }
         },
         "title": "OutputFreeform",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:
field input: str | None = None

Base filename for pre-run mode data input

field output: Output | None = None

Base filename for pre-run mode data output

pydantic model dakota.spec.environment.ReadRestart

Base filename for restart file read

Show JSON schema
{
   "title": "ReadRestart",
   "description": "Base filename for restart file read",
   "type": "object",
   "properties": {
      "filename": {
         "description": "Base filename for restart file read",
         "title": "Filename",
         "type": "string",
         "x-materialization": [
            {
               "ir_key": "environment.read_restart",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "stop_restart": {
         "anyOf": [
            {
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Restart record number at which to stop reading the restart file.",
         "title": "Stop Restart",
         "x-materialization": [
            {
               "ir_key": "environment.stop_restart",
               "ir_value_type": "int",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      }
   },
   "additionalProperties": false,
   "required": [
      "filename"
   ]
}

Fields:
field filename: str [Required]

Base filename for restart file read

field stop_restart: int | None = None

Restart record number at which to stop reading the restart file.

Constraints:
  • ge = 0

pydantic model dakota.spec.environment.ResultsOutput

(Experimental) Write a summary file containing the final results

Show JSON schema
{
   "title": "ResultsOutput",
   "description": "(Experimental) Write a summary file containing the final results",
   "type": "object",
   "properties": {
      "results_output_file": {
         "default": "dakota_results",
         "description": "The base file name of the results file",
         "title": "Results Output File",
         "type": "string",
         "x-materialization": [
            {
               "ir_key": "environment.results_output_file",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "text": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Write results to file in text format",
         "title": "Text",
         "x-materialization": [
            {
               "ir_key": "environment.results_output_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "RESULTS_OUTPUT_TEXT"
            }
         ]
      },
      "hdf5": {
         "anyOf": [
            {
               "$ref": "#/$defs/Hdf5"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Write results to file in HDF5 format",
         "x-materialization": [
            {
               "ir_key": "environment.results_output_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "RESULTS_OUTPUT_HDF5"
            }
         ]
      }
   },
   "$defs": {
      "AllMethods": {
         "additionalProperties": false,
         "description": "Write evaluation data to HDF5 for all models that belong directly to methods",
         "properties": {
            "all_methods": {
               "const": true,
               "default": true,
               "description": "Write evaluation data to HDF5 for all models that belong directly to methods",
               "title": "All Methods",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.model_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "MODEL_EVAL_STORE_ALL_METHODS"
                  }
               ]
            }
         },
         "title": "AllMethods",
         "type": "object"
      },
      "Hdf5": {
         "additionalProperties": false,
         "description": "Write results to file in HDF5 format",
         "properties": {
            "model_selection": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/TopMethod"
                  },
                  {
                     "$ref": "#/$defs/ModelSelectionNone"
                  },
                  {
                     "$ref": "#/$defs/AllMethods"
                  },
                  {
                     "$ref": "#/$defs/ModelSelectionAll"
                  }
               ],
               "description": "Select the models that write evaluation data to HDF5",
               "title": "Model Selection",
               "x-model-default": "TopMethod",
               "x-union-pattern": 1
            },
            "interface_selection": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/InterfaceSelectionNone"
                  },
                  {
                     "$ref": "#/$defs/Simulation"
                  },
                  {
                     "$ref": "#/$defs/InterfaceSelectionAll"
                  }
               ],
               "description": "Select the models that write evaluation data to HDF5",
               "title": "Interface Selection",
               "x-model-default": "Simulation",
               "x-union-pattern": 1
            }
         },
         "title": "Hdf5",
         "type": "object"
      },
      "InterfaceSelectionAll": {
         "additionalProperties": false,
         "description": "Write evaluation data for all interfaces to HDF5",
         "properties": {
            "all": {
               "const": true,
               "default": true,
               "description": "Write evaluation data for all interfaces to HDF5",
               "title": "All",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.interface_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "INTERF_EVAL_STORE_ALL"
                  }
               ]
            }
         },
         "title": "InterfaceSelectionAll",
         "type": "object"
      },
      "InterfaceSelectionNone": {
         "additionalProperties": false,
         "description": "Write evaluation data for no interfaces to HDF5",
         "properties": {
            "none": {
               "const": true,
               "default": true,
               "description": "Write evaluation data for no interfaces to HDF5",
               "title": "None",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.interface_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "INTERF_EVAL_STORE_NONE"
                  }
               ]
            }
         },
         "title": "InterfaceSelectionNone",
         "type": "object"
      },
      "ModelSelectionAll": {
         "additionalProperties": false,
         "description": "Write evaluation data to HDF5 for all models",
         "properties": {
            "all": {
               "const": true,
               "default": true,
               "description": "Write evaluation data to HDF5 for all models",
               "title": "All",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.model_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "MODEL_EVAL_STORE_ALL"
                  }
               ]
            }
         },
         "title": "ModelSelectionAll",
         "type": "object"
      },
      "ModelSelectionNone": {
         "additionalProperties": false,
         "description": "Write evaluation data for no models to HDF5",
         "properties": {
            "none": {
               "const": true,
               "default": true,
               "description": "Write evaluation data for no models to HDF5",
               "title": "None",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.model_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "MODEL_EVAL_STORE_NONE"
                  }
               ]
            }
         },
         "title": "ModelSelectionNone",
         "type": "object"
      },
      "Simulation": {
         "additionalProperties": false,
         "description": "Write evaluation data only for simulation interfaces to HDF5",
         "properties": {
            "simulation": {
               "const": true,
               "default": true,
               "description": "Write evaluation data only for simulation interfaces to HDF5",
               "title": "Simulation",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.interface_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "INTERF_EVAL_STORE_SIMULATION"
                  }
               ]
            }
         },
         "title": "Simulation",
         "type": "object"
      },
      "TopMethod": {
         "additionalProperties": false,
         "description": "Write evaluation data only for the top-level method's model to HDF5",
         "properties": {
            "top_method": {
               "const": true,
               "default": true,
               "description": "Write evaluation data only for the top-level method's model to HDF5",
               "title": "Top Method",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.model_evals_selection",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "MODEL_EVAL_STORE_TOP_METHOD"
                  }
               ]
            }
         },
         "title": "TopMethod",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:
field hdf5: Hdf5 | None = None

Write results to file in HDF5 format

field results_output_file: str = 'dakota_results'

The base file name of the results file

field text: Literal[True] | None = None

Write results to file in text format

pydantic model dakota.spec.environment.Run

Invoke Dakota with run mode active

Show JSON schema
{
   "title": "Run",
   "description": "Invoke Dakota with run mode active",
   "type": "object",
   "properties": {
      "input": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Base filename for run mode data input",
         "title": "Input",
         "x-materialization": [
            {
               "ir_key": "environment.run_input",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "output": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Base filename for run mode data output",
         "title": "Output",
         "x-materialization": [
            {
               "ir_key": "environment.run_output",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:
field input: str | None = None

Base filename for run mode data input

field output: str | None = None

Base filename for run mode data output

pydantic model dakota.spec.environment.Simulation

Write evaluation data only for simulation interfaces to HDF5

Show JSON schema
{
   "title": "Simulation",
   "description": "Write evaluation data only for simulation interfaces to HDF5",
   "type": "object",
   "properties": {
      "simulation": {
         "const": true,
         "default": true,
         "description": "Write evaluation data only for simulation interfaces to HDF5",
         "title": "Simulation",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "environment.interface_evals_selection",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "INTERF_EVAL_STORE_SIMULATION"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:
field simulation: Literal[True] = True

Write evaluation data only for simulation interfaces to HDF5

pydantic model dakota.spec.environment.TabularData

Write a tabular results file with variable and response history

Show JSON schema
{
   "title": "TabularData",
   "description": "Write a tabular results file with variable and response history",
   "type": "object",
   "properties": {
      "tabular_data_file": {
         "default": "dakota_tabular.dat",
         "description": "File name for tabular data output",
         "title": "Tabular Data File",
         "type": "string",
         "x-aliases": [
            "tabular_graphics_file"
         ],
         "x-materialization": [
            {
               "ir_key": "environment.tabular_graphics_file",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "format": {
         "anchor": true,
         "anyOf": [
            {
               "$ref": "#/$defs/TabularDataCustomAnnotated"
            },
            {
               "$ref": "#/$defs/TabularDataAnnotated"
            },
            {
               "$ref": "#/$defs/TabularDataFreeform"
            }
         ],
         "description": "Tabular Data Format",
         "title": "Format",
         "x-model-default": "TabularDataAnnotated",
         "x-union-pattern": 1
      }
   },
   "$defs": {
      "TabularDataAnnotated": {
         "additionalProperties": false,
         "description": "Selects annotated tabular file format",
         "properties": {
            "annotated": {
               "const": true,
               "default": true,
               "description": "Selects annotated tabular file format",
               "title": "Annotated",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.tabular_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_ANNOTATED"
                  }
               ]
            }
         },
         "title": "TabularDataAnnotated",
         "type": "object"
      },
      "TabularDataCustomAnnotated": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "custom_annotated": {
               "$ref": "#/$defs/TabularDataCustomAnnotatedConfig",
               "x-materialization": [
                  {
                     "ir_key": "environment.tabular_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ],
               "x-model-default": "TabularDataCustomAnnotatedConfig"
            }
         },
         "title": "TabularDataCustomAnnotated",
         "type": "object"
      },
      "TabularDataCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "environment.tabular_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.tabular_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.tabular_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "TabularDataCustomAnnotatedConfig",
         "type": "object"
      },
      "TabularDataFreeform": {
         "additionalProperties": false,
         "description": "Selects freeform file format",
         "properties": {
            "freeform": {
               "const": true,
               "default": true,
               "description": "Selects freeform file format",
               "title": "Freeform",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "environment.tabular_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ]
            }
         },
         "title": "TabularDataFreeform",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:
field format: TabularDataCustomAnnotated | TabularDataAnnotated | TabularDataFreeform [Optional]

Tabular Data Format

field tabular_data_file: str = 'dakota_tabular.dat'

File name for tabular data output

pydantic model dakota.spec.environment.TabularDataAnnotated

Selects annotated tabular file format

Show JSON schema
{
   "title": "TabularDataAnnotated",
   "description": "Selects annotated tabular file format",
   "type": "object",
   "properties": {
      "annotated": {
         "const": true,
         "default": true,
         "description": "Selects annotated tabular file format",
         "title": "Annotated",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "environment.tabular_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_ANNOTATED"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:
field annotated: Literal[True] = True

Selects annotated tabular file format

pydantic model dakota.spec.environment.TabularDataCustomAnnotated

Selects custom-annotated tabular file format

Show JSON schema
{
   "title": "TabularDataCustomAnnotated",
   "description": "Selects custom-annotated tabular file format",
   "type": "object",
   "properties": {
      "custom_annotated": {
         "$ref": "#/$defs/TabularDataCustomAnnotatedConfig",
         "x-materialization": [
            {
               "ir_key": "environment.tabular_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_NONE"
            }
         ],
         "x-model-default": "TabularDataCustomAnnotatedConfig"
      }
   },
   "$defs": {
      "TabularDataCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "environment.tabular_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.tabular_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "environment.tabular_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "TabularDataCustomAnnotatedConfig",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:
field custom_annotated: TabularDataCustomAnnotatedConfig [Optional]

Selects custom-annotated tabular file format

pydantic model dakota.spec.environment.TabularDataCustomAnnotatedConfig

Selects custom-annotated tabular file format

Show JSON schema
{
   "title": "TabularDataCustomAnnotatedConfig",
   "description": "Selects custom-annotated tabular file format",
   "type": "object",
   "properties": {
      "header": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable header row in custom-annotated tabular file",
         "title": "Header",
         "x-materialization": [
            {
               "ir_key": "environment.tabular_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_HEADER"
            }
         ]
      },
      "eval_id": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable evaluation ID column in custom-annotated tabular file",
         "title": "Eval Id",
         "x-materialization": [
            {
               "ir_key": "environment.tabular_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_EVAL_ID"
            }
         ]
      },
      "interface_id": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable interface ID column in custom-annotated tabular file",
         "title": "Interface Id",
         "x-materialization": [
            {
               "ir_key": "environment.tabular_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_IFACE_ID"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:
field eval_id: Literal[True] | None = None

Enable evaluation ID column in custom-annotated tabular file

field header: Literal[True] | None = None

Enable header row in custom-annotated tabular file

field interface_id: Literal[True] | None = None

Enable interface ID column in custom-annotated tabular file

pydantic model dakota.spec.environment.TabularDataFreeform

Selects freeform file format

Show JSON schema
{
   "title": "TabularDataFreeform",
   "description": "Selects freeform file format",
   "type": "object",
   "properties": {
      "freeform": {
         "const": true,
         "default": true,
         "description": "Selects freeform file format",
         "title": "Freeform",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "environment.tabular_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_NONE"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:
field freeform: Literal[True] = True

Selects freeform file format

pydantic model dakota.spec.environment.TopMethod

Write evaluation data only for the top-level method’s model to HDF5

Show JSON schema
{
   "title": "TopMethod",
   "description": "Write evaluation data only for the top-level method's model to HDF5",
   "type": "object",
   "properties": {
      "top_method": {
         "const": true,
         "default": true,
         "description": "Write evaluation data only for the top-level method's model to HDF5",
         "title": "Top Method",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "environment.model_evals_selection",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "MODEL_EVAL_STORE_TOP_METHOD"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:
field top_method: Literal[True] = True

Write evaluation data only for the top-level method’s model to HDF5