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-group-label": "Input/Output",
         "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-group-label": "Input/Output",
         "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-group-label": "Input/Output",
         "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",
         "x-group-label": "Input/Output"
      },
      "write_restart": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Base filename for restart file write",
         "title": "Write Restart",
         "x-complexity": 1,
         "x-group-label": "Input/Output",
         "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-complexity": 1,
         "x-group-label": "Input/Output",
         "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-complexity": 1,
         "x-group-label": "Input/Output",
         "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-complexity": 1,
         "x-group-label": "Input/Output",
         "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-group-label": "Run Modes",
         "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-group-label": "Run Modes",
         "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-group-label": "Run Modes",
         "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-group-label": "Run Modes",
         "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-complexity": 1,
               "x-group": "Model Evaluation Storage 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-complexity": 1,
               "x-group": "Interface Evaluation Storage 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

class dakota.spec.environment.TabularDataCustomAnnotatedConfig(*, header: Literal[True] | None = None, eval_id: Literal[True] | None = None, interface_id: Literal[True] | None = None)

Selects custom-annotated tabular file format

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.TabularDataAnnotated(*, annotated: Literal[True] = True)

Selects annotated tabular file format

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.TabularDataFreeform(*, freeform: Literal[True] = True)

Selects freeform file format

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.ReadRestart(*, filename: str, stop_restart: Annotated[int | None, Ge(ge=0)] = None)

Base filename for restart file read

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.TopMethod(*, top_method: Literal[True] = True)

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

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.ModelSelectionNone(*, none: Literal[True] = True)

Write evaluation data for no models to HDF5

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.AllMethods(*, all_methods: Literal[True] = True)

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

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.ModelSelectionAll(*, all: Literal[True] = True)

Write evaluation data to HDF5 for all models

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.InterfaceSelectionNone(*, none: Literal[True] = True)

Write evaluation data for no interfaces to HDF5

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.Simulation(*, simulation: Literal[True] = True)

Write evaluation data only for simulation interfaces to HDF5

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.InterfaceSelectionAll(*, all: Literal[True] = True)

Write evaluation data for all interfaces to HDF5

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.OutputCustomAnnotatedConfig(*, header: Literal[True] | None = None, eval_id: Literal[True] | None = None, interface_id: Literal[True] | None = None)

Selects custom-annotated tabular file format

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.OutputAnnotated(*, annotated: Literal[True] = True)

Selects annotated tabular file format

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.OutputFreeform(*, freeform: Literal[True] = True)

Selects freeform file format

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.Run(*, input: str | None = None, output: str | None = None)

Invoke Dakota with run mode active

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.InputCustomAnnotatedConfig(*, header: Literal[True] | None = None, eval_id: Literal[True] | None = None, interface_id: Literal[True] | None = None)

Selects custom-annotated tabular file format

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.InputAnnotated(*, annotated: Literal[True] = True)

Selects annotated tabular file format

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.InputFreeform(*, freeform: Literal[True] = True)

Selects freeform file format

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.TabularDataCustomAnnotated(*, custom_annotated: TabularDataCustomAnnotatedConfig = <factory>)

Selects custom-annotated tabular file format

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.Hdf5(*, model_selection: TopMethod | ModelSelectionNone | AllMethods | ModelSelectionAll = <factory>, interface_selection: InterfaceSelectionNone | Simulation | InterfaceSelectionAll = <factory>)

Write results to file in HDF5 format

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.OutputCustomAnnotated(*, custom_annotated: OutputCustomAnnotatedConfig = <factory>)

Selects custom-annotated tabular file format

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.InputCustomAnnotated(*, custom_annotated: InputCustomAnnotatedConfig = <factory>)

Selects custom-annotated tabular file format

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.TabularData(*, tabular_data_file: str = 'dakota_tabular.dat', format: TabularDataCustomAnnotated | TabularDataAnnotated | TabularDataFreeform = <factory>)

Write a tabular results file with variable and response history

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.ResultsOutput(*, results_output_file: str = 'dakota_results', text: Literal[True] | None = None, hdf5: Hdf5 | None = None)

(Experimental) Write a summary file containing the final results

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.Output(*, filename: str, format: OutputCustomAnnotated | OutputAnnotated | OutputFreeform = <factory>)

Base filename for pre-run mode data output

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.Input(*, filename: str, format: InputCustomAnnotated | InputAnnotated | InputFreeform = <factory>)

Base filename for post-run mode data input

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.PreRun(*, input: str | None = None, output: Output | None = None)

Invoke Dakota with pre-run mode active

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.environment.PostRun(*, input: Input | None = None, output: str | None = None)

Invoke Dakota with post-run mode active

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models