import_points
- pydantic model dakota.spec.method.import_points.ImportPointsSelection
Generated model for ImportPointsSelection
Show JSON schema
{ "title": "ImportPointsSelection", "description": "Generated model for ImportPointsSelection", "type": "object", "properties": { "import_points": { "$ref": "#/$defs/ImportPointsConfig", "x-materialization": [ { "ir_key": "method.algorithm", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "IMPORT_POINTS" } ] } }, "$defs": { "Debug": { "additionalProperties": false, "description": "Level 5 of 5 - maximum", "properties": { "debug": { "const": true, "default": true, "description": "Level 5 of 5 - maximum", "title": "Debug", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "DEBUG_OUTPUT" } ] } }, "title": "Debug", "type": "object" }, "DefaultFinalMomentsCentral": { "additionalProperties": false, "description": "Output central moments and include them within the set of final statistics.", "properties": { "central": { "const": true, "default": true, "description": "Output central moments and include them within the set of final statistics.", "title": "Central", "type": "boolean", "x-materialization": [ { "enum_scope": "Pecos", "ir_key": "method.nond.final_moments", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "CENTRAL_MOMENTS" } ] } }, "title": "DefaultFinalMomentsCentral", "type": "object" }, "DefaultFinalMomentsNoneKeyword": { "additionalProperties": false, "description": "Omit moments from the set of final statistics.", "properties": { "none": { "const": true, "default": true, "description": "Omit moments from the set of final statistics.", "title": "None", "type": "boolean", "x-materialization": [ { "enum_scope": "Pecos", "ir_key": "method.nond.final_moments", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "NO_MOMENTS" } ] } }, "title": "DefaultFinalMomentsNoneKeyword", "type": "object" }, "DefaultFinalMomentsStandard": { "additionalProperties": false, "description": "Output standardized moments and include them within the set of final statistics.", "properties": { "standard": { "const": true, "default": true, "description": "Output standardized moments and include them within the set of final statistics.", "title": "Standard", "type": "boolean", "x-materialization": [ { "enum_scope": "Pecos", "ir_key": "method.nond.final_moments", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "STANDARD_MOMENTS" } ] } }, "title": "DefaultFinalMomentsStandard", "type": "object" }, "DistributionCumulComplContext1Complementary": { "additionalProperties": false, "description": "Computes statistics according to complementary cumulative functions", "properties": { "complementary": { "const": true, "default": true, "description": "Computes statistics according to complementary cumulative functions", "title": "Complementary", "type": "boolean", "x-materialization": [ { "ir_key": "method.nond.distribution", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "COMPLEMENTARY" } ] } }, "title": "DistributionCumulComplContext1Complementary", "type": "object" }, "DistributionCumulComplContext1Cumulative": { "additionalProperties": false, "description": "Computes statistics according to cumulative functions", "properties": { "cumulative": { "const": true, "default": true, "description": "Computes statistics according to cumulative functions", "title": "Cumulative", "type": "boolean", "x-materialization": [ { "ir_key": "method.nond.distribution", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "CUMULATIVE" } ] } }, "title": "DistributionCumulComplContext1Cumulative", "type": "object" }, "GenReliabilityLevelsGenReliabilityLevels": { "additionalProperties": false, "description": "Specify generalized relability levels at which to estimate the corresponding response value", "properties": { "values": { "description": "Specify generalized relability levels at which to estimate the corresponding response value", "items": { "type": "number" }, "title": "Values", "type": "array" }, "num_gen_reliability_levels": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify which ``gen_reliability_levels`` correspond to which response", "title": "Num Gen Reliability Levels" } }, "required": [ "values" ], "title": "GenReliabilityLevelsGenReliabilityLevels", "type": "object", "x-model-validations": [ { "validationContext": "genreliabilitylevelsgenreliabilitylevels", "validationErrorMessage": "For genreliabilitylevelsgenreliabilitylevels, sum of num_gen_reliability_levels must equal length of values.", "validationFields": [ "num_gen_reliability_levels", "values" ], "validationLiterals": [], "validationRuleName": "check_sum_equals_length" } ] }, "ImportPointsConfig": { "additionalProperties": false, "description": "Imports points from file and computes statistics for them.", "properties": { "model_pointer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identifier for model block to be used by a method", "title": "Model Pointer", "x-block-pointer": "model", "x-materialization": [ { "ir_key": "method.model_pointer", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "response_levels": { "anyOf": [ { "$ref": "#/$defs/ResponseLevelsComputeProbRelGenResponseLevels" }, { "type": "null" } ], "argument": "values", "default": null, "description": "Values at which to estimate desired statistics for each response", "x-materialization": [ { "ir_key": "method.nond.response_levels", "ir_value_type": "RealVectorArray", "storage_type": "RESPONSE_LEVELS_ARRAY" } ] }, "reliability_levels": { "anyOf": [ { "$ref": "#/$defs/ReliabilityLevelsReliabilityLevels" }, { "type": "null" } ], "argument": "values", "default": null, "description": "Specify reliability levels at which the response values will be estimated", "x-materialization": [ { "ir_key": "method.nond.reliability_levels", "ir_value_type": "RealVectorArray", "storage_type": "RESPONSE_LEVELS_ARRAY" } ] }, "probability_levels": { "anyOf": [ { "$ref": "#/$defs/ProbabilityLevelsContext2ProbabilityLevels" }, { "type": "null" } ], "argument": "values", "default": null, "description": "Specify probability levels at which to estimate the corresponding response value", "x-materialization": [ { "ir_key": "method.nond.probability_levels", "ir_value_type": "RealVectorArray", "storage_type": "RESPONSE_LEVELS_ARRAY" } ] }, "gen_reliability_levels": { "anyOf": [ { "$ref": "#/$defs/GenReliabilityLevelsGenReliabilityLevels" }, { "type": "null" } ], "argument": "values", "default": null, "description": "Specify generalized relability levels at which to estimate the corresponding response value", "x-materialization": [ { "ir_key": "method.nond.gen_reliability_levels", "ir_value_type": "RealVectorArray", "storage_type": "RESPONSE_LEVELS_ARRAY" } ] }, "distribution": { "anyOf": [ { "$ref": "#/$defs/DistributionCumulComplContext1Cumulative" }, { "$ref": "#/$defs/DistributionCumulComplContext1Complementary" } ], "description": "Selection of cumulative or complementary cumulative functions", "title": "Distribution", "x-model-default": "DistributionCumulComplContext1Cumulative", "x-union-pattern": 1 }, "final_moments": { "anyOf": [ { "$ref": "#/$defs/DefaultFinalMomentsNoneKeyword" }, { "$ref": "#/$defs/DefaultFinalMomentsStandard" }, { "$ref": "#/$defs/DefaultFinalMomentsCentral" } ], "description": "Output moments of the specified type and include them within the set of final statistics.", "title": "Final Moments", "x-model-default": "DefaultFinalMomentsStandard", "x-union-pattern": 1 }, "id_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name the method block; helpful when there are multiple", "title": "Id Method", "x-materialization": [ { "ir_key": "method.id", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "output": { "anyOf": [ { "$ref": "#/$defs/Debug" }, { "$ref": "#/$defs/Verbose" }, { "$ref": "#/$defs/Normal" }, { "$ref": "#/$defs/Quiet" }, { "$ref": "#/$defs/Silent" } ], "description": "Control how much method information is written to the screen and output file", "title": "Output", "x-model-default": "Normal", "x-union-pattern": 1 }, "final_solutions": { "default": 0, "description": "Number of designs returned as the best solutions", "minimum": 0, "title": "Final Solutions", "type": "integer", "x-materialization": [ { "ir_key": "method.final_solutions", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "import_points_file": { "$ref": "#/$defs/ImportPointsImportPointsFile", "argument": "filename" }, "variance_based_decomp": { "anyOf": [ { "$ref": "#/$defs/ImportPointsVarianceBasedDecomp" }, { "type": "null" } ], "default": null, "description": "Computes Sobol' main effects using a binned approach", "x-materialization": [ { "ir_key": "method.variance_based_decomp", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "std_regression_coeffs": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Output Standardized Regression Coefficients and R^2 for samples", "title": "Std Regression Coeffs", "x-materialization": [ { "ir_key": "method.std_regression_coeffs", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "tolerance_intervals": { "anyOf": [ { "$ref": "#/$defs/ImportPointsTolIntervals" }, { "type": "null" } ], "default": null, "description": "Computes the double sided tolerance interval equivalent normal distribuion.", "x-materialization": [ { "ir_key": "method.tolerance_intervals", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "import_points_file" ], "title": "ImportPointsConfig", "type": "object" }, "ImportPointsFileAnnotatedConfig": { "additionalProperties": false, "description": "Selects annotated tabular file format", "properties": { "use_variable_labels": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Validate/use variable labels from tabular file header", "title": "Use Variable Labels", "x-materialization": [ { "ir_key": "method.import_points.use_variable_labels", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ImportPointsFileAnnotatedConfig", "type": "object" }, "ImportPointsFileCustomAnnotatedHeader": { "additionalProperties": false, "description": "Enable header row in custom-annotated tabular file", "properties": { "use_variable_labels": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Validate/use variable labels from tabular file header", "title": "Use Variable Labels", "x-materialization": [ { "ir_key": "method.import_points.use_variable_labels", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ImportPointsFileCustomAnnotatedHeader", "type": "object" }, "ImportPointsImportPointsFile": { "additionalProperties": false, "description": "File containing list of variable and response values to import for analysis.", "properties": { "filename": { "description": "File containing list of variable and response values to import for analysis.", "title": "Filename", "type": "string", "x-materialization": [ { "ir_key": "method.import_points_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "format": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/ImportPointsImportPointsFileCustomAnnotated" }, { "$ref": "#/$defs/ImportPointsImportPointsFileAnnotated" }, { "$ref": "#/$defs/ImportPointsImportPointsFileFreeform" } ], "description": "Tabular Format", "title": "Format", "x-model-default": "ImportPointsImportPointsFileAnnotated", "x-union-pattern": 1 }, "active_only": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Import only active variables from tabular data file", "title": "Active Only", "x-materialization": [ { "ir_key": "method.import_points.active_only", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "filename" ], "title": "ImportPointsImportPointsFile", "type": "object" }, "ImportPointsImportPointsFileAnnotated": { "additionalProperties": false, "description": "Selects annotated tabular file format", "properties": { "annotated": { "$ref": "#/$defs/ImportPointsFileAnnotatedConfig", "x-materialization": [ { "ir_key": "method.import_points_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_ANNOTATED" } ], "x-model-default": "ImportPointsFileAnnotatedConfig" } }, "title": "ImportPointsImportPointsFileAnnotated", "type": "object" }, "ImportPointsImportPointsFileCustomAnnotated": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format", "properties": { "custom_annotated": { "$ref": "#/$defs/ImportPointsImportPointsFileCustomAnnotatedConfig", "x-materialization": [ { "ir_key": "method.import_points_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ], "x-model-default": "ImportPointsImportPointsFileCustomAnnotatedConfig" } }, "title": "ImportPointsImportPointsFileCustomAnnotated", "type": "object" }, "ImportPointsImportPointsFileCustomAnnotatedConfig": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format", "properties": { "header": { "anyOf": [ { "$ref": "#/$defs/ImportPointsFileCustomAnnotatedHeader" }, { "type": "null" } ], "default": null, "description": "Enable header row in custom-annotated tabular file", "x-materialization": [ { "ir_key": "method.import_points_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": "method.import_points_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": "method.import_points_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_IFACE_ID" } ] } }, "title": "ImportPointsImportPointsFileCustomAnnotatedConfig", "type": "object" }, "ImportPointsImportPointsFileFreeform": { "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": "method.import_points_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ] } }, "title": "ImportPointsImportPointsFileFreeform", "type": "object" }, "ImportPointsTolIntervals": { "additionalProperties": false, "description": "Computes the double sided tolerance interval equivalent normal distribuion.", "properties": { "coverage": { "default": 0.95, "description": "The coverage to be used for the calculation of the lower and upper ends of the interval covering the user supplied samples.", "maximum": 1, "minimum": 0, "title": "Coverage", "type": "number", "x-materialization": [ { "ir_key": "method.ti_coverage", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "confidence_level": { "default": 0.9, "description": "The confidence level to be used to determine the standard deviation of the equivalent normal distribution.", "maximum": 1, "minimum": 0, "title": "Confidence Level", "type": "number", "x-materialization": [ { "ir_key": "method.ti_confidence_level", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] } }, "title": "ImportPointsTolIntervals", "type": "object" }, "ImportPointsVarianceBasedDecomp": { "additionalProperties": false, "description": "Computes Sobol' main effects using a binned approach", "properties": { "drop_tolerance": { "default": -1.0, "description": "Suppresses output of sensitivity indices with values lower than this tolerance", "title": "Drop Tolerance", "type": "number", "x-materialization": [ { "ir_key": "method.vbd_drop_tolerance", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "num_bins": { "default": -1, "description": "Number of bins used to compute the variance-based decomposition", "title": "Num Bins", "type": "integer", "x-materialization": [ { "ir_key": "method.vbd_via_sampling_num_bins", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "title": "ImportPointsVarianceBasedDecomp", "type": "object" }, "Normal": { "additionalProperties": false, "description": "Level 3 of 5 - default", "properties": { "normal": { "const": true, "default": true, "description": "Level 3 of 5 - default", "title": "Normal", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "NORMAL_OUTPUT" } ] } }, "title": "Normal", "type": "object" }, "ProbabilityLevelsContext2ProbabilityLevels": { "additionalProperties": false, "description": "Specify probability levels at which to estimate the corresponding response value", "properties": { "values": { "description": "Specify probability levels at which to estimate the corresponding response value", "items": { "type": "number" }, "title": "Values", "type": "array" }, "num_probability_levels": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify which ``probability_levels`` correspond to which response", "title": "Num Probability Levels" } }, "required": [ "values" ], "title": "ProbabilityLevelsContext2ProbabilityLevels", "type": "object", "x-model-validations": [ { "validationContext": "probabilitylevelscontext2probabilitylevels", "validationErrorMessage": "For probabilitylevelscontext2probabilitylevels, all elements of values must be in [0, 1].", "validationFields": [ "values" ], "validationLiterals": [], "validationRuleName": "check_probability_list" }, { "validationContext": "probabilitylevelscontext2probabilitylevels", "validationErrorMessage": "For probabilitylevelscontext2probabilitylevels, sum of num_probability_levels must equal length of values.", "validationFields": [ "num_probability_levels", "values" ], "validationLiterals": [], "validationRuleName": "check_sum_equals_length" } ] }, "Quiet": { "additionalProperties": false, "description": "Level 2 of 5 - less than normal", "properties": { "quiet": { "const": true, "default": true, "description": "Level 2 of 5 - less than normal", "title": "Quiet", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "QUIET_OUTPUT" } ] } }, "title": "Quiet", "type": "object" }, "ReliabilityLevelsReliabilityLevels": { "additionalProperties": false, "description": "Specify reliability levels at which the response values will be estimated", "properties": { "values": { "description": "Specify reliability levels at which the response values will be estimated", "items": { "type": "number" }, "title": "Values", "type": "array" }, "num_reliability_levels": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify which ``reliability_levels`` correspond to which response", "title": "Num Reliability Levels" } }, "required": [ "values" ], "title": "ReliabilityLevelsReliabilityLevels", "type": "object", "x-model-validations": [ { "validationContext": "reliabilitylevelsreliabilitylevels", "validationErrorMessage": "For reliabilitylevelsreliabilitylevels, sum of num_reliability_levels must equal length of values.", "validationFields": [ "num_reliability_levels", "values" ], "validationLiterals": [], "validationRuleName": "check_sum_equals_length" } ] }, "ResponseLevelsComputeProbRelGenCompute": { "additionalProperties": false, "description": "Selection of statistics to compute at each response level", "properties": { "statistic": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/ResponseLevelsComputeProbRelGenProbabilities" }, { "$ref": "#/$defs/ResponseLevelsComputeProbRelGenReliabilities" }, { "$ref": "#/$defs/ResponseLevelsComputeProbRelGenGenReliabilities" } ], "description": "Statistics to Compute", "title": "Statistic", "x-union-pattern": 4 }, "system": { "anyOf": [ { "$ref": "#/$defs/ResponseLevelsComputeProbRelGenSystemSeries" }, { "$ref": "#/$defs/ResponseLevelsComputeProbRelGenSystemParallel" }, { "type": "null" } ], "default": null, "description": "Compute system reliability (series or parallel)", "title": "System", "x-union-pattern": 2 } }, "required": [ "statistic" ], "title": "ResponseLevelsComputeProbRelGenCompute", "type": "object" }, "ResponseLevelsComputeProbRelGenGenReliabilities": { "additionalProperties": false, "description": "Computes generalized reliabilities associated with response levels", "properties": { "gen_reliabilities": { "const": true, "default": true, "description": "Computes generalized reliabilities associated with response levels", "title": "Gen Reliabilities", "type": "boolean", "x-materialization": [ { "ir_key": "method.nond.response_level_target", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "GEN_RELIABILITIES" } ] } }, "title": "ResponseLevelsComputeProbRelGenGenReliabilities", "type": "object" }, "ResponseLevelsComputeProbRelGenProbabilities": { "additionalProperties": false, "description": "Computes probabilities associated with response levels", "properties": { "probabilities": { "const": true, "default": true, "description": "Computes probabilities associated with response levels", "title": "Probabilities", "type": "boolean", "x-materialization": [ { "ir_key": "method.nond.response_level_target", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "PROBABILITIES" } ] } }, "title": "ResponseLevelsComputeProbRelGenProbabilities", "type": "object" }, "ResponseLevelsComputeProbRelGenReliabilities": { "additionalProperties": false, "description": "Computes reliabilities associated with response levels", "properties": { "reliabilities": { "const": true, "default": true, "description": "Computes reliabilities associated with response levels", "title": "Reliabilities", "type": "boolean", "x-materialization": [ { "ir_key": "method.nond.response_level_target", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "RELIABILITIES" } ] } }, "title": "ResponseLevelsComputeProbRelGenReliabilities", "type": "object" }, "ResponseLevelsComputeProbRelGenResponseLevels": { "additionalProperties": false, "description": "Values at which to estimate desired statistics for each response", "properties": { "values": { "description": "Values at which to estimate desired statistics for each response", "items": { "type": "number" }, "title": "Values", "type": "array" }, "num_response_levels": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Number of values at which to estimate desired statistics for each response", "title": "Num Response Levels" }, "compute": { "anyOf": [ { "$ref": "#/$defs/ResponseLevelsComputeProbRelGenCompute" }, { "type": "null" } ], "default": null, "description": "Selection of statistics to compute at each response level" } }, "required": [ "values" ], "title": "ResponseLevelsComputeProbRelGenResponseLevels", "type": "object", "x-model-validations": [ { "validationContext": "responselevelscomputeprobrelgenresponselevels", "validationErrorMessage": "For responselevelscomputeprobrelgenresponselevels, sum of num_response_levels must equal length of values.", "validationFields": [ "num_response_levels", "values" ], "validationLiterals": [], "validationRuleName": "check_sum_equals_length" } ] }, "ResponseLevelsComputeProbRelGenSystemParallel": { "additionalProperties": false, "description": "Aggregate response statistics assuming a parallel system", "properties": { "parallel": { "const": true, "default": true, "description": "Aggregate response statistics assuming a parallel system", "title": "Parallel", "type": "boolean", "x-materialization": [ { "ir_key": "method.nond.response_level_target_reduce", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "SYSTEM_PARALLEL" } ] } }, "title": "ResponseLevelsComputeProbRelGenSystemParallel", "type": "object" }, "ResponseLevelsComputeProbRelGenSystemSeries": { "additionalProperties": false, "description": "Aggregate response statistics assuming a series system", "properties": { "series": { "const": true, "default": true, "description": "Aggregate response statistics assuming a series system", "title": "Series", "type": "boolean", "x-materialization": [ { "ir_key": "method.nond.response_level_target_reduce", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "SYSTEM_SERIES" } ] } }, "title": "ResponseLevelsComputeProbRelGenSystemSeries", "type": "object" }, "Silent": { "additionalProperties": false, "description": "Level 1 of 5 - minimum", "properties": { "silent": { "const": true, "default": true, "description": "Level 1 of 5 - minimum", "title": "Silent", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "SILENT_OUTPUT" } ] } }, "title": "Silent", "type": "object" }, "Verbose": { "additionalProperties": false, "description": "Level 4 of 5 - more than normal", "properties": { "verbose": { "const": true, "default": true, "description": "Level 4 of 5 - more than normal", "title": "Verbose", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "VERBOSE_OUTPUT" } ] } }, "title": "Verbose", "type": "object" } }, "additionalProperties": false, "required": [ "import_points" ] }
- field import_points: ImportPointsConfig [Required]
- classmethod get_registry() dict[str, type[MethodSelection]]
Get registry, performing deferred registration on first call
- classmethod get_union()
Generate Union from all registered selections
- pydantic model dakota.spec.method.import_points.ImportPointsConfig
Imports points from file and computes statistics for them.
Show JSON schema
{ "title": "ImportPointsConfig", "description": "Imports points from file and computes statistics for them.", "type": "object", "properties": { "model_pointer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identifier for model block to be used by a method", "title": "Model Pointer", "x-block-pointer": "model", "x-materialization": [ { "ir_key": "method.model_pointer", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "response_levels": { "anyOf": [ { "$ref": "#/$defs/ResponseLevelsComputeProbRelGenResponseLevels" }, { "type": "null" } ], "argument": "values", "default": null, "description": "Values at which to estimate desired statistics for each response", "x-materialization": [ { "ir_key": "method.nond.response_levels", "ir_value_type": "RealVectorArray", "storage_type": "RESPONSE_LEVELS_ARRAY" } ] }, "reliability_levels": { "anyOf": [ { "$ref": "#/$defs/ReliabilityLevelsReliabilityLevels" }, { "type": "null" } ], "argument": "values", "default": null, "description": "Specify reliability levels at which the response values will be estimated", "x-materialization": [ { "ir_key": "method.nond.reliability_levels", "ir_value_type": "RealVectorArray", "storage_type": "RESPONSE_LEVELS_ARRAY" } ] }, "probability_levels": { "anyOf": [ { "$ref": "#/$defs/ProbabilityLevelsContext2ProbabilityLevels" }, { "type": "null" } ], "argument": "values", "default": null, "description": "Specify probability levels at which to estimate the corresponding response value", "x-materialization": [ { "ir_key": "method.nond.probability_levels", "ir_value_type": "RealVectorArray", "storage_type": "RESPONSE_LEVELS_ARRAY" } ] }, "gen_reliability_levels": { "anyOf": [ { "$ref": "#/$defs/GenReliabilityLevelsGenReliabilityLevels" }, { "type": "null" } ], "argument": "values", "default": null, "description": "Specify generalized relability levels at which to estimate the corresponding response value", "x-materialization": [ { "ir_key": "method.nond.gen_reliability_levels", "ir_value_type": "RealVectorArray", "storage_type": "RESPONSE_LEVELS_ARRAY" } ] }, "distribution": { "anyOf": [ { "$ref": "#/$defs/DistributionCumulComplContext1Cumulative" }, { "$ref": "#/$defs/DistributionCumulComplContext1Complementary" } ], "description": "Selection of cumulative or complementary cumulative functions", "title": "Distribution", "x-model-default": "DistributionCumulComplContext1Cumulative", "x-union-pattern": 1 }, "final_moments": { "anyOf": [ { "$ref": "#/$defs/DefaultFinalMomentsNoneKeyword" }, { "$ref": "#/$defs/DefaultFinalMomentsStandard" }, { "$ref": "#/$defs/DefaultFinalMomentsCentral" } ], "description": "Output moments of the specified type and include them within the set of final statistics.", "title": "Final Moments", "x-model-default": "DefaultFinalMomentsStandard", "x-union-pattern": 1 }, "id_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name the method block; helpful when there are multiple", "title": "Id Method", "x-materialization": [ { "ir_key": "method.id", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "output": { "anyOf": [ { "$ref": "#/$defs/Debug" }, { "$ref": "#/$defs/Verbose" }, { "$ref": "#/$defs/Normal" }, { "$ref": "#/$defs/Quiet" }, { "$ref": "#/$defs/Silent" } ], "description": "Control how much method information is written to the screen and output file", "title": "Output", "x-model-default": "Normal", "x-union-pattern": 1 }, "final_solutions": { "default": 0, "description": "Number of designs returned as the best solutions", "minimum": 0, "title": "Final Solutions", "type": "integer", "x-materialization": [ { "ir_key": "method.final_solutions", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "import_points_file": { "$ref": "#/$defs/ImportPointsImportPointsFile", "argument": "filename" }, "variance_based_decomp": { "anyOf": [ { "$ref": "#/$defs/ImportPointsVarianceBasedDecomp" }, { "type": "null" } ], "default": null, "description": "Computes Sobol' main effects using a binned approach", "x-materialization": [ { "ir_key": "method.variance_based_decomp", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "std_regression_coeffs": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Output Standardized Regression Coefficients and R^2 for samples", "title": "Std Regression Coeffs", "x-materialization": [ { "ir_key": "method.std_regression_coeffs", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "tolerance_intervals": { "anyOf": [ { "$ref": "#/$defs/ImportPointsTolIntervals" }, { "type": "null" } ], "default": null, "description": "Computes the double sided tolerance interval equivalent normal distribuion.", "x-materialization": [ { "ir_key": "method.tolerance_intervals", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "$defs": { "Debug": { "additionalProperties": false, "description": "Level 5 of 5 - maximum", "properties": { "debug": { "const": true, "default": true, "description": "Level 5 of 5 - maximum", "title": "Debug", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "DEBUG_OUTPUT" } ] } }, "title": "Debug", "type": "object" }, "DefaultFinalMomentsCentral": { "additionalProperties": false, "description": "Output central moments and include them within the set of final statistics.", "properties": { "central": { "const": true, "default": true, "description": "Output central moments and include them within the set of final statistics.", "title": "Central", "type": "boolean", "x-materialization": [ { "enum_scope": "Pecos", "ir_key": "method.nond.final_moments", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "CENTRAL_MOMENTS" } ] } }, "title": "DefaultFinalMomentsCentral", "type": "object" }, "DefaultFinalMomentsNoneKeyword": { "additionalProperties": false, "description": "Omit moments from the set of final statistics.", "properties": { "none": { "const": true, "default": true, "description": "Omit moments from the set of final statistics.", "title": "None", "type": "boolean", "x-materialization": [ { "enum_scope": "Pecos", "ir_key": "method.nond.final_moments", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "NO_MOMENTS" } ] } }, "title": "DefaultFinalMomentsNoneKeyword", "type": "object" }, "DefaultFinalMomentsStandard": { "additionalProperties": false, "description": "Output standardized moments and include them within the set of final statistics.", "properties": { "standard": { "const": true, "default": true, "description": "Output standardized moments and include them within the set of final statistics.", "title": "Standard", "type": "boolean", "x-materialization": [ { "enum_scope": "Pecos", "ir_key": "method.nond.final_moments", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "STANDARD_MOMENTS" } ] } }, "title": "DefaultFinalMomentsStandard", "type": "object" }, "DistributionCumulComplContext1Complementary": { "additionalProperties": false, "description": "Computes statistics according to complementary cumulative functions", "properties": { "complementary": { "const": true, "default": true, "description": "Computes statistics according to complementary cumulative functions", "title": "Complementary", "type": "boolean", "x-materialization": [ { "ir_key": "method.nond.distribution", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "COMPLEMENTARY" } ] } }, "title": "DistributionCumulComplContext1Complementary", "type": "object" }, "DistributionCumulComplContext1Cumulative": { "additionalProperties": false, "description": "Computes statistics according to cumulative functions", "properties": { "cumulative": { "const": true, "default": true, "description": "Computes statistics according to cumulative functions", "title": "Cumulative", "type": "boolean", "x-materialization": [ { "ir_key": "method.nond.distribution", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "CUMULATIVE" } ] } }, "title": "DistributionCumulComplContext1Cumulative", "type": "object" }, "GenReliabilityLevelsGenReliabilityLevels": { "additionalProperties": false, "description": "Specify generalized relability levels at which to estimate the corresponding response value", "properties": { "values": { "description": "Specify generalized relability levels at which to estimate the corresponding response value", "items": { "type": "number" }, "title": "Values", "type": "array" }, "num_gen_reliability_levels": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify which ``gen_reliability_levels`` correspond to which response", "title": "Num Gen Reliability Levels" } }, "required": [ "values" ], "title": "GenReliabilityLevelsGenReliabilityLevels", "type": "object", "x-model-validations": [ { "validationContext": "genreliabilitylevelsgenreliabilitylevels", "validationErrorMessage": "For genreliabilitylevelsgenreliabilitylevels, sum of num_gen_reliability_levels must equal length of values.", "validationFields": [ "num_gen_reliability_levels", "values" ], "validationLiterals": [], "validationRuleName": "check_sum_equals_length" } ] }, "ImportPointsFileAnnotatedConfig": { "additionalProperties": false, "description": "Selects annotated tabular file format", "properties": { "use_variable_labels": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Validate/use variable labels from tabular file header", "title": "Use Variable Labels", "x-materialization": [ { "ir_key": "method.import_points.use_variable_labels", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ImportPointsFileAnnotatedConfig", "type": "object" }, "ImportPointsFileCustomAnnotatedHeader": { "additionalProperties": false, "description": "Enable header row in custom-annotated tabular file", "properties": { "use_variable_labels": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Validate/use variable labels from tabular file header", "title": "Use Variable Labels", "x-materialization": [ { "ir_key": "method.import_points.use_variable_labels", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ImportPointsFileCustomAnnotatedHeader", "type": "object" }, "ImportPointsImportPointsFile": { "additionalProperties": false, "description": "File containing list of variable and response values to import for analysis.", "properties": { "filename": { "description": "File containing list of variable and response values to import for analysis.", "title": "Filename", "type": "string", "x-materialization": [ { "ir_key": "method.import_points_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "format": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/ImportPointsImportPointsFileCustomAnnotated" }, { "$ref": "#/$defs/ImportPointsImportPointsFileAnnotated" }, { "$ref": "#/$defs/ImportPointsImportPointsFileFreeform" } ], "description": "Tabular Format", "title": "Format", "x-model-default": "ImportPointsImportPointsFileAnnotated", "x-union-pattern": 1 }, "active_only": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Import only active variables from tabular data file", "title": "Active Only", "x-materialization": [ { "ir_key": "method.import_points.active_only", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "filename" ], "title": "ImportPointsImportPointsFile", "type": "object" }, "ImportPointsImportPointsFileAnnotated": { "additionalProperties": false, "description": "Selects annotated tabular file format", "properties": { "annotated": { "$ref": "#/$defs/ImportPointsFileAnnotatedConfig", "x-materialization": [ { "ir_key": "method.import_points_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_ANNOTATED" } ], "x-model-default": "ImportPointsFileAnnotatedConfig" } }, "title": "ImportPointsImportPointsFileAnnotated", "type": "object" }, "ImportPointsImportPointsFileCustomAnnotated": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format", "properties": { "custom_annotated": { "$ref": "#/$defs/ImportPointsImportPointsFileCustomAnnotatedConfig", "x-materialization": [ { "ir_key": "method.import_points_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ], "x-model-default": "ImportPointsImportPointsFileCustomAnnotatedConfig" } }, "title": "ImportPointsImportPointsFileCustomAnnotated", "type": "object" }, "ImportPointsImportPointsFileCustomAnnotatedConfig": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format", "properties": { "header": { "anyOf": [ { "$ref": "#/$defs/ImportPointsFileCustomAnnotatedHeader" }, { "type": "null" } ], "default": null, "description": "Enable header row in custom-annotated tabular file", "x-materialization": [ { "ir_key": "method.import_points_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": "method.import_points_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": "method.import_points_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_IFACE_ID" } ] } }, "title": "ImportPointsImportPointsFileCustomAnnotatedConfig", "type": "object" }, "ImportPointsImportPointsFileFreeform": { "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": "method.import_points_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ] } }, "title": "ImportPointsImportPointsFileFreeform", "type": "object" }, "ImportPointsTolIntervals": { "additionalProperties": false, "description": "Computes the double sided tolerance interval equivalent normal distribuion.", "properties": { "coverage": { "default": 0.95, "description": "The coverage to be used for the calculation of the lower and upper ends of the interval covering the user supplied samples.", "maximum": 1, "minimum": 0, "title": "Coverage", "type": "number", "x-materialization": [ { "ir_key": "method.ti_coverage", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "confidence_level": { "default": 0.9, "description": "The confidence level to be used to determine the standard deviation of the equivalent normal distribution.", "maximum": 1, "minimum": 0, "title": "Confidence Level", "type": "number", "x-materialization": [ { "ir_key": "method.ti_confidence_level", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] } }, "title": "ImportPointsTolIntervals", "type": "object" }, "ImportPointsVarianceBasedDecomp": { "additionalProperties": false, "description": "Computes Sobol' main effects using a binned approach", "properties": { "drop_tolerance": { "default": -1.0, "description": "Suppresses output of sensitivity indices with values lower than this tolerance", "title": "Drop Tolerance", "type": "number", "x-materialization": [ { "ir_key": "method.vbd_drop_tolerance", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "num_bins": { "default": -1, "description": "Number of bins used to compute the variance-based decomposition", "title": "Num Bins", "type": "integer", "x-materialization": [ { "ir_key": "method.vbd_via_sampling_num_bins", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "title": "ImportPointsVarianceBasedDecomp", "type": "object" }, "Normal": { "additionalProperties": false, "description": "Level 3 of 5 - default", "properties": { "normal": { "const": true, "default": true, "description": "Level 3 of 5 - default", "title": "Normal", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "NORMAL_OUTPUT" } ] } }, "title": "Normal", "type": "object" }, "ProbabilityLevelsContext2ProbabilityLevels": { "additionalProperties": false, "description": "Specify probability levels at which to estimate the corresponding response value", "properties": { "values": { "description": "Specify probability levels at which to estimate the corresponding response value", "items": { "type": "number" }, "title": "Values", "type": "array" }, "num_probability_levels": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify which ``probability_levels`` correspond to which response", "title": "Num Probability Levels" } }, "required": [ "values" ], "title": "ProbabilityLevelsContext2ProbabilityLevels", "type": "object", "x-model-validations": [ { "validationContext": "probabilitylevelscontext2probabilitylevels", "validationErrorMessage": "For probabilitylevelscontext2probabilitylevels, all elements of values must be in [0, 1].", "validationFields": [ "values" ], "validationLiterals": [], "validationRuleName": "check_probability_list" }, { "validationContext": "probabilitylevelscontext2probabilitylevels", "validationErrorMessage": "For probabilitylevelscontext2probabilitylevels, sum of num_probability_levels must equal length of values.", "validationFields": [ "num_probability_levels", "values" ], "validationLiterals": [], "validationRuleName": "check_sum_equals_length" } ] }, "Quiet": { "additionalProperties": false, "description": "Level 2 of 5 - less than normal", "properties": { "quiet": { "const": true, "default": true, "description": "Level 2 of 5 - less than normal", "title": "Quiet", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "QUIET_OUTPUT" } ] } }, "title": "Quiet", "type": "object" }, "ReliabilityLevelsReliabilityLevels": { "additionalProperties": false, "description": "Specify reliability levels at which the response values will be estimated", "properties": { "values": { "description": "Specify reliability levels at which the response values will be estimated", "items": { "type": "number" }, "title": "Values", "type": "array" }, "num_reliability_levels": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify which ``reliability_levels`` correspond to which response", "title": "Num Reliability Levels" } }, "required": [ "values" ], "title": "ReliabilityLevelsReliabilityLevels", "type": "object", "x-model-validations": [ { "validationContext": "reliabilitylevelsreliabilitylevels", "validationErrorMessage": "For reliabilitylevelsreliabilitylevels, sum of num_reliability_levels must equal length of values.", "validationFields": [ "num_reliability_levels", "values" ], "validationLiterals": [], "validationRuleName": "check_sum_equals_length" } ] }, "ResponseLevelsComputeProbRelGenCompute": { "additionalProperties": false, "description": "Selection of statistics to compute at each response level", "properties": { "statistic": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/ResponseLevelsComputeProbRelGenProbabilities" }, { "$ref": "#/$defs/ResponseLevelsComputeProbRelGenReliabilities" }, { "$ref": "#/$defs/ResponseLevelsComputeProbRelGenGenReliabilities" } ], "description": "Statistics to Compute", "title": "Statistic", "x-union-pattern": 4 }, "system": { "anyOf": [ { "$ref": "#/$defs/ResponseLevelsComputeProbRelGenSystemSeries" }, { "$ref": "#/$defs/ResponseLevelsComputeProbRelGenSystemParallel" }, { "type": "null" } ], "default": null, "description": "Compute system reliability (series or parallel)", "title": "System", "x-union-pattern": 2 } }, "required": [ "statistic" ], "title": "ResponseLevelsComputeProbRelGenCompute", "type": "object" }, "ResponseLevelsComputeProbRelGenGenReliabilities": { "additionalProperties": false, "description": "Computes generalized reliabilities associated with response levels", "properties": { "gen_reliabilities": { "const": true, "default": true, "description": "Computes generalized reliabilities associated with response levels", "title": "Gen Reliabilities", "type": "boolean", "x-materialization": [ { "ir_key": "method.nond.response_level_target", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "GEN_RELIABILITIES" } ] } }, "title": "ResponseLevelsComputeProbRelGenGenReliabilities", "type": "object" }, "ResponseLevelsComputeProbRelGenProbabilities": { "additionalProperties": false, "description": "Computes probabilities associated with response levels", "properties": { "probabilities": { "const": true, "default": true, "description": "Computes probabilities associated with response levels", "title": "Probabilities", "type": "boolean", "x-materialization": [ { "ir_key": "method.nond.response_level_target", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "PROBABILITIES" } ] } }, "title": "ResponseLevelsComputeProbRelGenProbabilities", "type": "object" }, "ResponseLevelsComputeProbRelGenReliabilities": { "additionalProperties": false, "description": "Computes reliabilities associated with response levels", "properties": { "reliabilities": { "const": true, "default": true, "description": "Computes reliabilities associated with response levels", "title": "Reliabilities", "type": "boolean", "x-materialization": [ { "ir_key": "method.nond.response_level_target", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "RELIABILITIES" } ] } }, "title": "ResponseLevelsComputeProbRelGenReliabilities", "type": "object" }, "ResponseLevelsComputeProbRelGenResponseLevels": { "additionalProperties": false, "description": "Values at which to estimate desired statistics for each response", "properties": { "values": { "description": "Values at which to estimate desired statistics for each response", "items": { "type": "number" }, "title": "Values", "type": "array" }, "num_response_levels": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Number of values at which to estimate desired statistics for each response", "title": "Num Response Levels" }, "compute": { "anyOf": [ { "$ref": "#/$defs/ResponseLevelsComputeProbRelGenCompute" }, { "type": "null" } ], "default": null, "description": "Selection of statistics to compute at each response level" } }, "required": [ "values" ], "title": "ResponseLevelsComputeProbRelGenResponseLevels", "type": "object", "x-model-validations": [ { "validationContext": "responselevelscomputeprobrelgenresponselevels", "validationErrorMessage": "For responselevelscomputeprobrelgenresponselevels, sum of num_response_levels must equal length of values.", "validationFields": [ "num_response_levels", "values" ], "validationLiterals": [], "validationRuleName": "check_sum_equals_length" } ] }, "ResponseLevelsComputeProbRelGenSystemParallel": { "additionalProperties": false, "description": "Aggregate response statistics assuming a parallel system", "properties": { "parallel": { "const": true, "default": true, "description": "Aggregate response statistics assuming a parallel system", "title": "Parallel", "type": "boolean", "x-materialization": [ { "ir_key": "method.nond.response_level_target_reduce", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "SYSTEM_PARALLEL" } ] } }, "title": "ResponseLevelsComputeProbRelGenSystemParallel", "type": "object" }, "ResponseLevelsComputeProbRelGenSystemSeries": { "additionalProperties": false, "description": "Aggregate response statistics assuming a series system", "properties": { "series": { "const": true, "default": true, "description": "Aggregate response statistics assuming a series system", "title": "Series", "type": "boolean", "x-materialization": [ { "ir_key": "method.nond.response_level_target_reduce", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "SYSTEM_SERIES" } ] } }, "title": "ResponseLevelsComputeProbRelGenSystemSeries", "type": "object" }, "Silent": { "additionalProperties": false, "description": "Level 1 of 5 - minimum", "properties": { "silent": { "const": true, "default": true, "description": "Level 1 of 5 - minimum", "title": "Silent", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "SILENT_OUTPUT" } ] } }, "title": "Silent", "type": "object" }, "Verbose": { "additionalProperties": false, "description": "Level 4 of 5 - more than normal", "properties": { "verbose": { "const": true, "default": true, "description": "Level 4 of 5 - more than normal", "title": "Verbose", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "VERBOSE_OUTPUT" } ] } }, "title": "Verbose", "type": "object" } }, "additionalProperties": false, "required": [ "import_points_file" ] }
- Fields:
gen_reliability_levels (dakota.spec.shared.misc.GenReliabilityLevelsGenReliabilityLevels | None)import_points_file (dakota.spec.method.import_points.ImportPointsImportPointsFile)probability_levels (dakota.spec.shared.misc.ProbabilityLevelsContext2ProbabilityLevels | None)reliability_levels (dakota.spec.shared.misc.ReliabilityLevelsReliabilityLevels | None)response_levels (dakota.spec.shared.core.ResponseLevelsComputeProbRelGenResponseLevels | None)tolerance_intervals (dakota.spec.method.import_points.ImportPointsTolIntervals | None)variance_based_decomp (dakota.spec.method.import_points.ImportPointsVarianceBasedDecomp | None)
- field distribution: DistributionCumulComplContext1Cumulative | DistributionCumulComplContext1Complementary [Optional]
Selection of cumulative or complementary cumulative functions
- field final_moments: DefaultFinalMomentsNoneKeyword | DefaultFinalMomentsStandard | DefaultFinalMomentsCentral [Optional]
Output moments of the specified type and include them within the set of final statistics.
- field final_solutions: int = 0
Number of designs returned as the best solutions
- Constraints:
ge = 0
- field gen_reliability_levels: GenReliabilityLevelsGenReliabilityLevels | None = None
Specify generalized relability levels at which to estimate the corresponding response value
- field id_method: str | None = None
Name the method block; helpful when there are multiple
- field import_points_file: ImportPointsImportPointsFile [Required]
File containing list of variable and response values to import for analysis.
- field model_pointer: str | None = None
Identifier for model block to be used by a method
- field output: Debug | Verbose | Normal | Quiet | Silent [Optional]
Control how much method information is written to the screen and output file
- field probability_levels: ProbabilityLevelsContext2ProbabilityLevels | None = None
Specify probability levels at which to estimate the corresponding response value
- field reliability_levels: ReliabilityLevelsReliabilityLevels | None = None
Specify reliability levels at which the response values will be estimated
- field response_levels: ResponseLevelsComputeProbRelGenResponseLevels | None = None
Values at which to estimate desired statistics for each response
- field std_regression_coeffs: Literal[True] | None = None
Output Standardized Regression Coefficients and R^2 for samples
- field tolerance_intervals: ImportPointsTolIntervals | None = None
Computes the double sided tolerance interval equivalent normal distribuion.
- field variance_based_decomp: ImportPointsVarianceBasedDecomp | None = None
Computes Sobol’ main effects using a binned approach
Generated Pydantic models for method.import_points
- pydantic model dakota.spec.method.import_points.ImportPointsFileAnnotatedConfig
Selects annotated tabular file format
Show JSON schema
{ "title": "ImportPointsFileAnnotatedConfig", "description": "Selects annotated tabular file format", "type": "object", "properties": { "use_variable_labels": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Validate/use variable labels from tabular file header", "title": "Use Variable Labels", "x-materialization": [ { "ir_key": "method.import_points.use_variable_labels", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "additionalProperties": false }
- field use_variable_labels: Literal[True] | None = None
Validate/use variable labels from tabular file header
- pydantic model dakota.spec.method.import_points.ImportPointsFileCustomAnnotatedHeader
Enable header row in custom-annotated tabular file
Show JSON schema
{ "title": "ImportPointsFileCustomAnnotatedHeader", "description": "Enable header row in custom-annotated tabular file", "type": "object", "properties": { "use_variable_labels": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Validate/use variable labels from tabular file header", "title": "Use Variable Labels", "x-materialization": [ { "ir_key": "method.import_points.use_variable_labels", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "additionalProperties": false }
- field use_variable_labels: Literal[True] | None = None
Validate/use variable labels from tabular file header
- pydantic model dakota.spec.method.import_points.ImportPointsImportPointsFile
File containing list of variable and response values to import for analysis.
Show JSON schema
{ "title": "ImportPointsImportPointsFile", "description": "File containing list of variable and response values to import for analysis.", "type": "object", "properties": { "filename": { "description": "File containing list of variable and response values to import for analysis.", "title": "Filename", "type": "string", "x-materialization": [ { "ir_key": "method.import_points_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "format": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/ImportPointsImportPointsFileCustomAnnotated" }, { "$ref": "#/$defs/ImportPointsImportPointsFileAnnotated" }, { "$ref": "#/$defs/ImportPointsImportPointsFileFreeform" } ], "description": "Tabular Format", "title": "Format", "x-model-default": "ImportPointsImportPointsFileAnnotated", "x-union-pattern": 1 }, "active_only": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Import only active variables from tabular data file", "title": "Active Only", "x-materialization": [ { "ir_key": "method.import_points.active_only", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "$defs": { "ImportPointsFileAnnotatedConfig": { "additionalProperties": false, "description": "Selects annotated tabular file format", "properties": { "use_variable_labels": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Validate/use variable labels from tabular file header", "title": "Use Variable Labels", "x-materialization": [ { "ir_key": "method.import_points.use_variable_labels", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ImportPointsFileAnnotatedConfig", "type": "object" }, "ImportPointsFileCustomAnnotatedHeader": { "additionalProperties": false, "description": "Enable header row in custom-annotated tabular file", "properties": { "use_variable_labels": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Validate/use variable labels from tabular file header", "title": "Use Variable Labels", "x-materialization": [ { "ir_key": "method.import_points.use_variable_labels", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ImportPointsFileCustomAnnotatedHeader", "type": "object" }, "ImportPointsImportPointsFileAnnotated": { "additionalProperties": false, "description": "Selects annotated tabular file format", "properties": { "annotated": { "$ref": "#/$defs/ImportPointsFileAnnotatedConfig", "x-materialization": [ { "ir_key": "method.import_points_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_ANNOTATED" } ], "x-model-default": "ImportPointsFileAnnotatedConfig" } }, "title": "ImportPointsImportPointsFileAnnotated", "type": "object" }, "ImportPointsImportPointsFileCustomAnnotated": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format", "properties": { "custom_annotated": { "$ref": "#/$defs/ImportPointsImportPointsFileCustomAnnotatedConfig", "x-materialization": [ { "ir_key": "method.import_points_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ], "x-model-default": "ImportPointsImportPointsFileCustomAnnotatedConfig" } }, "title": "ImportPointsImportPointsFileCustomAnnotated", "type": "object" }, "ImportPointsImportPointsFileCustomAnnotatedConfig": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format", "properties": { "header": { "anyOf": [ { "$ref": "#/$defs/ImportPointsFileCustomAnnotatedHeader" }, { "type": "null" } ], "default": null, "description": "Enable header row in custom-annotated tabular file", "x-materialization": [ { "ir_key": "method.import_points_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": "method.import_points_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": "method.import_points_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_IFACE_ID" } ] } }, "title": "ImportPointsImportPointsFileCustomAnnotatedConfig", "type": "object" }, "ImportPointsImportPointsFileFreeform": { "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": "method.import_points_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ] } }, "title": "ImportPointsImportPointsFileFreeform", "type": "object" } }, "additionalProperties": false, "required": [ "filename" ] }
- Fields:
- field active_only: Literal[True] | None = None
Import only active variables from tabular data file
- field filename: str [Required]
File containing list of variable and response values to import for analysis.
- field format: ImportPointsImportPointsFileCustomAnnotated | ImportPointsImportPointsFileAnnotated | ImportPointsImportPointsFileFreeform [Optional]
Tabular Format
- pydantic model dakota.spec.method.import_points.ImportPointsImportPointsFileAnnotated
Selects annotated tabular file format
Show JSON schema
{ "title": "ImportPointsImportPointsFileAnnotated", "description": "Selects annotated tabular file format", "type": "object", "properties": { "annotated": { "$ref": "#/$defs/ImportPointsFileAnnotatedConfig", "x-materialization": [ { "ir_key": "method.import_points_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_ANNOTATED" } ], "x-model-default": "ImportPointsFileAnnotatedConfig" } }, "$defs": { "ImportPointsFileAnnotatedConfig": { "additionalProperties": false, "description": "Selects annotated tabular file format", "properties": { "use_variable_labels": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Validate/use variable labels from tabular file header", "title": "Use Variable Labels", "x-materialization": [ { "ir_key": "method.import_points.use_variable_labels", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ImportPointsFileAnnotatedConfig", "type": "object" } }, "additionalProperties": false }
- field annotated: ImportPointsFileAnnotatedConfig [Optional]
Selects annotated tabular file format
- pydantic model dakota.spec.method.import_points.ImportPointsImportPointsFileCustomAnnotated
Selects custom-annotated tabular file format
Show JSON schema
{ "title": "ImportPointsImportPointsFileCustomAnnotated", "description": "Selects custom-annotated tabular file format", "type": "object", "properties": { "custom_annotated": { "$ref": "#/$defs/ImportPointsImportPointsFileCustomAnnotatedConfig", "x-materialization": [ { "ir_key": "method.import_points_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ], "x-model-default": "ImportPointsImportPointsFileCustomAnnotatedConfig" } }, "$defs": { "ImportPointsFileCustomAnnotatedHeader": { "additionalProperties": false, "description": "Enable header row in custom-annotated tabular file", "properties": { "use_variable_labels": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Validate/use variable labels from tabular file header", "title": "Use Variable Labels", "x-materialization": [ { "ir_key": "method.import_points.use_variable_labels", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ImportPointsFileCustomAnnotatedHeader", "type": "object" }, "ImportPointsImportPointsFileCustomAnnotatedConfig": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format", "properties": { "header": { "anyOf": [ { "$ref": "#/$defs/ImportPointsFileCustomAnnotatedHeader" }, { "type": "null" } ], "default": null, "description": "Enable header row in custom-annotated tabular file", "x-materialization": [ { "ir_key": "method.import_points_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": "method.import_points_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": "method.import_points_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_IFACE_ID" } ] } }, "title": "ImportPointsImportPointsFileCustomAnnotatedConfig", "type": "object" } }, "additionalProperties": false }
- field custom_annotated: ImportPointsImportPointsFileCustomAnnotatedConfig [Optional]
Selects custom-annotated tabular file format
- pydantic model dakota.spec.method.import_points.ImportPointsImportPointsFileCustomAnnotatedConfig
Selects custom-annotated tabular file format
Show JSON schema
{ "title": "ImportPointsImportPointsFileCustomAnnotatedConfig", "description": "Selects custom-annotated tabular file format", "type": "object", "properties": { "header": { "anyOf": [ { "$ref": "#/$defs/ImportPointsFileCustomAnnotatedHeader" }, { "type": "null" } ], "default": null, "description": "Enable header row in custom-annotated tabular file", "x-materialization": [ { "ir_key": "method.import_points_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": "method.import_points_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": "method.import_points_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_IFACE_ID" } ] } }, "$defs": { "ImportPointsFileCustomAnnotatedHeader": { "additionalProperties": false, "description": "Enable header row in custom-annotated tabular file", "properties": { "use_variable_labels": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Validate/use variable labels from tabular file header", "title": "Use Variable Labels", "x-materialization": [ { "ir_key": "method.import_points.use_variable_labels", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "ImportPointsFileCustomAnnotatedHeader", "type": "object" } }, "additionalProperties": false }
- Fields:
- field eval_id: Literal[True] | None = None
Enable evaluation ID column in custom-annotated tabular file
- field header: ImportPointsFileCustomAnnotatedHeader | 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.method.import_points.ImportPointsImportPointsFileFreeform
Selects freeform file format
Show JSON schema
{ "title": "ImportPointsImportPointsFileFreeform", "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": "method.import_points_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.method.import_points.ImportPointsTolIntervals
Computes the double sided tolerance interval equivalent normal distribuion.
Show JSON schema
{ "title": "ImportPointsTolIntervals", "description": "Computes the double sided tolerance interval equivalent normal distribuion.", "type": "object", "properties": { "coverage": { "default": 0.95, "description": "The coverage to be used for the calculation of the lower and upper ends of the interval covering the user supplied samples.", "maximum": 1, "minimum": 0, "title": "Coverage", "type": "number", "x-materialization": [ { "ir_key": "method.ti_coverage", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "confidence_level": { "default": 0.9, "description": "The confidence level to be used to determine the standard deviation of the equivalent normal distribution.", "maximum": 1, "minimum": 0, "title": "Confidence Level", "type": "number", "x-materialization": [ { "ir_key": "method.ti_confidence_level", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] } }, "additionalProperties": false }
- field confidence_level: DakotaFloat = 0.9
The confidence level to be used to determine the standard deviation of the equivalent normal distribution.
- Constraints:
ge = 0
le = 1
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
- field coverage: DakotaFloat = 0.95
The coverage to be used for the calculation of the lower and upper ends of the interval covering the user supplied samples.
- Constraints:
ge = 0
le = 1
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
- pydantic model dakota.spec.method.import_points.ImportPointsVarianceBasedDecomp
Computes Sobol’ main effects using a binned approach
Show JSON schema
{ "title": "ImportPointsVarianceBasedDecomp", "description": "Computes Sobol' main effects using a binned approach", "type": "object", "properties": { "drop_tolerance": { "default": -1.0, "description": "Suppresses output of sensitivity indices with values lower than this tolerance", "title": "Drop Tolerance", "type": "number", "x-materialization": [ { "ir_key": "method.vbd_drop_tolerance", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "num_bins": { "default": -1, "description": "Number of bins used to compute the variance-based decomposition", "title": "Num Bins", "type": "integer", "x-materialization": [ { "ir_key": "method.vbd_via_sampling_num_bins", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "additionalProperties": false }
- Fields:
- field drop_tolerance: DakotaFloat = -1.0
Suppresses output of sensitivity indices with values lower than this tolerance
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
- field num_bins: int = -1
Number of bins used to compute the variance-based decomposition
