alt.hst.api.api_objects Module#

enum AdaptiveFitDesignTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_MELS = <AdaptiveFitDesignTypes.TYPE_MELS: 'Mels'>#

TYPE_SOBOL = <AdaptiveFitDesignTypes.TYPE_SOBOL: 'Sobol'>#

TYPE_GP = <AdaptiveFitDesignTypes.TYPE_GP: 'GP'>#

TYPE_VOID = <AdaptiveFitDesignTypes.TYPE_VOID: 'Void'>#

class Approach(impl: Any)#

Bases: Item, Approach_Mixin

An Approach is a certain set of steps taken to study a design.

applySpecification() → None#: Apply the approach specifications.

createReports() → None#: Create all enabled reports for the approach.

exportAltairBinaryFormat(filePath: str) → None#

Export an Altair Binary Format report.

Parameters:: filePath (str) – The output path for the report.

generateApproachSpecificReports() → List[str]#

Generate reports that are specific to this Approach type.

Returns:: A list of paths to the generated reports.
Return type:: List[str]

generateFMUReport(filePath: str) → None#

Generate an FMU report.

Parameters:: filePath (str) – The output path for the report.

getApproachTool() → ApproachTool#

Get the value of the ApproachTool attribute.

Returns:: The object containing settings for a specific approach type.
Return type:: ApproachTool

See also

ApproachToolTypes

getApproachToolType() → ApproachToolTypes#

Returns:: The type of the ApproachTool attribute.
Return type:: ApproachToolTypes

getAvailableApproachToolTypes() → List[ApproachToolTypes]#

Get the available types for the ApproachTool attribute.

Returns:: A list of types for the ApproachTool attribute
Return type:: List[ApproachToolTypes]

getCommandCreateDesign() → bool#

Get the value of the CommandCreateDesign attribute.

Returns:: If True, the Approach specification will be applied before evaluation. This is ignored in the GUI.
Return type:: bool

getCommandCreateDesignAPI() → bool#

Get the value of the CommandCreateDesignAPI attribute.

Returns:: If True, the Aapproach specification will be applied before evaluation when used through the API.
Return type:: bool

getCommandCreateDesignBatch() → bool#

Get the value of the CommandCreateDesignBatch attribute.

Returns:: If True, the Approach specification will be applied before evaluation in batch.
Return type:: bool

getCommandCreatePeriodicReport() → bool#

Get the value of the CommandCreatePeriodicReport attribute.

Returns:: If True, periodic reports will be created during evaluation in the GUI.
Return type:: bool

getCommandCreatePeriodicReportAPI() → bool#

Get the value of the CommandCreatePeriodicReportAPI attribute.

Returns:: If True, periodic reports will be created during evaluation when used through the API.
Return type:: bool

getCommandCreatePeriodicReportBatch() → bool#

Get the value of the CommandCreatePeriodicReportBatch attribute.

Returns:: If True, periodic reports will be created during evaluation in batch.
Return type:: bool

getCommandCreateReport() → bool#

Get the value of the CommandCreateReport attribute.

Returns:: If True, reports will be created during evaluation in the GUI.
Return type:: bool

getCommandCreateReportAPI() → bool#

Get the value of the CommandCreateReportAPI attribute.

Returns:: If True, reports will be created during evaluation when used through the API.
Return type:: bool

getCommandCreateReportBatch() → bool#

Get the value of the CommandCreateReportBatch attribute.

Returns:: If True, reports will be created during evaluation in batch.
Return type:: bool

getCommandExecuteAnalysis() → bool#

Get the value of the CommandExecuteAnalysis attribute.

Returns:: If True, the solver will be executed during evaluation in the GUI.
Return type:: bool

getCommandExecuteAnalysisAPI() → bool#

Get the value of the CommandExecuteAnalysisAPI attribute.

Returns:: If True, the solver will be executed during evaluation when used through the API.
Return type:: bool

getCommandExecuteAnalysisBatch() → bool#

Get the value of the CommandExecuteAnalysisBatch attribute.

Returns:: If True, the solver will be executed during evaluation in batch.
Return type:: bool

getCommandExtractResponses() → bool#

Get the value of the CommandExtractResponses attribute.

Returns:: If True, Responses and Data Sources will be extracted during evaluation in the GUI.
Return type:: bool

getCommandExtractResponsesAPI() → bool#

Get the value of the CommandExtractResponsesAPI attribute.

Returns:: If True, Responses and Data Sources will be extracted during evaluation when used through the API.
Return type:: bool

getCommandExtractResponsesBatch() → bool#

Get the value of the CommandExtractResponsesBatch attribute.

Returns:: If True, Responses and Data sources will be extracted during evaluation in batch.
Return type:: bool

getCommandImportModels() → bool#

Get the value of the CommandImportModels attribute.

Returns:: If True, Models will be imported during evaluation in the GUI.
Return type:: bool

getCommandImportModelsAPI() → bool#

Get the value of the CommandImportModelsAPI attribute.

Returns:: If True, Models will be imported during evaluation when used through the API.
Return type:: bool

getCommandImportModelsBatch() → bool#

Get the value of the CommandImportModelsBatch attribute.

Returns:: If True, Models will be imported during evaluation in batch.
Return type:: bool

getCommandList() → CommandList#

Get the value of the CommandList attribute.

Returns:: The list of Command Items.
Return type:: CommandList

See also

Command

getCommandPurge() → bool#

Get the value of the CommandPurge attribute.

Returns:: If True, files or folders marked for purging will be deleted at the end of the evaluation in the GUI.
Return type:: bool

getCommandPurgeAPI() → bool#

Get the value of the CommandPurgeAPI attribute.

Returns:: If True, files or folders marked for purging will be deleted at the end of the evaluation when used through the API.
Return type:: bool

getCommandPurgeBatch() → bool#

Get the value of the CommandPurgeBatch attribute.

Returns:: If True, files or folders marked for purging will be deleted at the end of the evaluation in batch.
Return type:: bool

getCommandWriteInputDecks() → bool#

Get the value of the CommandWriteInputDecks attribute.

Returns:: If True, solver input decks will be written during evaluation in the GUI.
Return type:: bool

getCommandWriteInputDecksAPI() → bool#

Get the value of the CommandWriteInputDecksAPI attribute.

Returns:: If True, solver input decks will be written during evaluation when used through the API.
Return type:: bool

getCommandWriteInputDecksBatch() → bool#

Get the value of the CommandWriteInputDecksBatch attribute.

Returns:: If True, solver input decks will be written during evaluation in batch.
Return type:: bool

getDefinition() → SetupContext#

Get the value of the Definition attribute.

Returns:: The configuration for the approach, including Input Variables, Output Responses, Gradients, Goals, Contraints, Media Sources, evaluation settings, and more.
Return type:: SetupContext

getDepot() → Depot#

getDesignInitialized() → bool#

Get the value of the DesignInitialized attribute.

Returns:: If True, the Approach’s design has been created and initialized.
Return type:: bool

getDesignVarname() → str#

Get the value of the DesignVarname attribute.

Returns:: The varname of the design. Valid choices will depend on the specific type of Approach.
Return type:: str

See also

VerifyDesignTypes
StochasticDesignTypes
OptimizationDesignTypes
NominalDesignTypes
AdaptiveFitDesignTypes
DoeDesignTypes
BasicDesignTypes

getDiffDefinitions() → str#

Get the value of the DiffDefinitions attribute.

Returns:: This attribute is meant for internal use.
Return type:: str

getDirectory() → str#

Get the value of the Directory attribute.

Returns:: The directory containing approach specific files and folders. All run directories are contained in this directory.
Return type:: str

getEvaluationParameterList() → EvaluationParameterList#

Get the value of the EvaluationParameterList attribute.

Returns:: The list of EvaluationParameter Objects.
Return type:: EvaluationParameterList

See also

EvaluationParameter

getIsEvaluating() → bool#

Get the value of the IsEvaluating attribute.

Returns:: If True, the Approach is currently evaluating.
Return type:: bool

getMatrixFilterList() → FrameFilterList#

Get the value of the MatrixFilterList attribute.

Returns:: The list of FrameFilter Items.
Return type:: FrameFilterList

See also

FrameFilter

getMatrixList() → FrameList#

Get the value of the MatrixList attribute.

Returns:: The list of Matrix Items.
Return type:: FrameList

See also

Frame

getPriority() → int#

Get the value of the Priority attribute.

Returns:: Indicates the order in which approaches are evaluated. Could be N/A.
Return type:: int

getReportList() → ReportList#

Get the value of the ReportList attribute.

Returns:: The list of Report Items.
Return type:: ReportList

See also

Report

getSymbolicDirectory() → str#

Get the value of the SymbolicDirectory attribute.

Returns:: The approach directory as a URI.
Return type:: str

getTool() → str#

Get the value of the Tool attribute.

Returns:

The name of the current Approach Tool type.

Nom A nominal approach, also called a setup approach, is used to configure the fundamental approach configuration that will be used or extended by other approaches.
Basic A Basic approach can be used to test nominal values and bounds by performing a nominal run, system bound check, or sweep.
Doe A DOE is a series of tests in which purposeful changes are made to the input variables to investigate their effect upon the output responses and to get an understanding of the global behavior of a design problem.
Fit A Fit is a mathematical model that is trained by data and is capable of predicting output response variables for a given set of input variables.
AdaptiveFit A Sampling Fit is a combination of space
Opt An Optimization is a mathematical procedure used to determine the best design for a set of given constraints, by changing the input variables in an automatic manner.
Sto A Stochastic approach is a method of probabilistic analysis where the input variables are defined by a probability distribution, and consequently the corresponding output responses are not a single deterministic value, but a distribution.
Verify A Verification approach compares two data sets in a side by side comparison.

Return type:

str

See also

ApproachTool

importVariables() → bool#

Import Variables, Responses, and Data Sources for all models.

Returns:: True if all the Models were imported successfully.
Return type:: bool

setApproachToolType(value: ApproachToolTypes) → None#

Parameters:: value (ApproachToolTypes) – The type of the ApproachTool attribute.
Returns:: None

setCommandCreateDesign(value: bool) → None#

Set the value of the CommandCreateDesign attribute.

Parameters:: value (bool) – If True, the Approach specification will be applied before evaluation. This is ignored in the GUI.

setCommandCreateDesignAPI(value: bool) → None#

Set the value of the CommandCreateDesignAPI attribute.

Parameters:: value (bool) – If True, the Aapproach specification will be applied before evaluation when used through the API.

setCommandCreateDesignBatch(value: bool) → None#

Set the value of the CommandCreateDesignBatch attribute.

Parameters:: value (bool) – If True, the Approach specification will be applied before evaluation in batch.

setCommandCreatePeriodicReport(value: bool) → None#

Set the value of the CommandCreatePeriodicReport attribute.

Parameters:: value (bool) – If True, periodic reports will be created during evaluation in the GUI.

setCommandCreatePeriodicReportAPI(value: bool) → None#

Set the value of the CommandCreatePeriodicReportAPI attribute.

Parameters:: value (bool) – If True, periodic reports will be created during evaluation when used through the API.

setCommandCreatePeriodicReportBatch(value: bool) → None#

Set the value of the CommandCreatePeriodicReportBatch attribute.

Parameters:: value (bool) – If True, periodic reports will be created during evaluation in batch.

setCommandCreateReport(value: bool) → None#

Set the value of the CommandCreateReport attribute.

Parameters:: value (bool) – If True, reports will be created during evaluation in the GUI.

setCommandCreateReportAPI(value: bool) → None#

Set the value of the CommandCreateReportAPI attribute.

Parameters:: value (bool) – If True, reports will be created during evaluation when used through the API.

setCommandCreateReportBatch(value: bool) → None#

Set the value of the CommandCreateReportBatch attribute.

Parameters:: value (bool) – If True, reports will be created during evaluation in batch.

setCommandExecuteAnalysis(value: bool) → None#

Set the value of the CommandExecuteAnalysis attribute.

Parameters:: value (bool) – If True, the solver will be executed during evaluation in the GUI.

setCommandExecuteAnalysisAPI(value: bool) → None#

Set the value of the CommandExecuteAnalysisAPI attribute.

Parameters:: value (bool) – If True, the solver will be executed during evaluation when used through the API.

setCommandExecuteAnalysisBatch(value: bool) → None#

Set the value of the CommandExecuteAnalysisBatch attribute.

Parameters:: value (bool) – If True, the solver will be executed during evaluation in batch.

setCommandExtractResponses(value: bool) → None#

Set the value of the CommandExtractResponses attribute.

Parameters:: value (bool) – If True, Responses and Data Sources will be extracted during evaluation in the GUI.

setCommandExtractResponsesAPI(value: bool) → None#

Set the value of the CommandExtractResponsesAPI attribute.

Parameters:: value (bool) – If True, Responses and Data Sources will be extracted during evaluation when used through the API.

setCommandExtractResponsesBatch(value: bool) → None#

Set the value of the CommandExtractResponsesBatch attribute.

Parameters:: value (bool) – If True, Responses and Data sources will be extracted during evaluation in batch.

setCommandImportModels(value: bool) → None#

Set the value of the CommandImportModels attribute.

Parameters:: value (bool) – If True, Models will be imported during evaluation in the GUI.

setCommandImportModelsAPI(value: bool) → None#

Set the value of the CommandImportModelsAPI attribute.

Parameters:: value (bool) – If True, Models will be imported during evaluation when used through the API.

setCommandImportModelsBatch(value: bool) → None#

Set the value of the CommandImportModelsBatch attribute.

Parameters:: value (bool) – If True, Models will be imported during evaluation in batch.

setCommandPurge(value: bool) → None#

Set the value of the CommandPurge attribute.

Parameters:: value (bool) – If True, files or folders marked for purging will be deleted at the end of the evaluation in the GUI.

setCommandPurgeAPI(value: bool) → None#

Set the value of the CommandPurgeAPI attribute.

Parameters:: value (bool) – If True, files or folders marked for purging will be deleted at the end of the evaluation when used through the API.

setCommandPurgeBatch(value: bool) → None#

Set the value of the CommandPurgeBatch attribute.

Parameters:: value (bool) – If True, files or folders marked for purging will be deleted at the end of the evaluation in batch.

setCommandWriteInputDecks(value: bool) → None#

Set the value of the CommandWriteInputDecks attribute.

Parameters:: value (bool) – If True, solver input decks will be written during evaluation in the GUI.

setCommandWriteInputDecksAPI(value: bool) → None#

Set the value of the CommandWriteInputDecksAPI attribute.

Parameters:: value (bool) – If True, solver input decks will be written during evaluation when used through the API.

setCommandWriteInputDecksBatch(value: bool) → None#

Set the value of the CommandWriteInputDecksBatch attribute.

Parameters:: value (bool) – If True, solver input decks will be written during evaluation in batch.

setDesignVarname(value: str) → None#

Set the value of the DesignVarname attribute.

Parameters:: value (str) – The varname of the design. Valid choices will depend on the specific type of Approach.

See also

VerifyDesignTypes
StochasticDesignTypes
OptimizationDesignTypes
NominalDesignTypes
AdaptiveFitDesignTypes
DoeDesignTypes
BasicDesignTypes

setDiffDefinitions(value: str) → None#

Set the value of the DiffDefinitions attribute.

Parameters:: value (str) – This attribute is meant for internal use.

setIsEvaluating(value: bool) → None#

Set the value of the IsEvaluating attribute.

Parameters:: value (bool) – If True, the Approach is currently evaluating.

setTool(value: str) → None#

Set the value of the Tool attribute.

Parameters:

value (str) –

The name of the current Approach Tool type.

Nom A nominal approach, also called a setup approach, is used to configure the fundamental approach configuration that will be used or extended by other approaches.
Basic A Basic approach can be used to test nominal values and bounds by performing a nominal run, system bound check, or sweep.
Doe A DOE is a series of tests in which purposeful changes are made to the input variables to investigate their effect upon the output responses and to get an understanding of the global behavior of a design problem.
Fit A Fit is a mathematical model that is trained by data and is capable of predicting output response variables for a given set of input variables.
AdaptiveFit A Sampling Fit is a combination of space
Opt An Optimization is a mathematical procedure used to determine the best design for a set of given constraints, by changing the input variables in an automatic manner.
Sto A Stochastic approach is a method of probabilistic analysis where the input variables are defined by a probability distribution, and consequently the corresponding output responses are not a single deterministic value, but a distribution.
Verify A Verification approach compares two data sets in a side by side comparison.

See also

ApproachTool

startEvaluate() → bool#

Start the evaluation of all models.

Returns:: True if the Approach evaluation completed successfully.
Return type:: bool

stopAllEvaluate() → bool#

Stop all evaluations without starting evaluations for the next approach.

Returns:: True if evaluations were stopped successfully.
Return type:: bool

stopEvaluate() → bool#

Stop all evaluations, then start evaluating the next approach.

Returns:: True if evaluations were stopped successfully.
Return type:: bool

class ApproachList(impl: Any)#

Bases: ItemList[Approach], DefaultMixin

The list of Approach instances.

class ApproachTool(impl: Any)#

Bases: Object, DefaultMixin

The tool Object that defines the behavior of its parent Approach.

getDesignVarname() → str#

Get the value of the DesignVarname attribute.

Returns:: The varname of the design. Valid choices will depend on the specific type of Approach.
Return type:: str

See also

VerifyDesignTypes
StochasticDesignTypes
OptimizationDesignTypes
NominalDesignTypes
AdaptiveFitDesignTypes
DoeDesignTypes
BasicDesignTypes
Fit_Parameters.getPerturbationVarname

setDesignVarname(value: str) → None#

Set the value of the DesignVarname attribute.

Parameters:: value (str) – The varname of the design. Valid choices will depend on the specific type of Approach.

See also

VerifyDesignTypes
StochasticDesignTypes
OptimizationDesignTypes
NominalDesignTypes
AdaptiveFitDesignTypes
DoeDesignTypes
BasicDesignTypes
Fit_Parameters.getPerturbationVarname

enum ApproachToolTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_NOM = <ApproachToolTypes.TYPE_NOM: 'Nom'>#

TYPE_DOE = <ApproachToolTypes.TYPE_DOE: 'Doe'>#

TYPE_FIT = <ApproachToolTypes.TYPE_FIT: 'Fit'>#

TYPE_ADAPTIVEFIT = <ApproachToolTypes.TYPE_ADAPTIVEFIT: 'AdaptiveFit'>#

TYPE_OPT = <ApproachToolTypes.TYPE_OPT: 'Opt'>#

TYPE_STO = <ApproachToolTypes.TYPE_STO: 'Sto'>#

TYPE_BASIC = <ApproachToolTypes.TYPE_BASIC: 'Basic'>#

TYPE_VERIFY = <ApproachToolTypes.TYPE_VERIFY: 'Verify'>#

class ApproachTool_AdaptiveFit(impl: Any)#

Bases: ApproachTool_Fit, DefaultMixin

A Sampling Fit is a combination of space-filling DOE method and fit model trained by the data generated.

getAvailableDesignTypes() → List[AdaptiveFitDesignTypes]#

Get the available types for the Design attribute.

Returns:: A list of types for the Design attribute
Return type:: List[AdaptiveFitDesignTypes]

getDesign() → PerturbationBase#

Get the value of the Design attribute.

Returns:: The design configuration for the Approach.
Return type:: PerturbationBase

See also

AdaptiveFitDesignTypes

getDesignType() → AdaptiveFitDesignTypes#

Returns:: The type of the Design attribute.
Return type:: AdaptiveFitDesignTypes

setDesignType(value: AdaptiveFitDesignTypes) → None#

Parameters:: value (AdaptiveFitDesignTypes) – The type of the Design attribute.
Returns:: None

class ApproachTool_Basic(impl: Any)#

Bases: ApproachTool, DefaultMixin

A Basic approach can be used to test nominal values and bounds by performing a nominal run, system bound check, or sweep.

getAvailableDesignTypes() → List[BasicDesignTypes]#

Get the available types for the Design attribute.

Returns:: A list of types for the Design attribute
Return type:: List[BasicDesignTypes]

getDesign() → PerturbationBase#

Get the value of the Design attribute.

Returns:: The design configuration for the Approach.
Return type:: PerturbationBase

See also

BasicDesignTypes

getDesignType() → BasicDesignTypes#

Returns:: The type of the Design attribute.
Return type:: BasicDesignTypes

setDesignType(value: BasicDesignTypes) → None#

Parameters:: value (BasicDesignTypes) – The type of the Design attribute.
Returns:: None

class ApproachTool_Doe(impl: Any)#

Bases: ApproachTool, DefaultMixin

A DOE is a series of tests in which purposeful changes are made to the input variables to investigate their effect upon the output responses and to get an understanding of the global behavior of a design problem.

getAvailableDesignTypes() → List[DoeDesignTypes]#

Get the available types for the Design attribute.

Returns:: A list of types for the Design attribute
Return type:: List[DoeDesignTypes]

getAvailableUncontrolledDesignTypes() → List[UncontrolledDesignTypes]#

Get the available types for the UncontrolledDesign attribute.

Returns:: A list of types for the UncontrolledDesign attribute
Return type:: List[UncontrolledDesignTypes]

getDesign() → PerturbationBase#

Get the value of the Design attribute.

Returns:: The design configuration for the Approach.
Return type:: PerturbationBase

See also

DoeDesignTypes

getDesignType() → DoeDesignTypes#

Returns:: The type of the Design attribute.
Return type:: DoeDesignTypes

getUncontrolledDesign() → PerturbationBase#

Get the value of the UncontrolledDesign attribute.

Returns:: Object containing properties for an uncontrolled design.
Return type:: PerturbationBase

getUncontrolledDesignType() → UncontrolledDesignTypes#

Returns:: The type of the UncontrolledDesign attribute.
Return type:: UncontrolledDesignTypes

getUncontrolledPerturbationVarname() → str#

Get the value of the UncontrolledPerturbationVarname attribute.

Returns:: Varname of uncontrolled DOE type.
Return type:: str

setDesignType(value: DoeDesignTypes) → None#

Parameters:: value (DoeDesignTypes) – The type of the Design attribute.
Returns:: None

setUncontrolledDesignType(value: UncontrolledDesignTypes) → None#

Parameters:: value (UncontrolledDesignTypes) – The type of the UncontrolledDesign attribute.
Returns:: None

setUncontrolledPerturbationVarname(value: str) → None#

Set the value of the UncontrolledPerturbationVarname attribute.

Parameters:: value (str) – Varname of uncontrolled DOE type.

class ApproachTool_Fit(impl: Any)#

Bases: ApproachTool, DefaultMixin

Base class for other Fit Approach Tool classes.

getCrossValidation() → FitCrossValidationSettings#

Get the value of the CrossValidation attribute.

Returns:: The configuration for performing cross validation on the fit.
Return type:: FitCrossValidationSettings

getDesignList() → FitList#

Get the value of the DesignList attribute.

Returns:: The list of Fit Items.
Return type:: FitList

See also

Fit

class ApproachTool_Nominal(impl: Any)#

Bases: ApproachTool, DefaultMixin

A nominal approach, also called a setup approach, is used to configure the fundamental approach configuration that will be used or extended by other approaches.

getAvailableDesignTypes() → List[NominalDesignTypes]#

Get the available types for the Design attribute.

Returns:: A list of types for the Design attribute
Return type:: List[NominalDesignTypes]

getDesign() → PerturbationBase#

Get the value of the Design attribute.

Returns:: The design configuration for the Approach.
Return type:: PerturbationBase

See also

NominalDesignTypes

getDesignType() → NominalDesignTypes#

Returns:: The type of the Design attribute.
Return type:: NominalDesignTypes

setDesignType(value: NominalDesignTypes) → None#

Parameters:: value (NominalDesignTypes) – The type of the Design attribute.
Returns:: None

class ApproachTool_Optimization(impl: Any)#

Bases: ApproachTool, DefaultMixin

A procedure to determine the best possible design for a set of given constraints by changing the input variables in a defined manner.

getAvailableDesignTypes() → List[OptimizationDesignTypes]#

Get the available types for the Design attribute.

Returns:: A list of types for the Design attribute
Return type:: List[OptimizationDesignTypes]

getDesign() → PerturbationBase#

Get the value of the Design attribute.

Returns:: The design configuration for the Approach.
Return type:: PerturbationBase

See also

OptimizationDesignTypes

getDesignType() → OptimizationDesignTypes#

Returns:: The type of the Design attribute.
Return type:: OptimizationDesignTypes

setDesignType(value: OptimizationDesignTypes) → None#

Parameters:: value (OptimizationDesignTypes) – The type of the Design attribute.
Returns:: None

class ApproachTool_StaticFit(impl: Any)#

Bases: ApproachTool_Fit, DefaultMixin

It is used to construct a reduced order model that best fits to a dataset. This function then can be used instead of the exact solvers in other approaches to save computational resources.

class ApproachTool_Stochastics(impl: Any)#

Bases: ApproachTool, DefaultMixin

It is used to assess the reliability of a design based on given Response thresholds.

getAvailableDesignTypes() → List[StochasticDesignTypes]#

Get the available types for the Design attribute.

Returns:: A list of types for the Design attribute
Return type:: List[StochasticDesignTypes]

getDesign() → PerturbationBase#

Get the value of the Design attribute.

Returns:: The design configuration for the Approach.
Return type:: PerturbationBase

See also

StochasticDesignTypes

getDesignType() → StochasticDesignTypes#

Returns:: The type of the Design attribute.
Return type:: StochasticDesignTypes

getReliabilityList() → StochasticReliabilityList#

Get the value of the ReliabilityList attribute.

Returns:: The list of StochasticReliability Items.
Return type:: StochasticReliabilityList

See also

StochasticReliability

setDesignType(value: StochasticDesignTypes) → None#

Parameters:: value (StochasticDesignTypes) – The type of the Design attribute.
Returns:: None

class ApproachTool_Test(impl: Any)#

Bases: ApproachTool, DefaultMixin

A special Approach Tool used by a standard Approach’s Definition to evaluate a single test run.

getDesign() → PerturbationBase#

Get the value of the Design attribute.

Returns:: The design configuration for the Approach.
Return type:: PerturbationBase

class ApproachTool_Verify(impl: Any)#

Bases: ApproachTool, DefaultMixin

Parameter study to verify the quality of a response surface. A Verification approach compares two data sets in a side by side comparison.

getAvailableDesignTypes() → List[VerifyDesignTypes]#

Get the available types for the Design attribute.

Returns:: A list of types for the Design attribute
Return type:: List[VerifyDesignTypes]

getDesign() → PerturbationBase#

Get the value of the Design attribute.

Returns:: The design configuration for the Approach.
Return type:: PerturbationBase

See also

VerifyDesignTypes

getDesignType() → VerifyDesignTypes#

Returns:: The type of the Design attribute.
Return type:: VerifyDesignTypes

setDesignType(value: VerifyDesignTypes) → None#

Parameters:: value (VerifyDesignTypes) – The type of the Design attribute.
Returns:: None

class Approach_Standard(impl: Any)#

Bases: Approach, DefaultMixin

A normal Approach that might be a fit, optimization, DOE, or other type.

class Approach_Test(impl: Any)#

Bases: Approach, DefaultMixin

A special Approach used by a standard Approach’s Definition to evaluate a single test run.

enum BasicDesignTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_NOM = <BasicDesignTypes.TYPE_NOM: 'Nom'>#

TYPE_CHK = <BasicDesignTypes.TYPE_CHK: 'Chk'>#

TYPE_SWEEP = <BasicDesignTypes.TYPE_SWEEP: 'Sweep'>#

TYPE_DOPT = <BasicDesignTypes.TYPE_DOPT: 'DOpt'>#

TYPE_FULLFACT = <BasicDesignTypes.TYPE_FULLFACT: 'FullFact'>#

TYPE_CCD = <BasicDesignTypes.TYPE_CCD: 'Ccd'>#

TYPE_FRACFACT = <BasicDesignTypes.TYPE_FRACFACT: 'FracFact'>#

TYPE_PLACKBURM = <BasicDesignTypes.TYPE_PLACKBURM: 'PlackBurm'>#

TYPE_BOX = <BasicDesignTypes.TYPE_BOX: 'Box'>#

TYPE_HAMMERSLEY = <BasicDesignTypes.TYPE_HAMMERSLEY: 'Hammersley'>#

TYPE_LATINHYPERCUBE = <BasicDesignTypes.TYPE_LATINHYPERCUBE: 'LatinHyperCube'>#

TYPE_MELS = <BasicDesignTypes.TYPE_MELS: 'Mels'>#

TYPE_SOBOL = <BasicDesignTypes.TYPE_SOBOL: 'Sobol'>#

TYPE_RUNMATRIX = <BasicDesignTypes.TYPE_RUNMATRIX: 'RunMatrix'>#

TYPE_USER = <BasicDesignTypes.TYPE_USER: 'User'>#

TYPE_TAGUCHI = <BasicDesignTypes.TYPE_TAGUCHI: 'Taguchi'>#

TYPE_INITIAL = <BasicDesignTypes.TYPE_INITIAL: 'Initial'>#

TYPE_EMPTY = <BasicDesignTypes.TYPE_EMPTY: 'Empty'>#

TYPE_FILLRANDOM = <BasicDesignTypes.TYPE_FILLRANDOM: 'FillRandom'>#

TYPE_FILLSTATISTICS = <BasicDesignTypes.TYPE_FILLSTATISTICS: 'FillStatistics'>#

TYPE_SIMPLE = <BasicDesignTypes.TYPE_SIMPLE: 'Simple'>#

TYPE_VOID = <BasicDesignTypes.TYPE_VOID: 'Void'>#

class Command(impl: Any)#

Bases: Item, DefaultMixin

A command or task that will be run during an Approach evaluation.

getArgumentList() → CommandArgumentList#

Get the value of the ArgumentList attribute.

Returns:: The list of Argument Items.
Return type:: CommandArgumentList

See also

CommandArgument

getArguments() → str#

Get the value of the Arguments attribute.

Returns:: All of the command arguments as a single string. This is a special internal format that must be followed exactly. Recommended use here is to save all the arguments by copying this value and using it to set the arguments on a different command.
Return type:: str

getStateAPI() → bool#

Get the value of the StateAPI attribute.

Returns:: If True, the Command will be run in batch mode and the GUI.
Return type:: bool

getStateBatch() → bool#

Get the value of the StateBatch attribute.

Returns:: If True, the Command will be run in batch mode.
Return type:: bool

getStateUserInterface() → bool#

Get the value of the StateUserInterface attribute.

Returns:: If True, the command will be run in the GUI.
Return type:: bool

setArguments(value: str) → None#

Set the value of the Arguments attribute.

Parameters:: value (str) – All of the command arguments as a single string. This is a special internal format that must be followed exactly. Recommended use here is to save all the arguments by copying this value and using it to set the arguments on a different command.

setStateAPI(value: bool) → None#

Set the value of the StateAPI attribute.

Parameters:: value (bool) – If True, the Command will be run in batch mode and the GUI.

setStateBatch(value: bool) → None#

Set the value of the StateBatch attribute.

Parameters:: value (bool) – If True, the Command will be run in batch mode.

setStateUserInterface(value: bool) → None#

Set the value of the StateUserInterface attribute.

Parameters:: value (bool) – If True, the command will be run in the GUI.

class CommandArgument(impl: Any)#

Bases: Item, DefaultMixin

An argument for a Command instance.

getValue() → str#

Get the value of the Value attribute.

Returns:: The current value for the command argument.
Return type:: str

setValue(value: str) → None#

Set the value of the Value attribute.

Parameters:: value (str) – The current value for the command argument.

class CommandArgumentList(impl: Any)#

Bases: ItemList[CommandArgument], DefaultMixin

A list of CommandArgument instances.

class CommandList(impl: Any)#

Bases: ItemList[Command], DefaultMixin

A list of Command instances.

class Condition(impl: Any)#

Bases: DefinitionItem, DefaultMixin

In a multi-model study environment, evaluation of models can be conditional, or the run sequence may be different than the order of model IDs.

getAvailableConditionToolTypes() → List[ConditionToolTypes]#

Get the available types for the ConditionTool attribute.

Returns:: A list of types for the ConditionTool attribute
Return type:: List[ConditionToolTypes]

getConditionTool() → ConditionTool#

Get the value of the ConditionTool attribute.

Returns:: The tool object that defines the setting for the specific condition type.
Return type:: ConditionTool

See also

ConditionToolTypes

getConditionToolType() → ConditionToolTypes#

Returns:: The type of the ConditionTool attribute.
Return type:: ConditionToolTypes

getModel() → str#

Get the value of the Model attribute.

Returns:: The unique identifier of the Model to apply the condition to.
Return type:: str

getToolSpecifics() → str#

Get the value of the ToolSpecifics attribute.

Returns:: The settings for the Condition Tool as a string.
Return type:: str

See also

ConditionTool

getType() → str#

Get the value of the Type attribute.

Returns:: The type of Condition.
Return type:: str

setConditionToolType(value: ConditionToolTypes) → None#

Parameters:: value (ConditionToolTypes) – The type of the ConditionTool attribute.
Returns:: None

setModel(value: str) → None#

Set the value of the Model attribute.

Parameters:: value (str) – The unique identifier of the Model to apply the condition to.

setToolSpecifics(value: str) → None#

Set the value of the ToolSpecifics attribute.

Parameters:: value (str) – The settings for the Condition Tool as a string.

See also

ConditionTool

setType(value: str) → None#

Set the value of the Type attribute.

Parameters:: value (str) – The type of Condition.

class ConditionList(impl: Any)#

Bases: DefinitionItemList[Condition], DefaultMixin

A list of Condition instances.

class ConditionTool(impl: Any)#

Bases: Object, DefaultMixin

The tool Object that defines the behavior of its parent Condition.

enum ConditionToolTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_FILEEXISTS = <ConditionToolTypes.TYPE_FILEEXISTS: 'FileExists'>#

TYPE_IGNOREDEPENDENCIES = <ConditionToolTypes.TYPE_IGNOREDEPENDENCIES: 'IgnoreDependencies'>#

TYPE_RUNAFTER = <ConditionToolTypes.TYPE_RUNAFTER: 'RunAfter'>#

class ConditionTool_FileExists(impl: Any)#

Bases: ConditionTool, DefaultMixin

Execution of the model depends on the existence of a user-specified file.

getFile() → str#

Get the value of the File attribute.

Returns:: The path of the file to check for before running the referenced model.
Return type:: str

setFile(value: str) → None#

Set the value of the File attribute.

Parameters:: value (str) – The path of the file to check for before running the referenced model.

class ConditionTool_IgnoreDependencies(impl: Any)#

Bases: ConditionTool, DefaultMixin

In HyperStudy, a model is expected to provide an output whether it is a file to be used in another model as input or a simple numerical result indicating the performance of a system. Otherwise, the model is never executed. This option eliminates the output requirement.

class ConditionTool_RunAfter(impl: Any)#

Bases: ConditionTool, DefaultMixin

This changes the execution order. It runs the model after a user-specified model.

getModelVarname() → str#

Get the value of the ModelVarname attribute.

Returns:: The unique identifier of the Model that should be run before this model.
Return type:: str

setModelVarname(value: str) → None#

Set the value of the ModelVarname attribute.

Parameters:: value (str) – The unique identifier of the Model that should be run before this model.

class Constraint(impl: Any)#

Bases: DefinitionItem, DefaultMixin

A type of Goal that needs to be satisfied for an optimization to be acceptable. Constraints may also be associated with a DOE. While not used in the evaluation of the DOE, constraints can be useful while visualizing DOE results. Limits on displacement or stress are common examples.

Get the value of the CombinedPassRate attribute.

Returns:: The percentage of total design points that satisfy all previous Constraints including this one.
Return type:: hstApiVariant

getComparisonType() → str#

Get the value of the ComparisonType attribute.

Returns:

The operator used to compare the left and right expressions to determine if the Constraint is violated or not.

<= The evaluated left expression must be less than or equal to the evaluated right expression.
>= The evaluated left expression must be greater than or equal to the evaluated right expression.

Return type:

str

getLeftExpression() → str#

Get the value of the LeftExpression attribute.

Returns:: Left side of the constraint expression.
Return type:: str

Get the value of the PassRate attribute.

Returns:: Pass rate of an input constraint in percent.
Return type:: hstApiVariant

getRightExpression() → str#

Get the value of the RightExpression attribute.

Returns:: The right-hand side expression for the constraint as a string.
Return type:: str

Get the value of the TestRunValue attribute.

Returns:: The Test Approach value.
Return type:: hstApiVariant

Get the value of the TestRunValueLeft attribute.

Returns:: The Test Approach left side value.
Return type:: hstApiVariant

Get the value of the TestRunValueRight attribute.

Returns:: The Test Approach right side value.
Return type:: hstApiVariant

setComparisonType(value: str) → None#

Set the value of the ComparisonType attribute.

Parameters:

value (str) –

The operator used to compare the left and right expressions to determine if the Constraint is violated or not.

<= The evaluated left expression must be less than or equal to the evaluated right expression.
>= The evaluated left expression must be greater than or equal to the evaluated right expression.

setLeftExpression(value: str) → None#

Set the value of the LeftExpression attribute.

Parameters:: value (str) – Left side of the constraint expression.

setRightExpression(value: str) → None#

Set the value of the RightExpression attribute.

Parameters:: value (str) – The right-hand side expression for the constraint as a string.

class ConstraintList(impl: Any)#

Bases: DefinitionItemList[Constraint], DefaultMixin

A list of Constraint instances.

class DataFormatTool(impl: Any)#

Bases: Object, DefaultMixin

The tool Object that defines how data will be formatted for its parent Object.

getType() → str#

Get the value of the Type attribute.

Returns:: The name of the data type.
Return type:: str

setType(value: str) → None#

Set the value of the Type attribute.

Parameters:: value (str) – The name of the data type.

class DataFormatTool_Continuous(impl: Any)#

Bases: DataFormatTool, DefaultMixin

Values are a part of a continuous range. No additional formatting is applied.

class DataFormatTool_FixedPrecision(impl: Any)#

Bases: DataFormatTool, DefaultMixin

Rounds values to a given number of decimal places.

getPrecision() → int#

Get the value of the Precision attribute.

Returns:: The number of decimals of precision.
Return type:: int

setPrecision(value: int) → None#

Set the value of the Precision attribute.

Parameters:: value (int) – The number of decimals of precision.

class DataFormatTool_FormatSpecifier(impl: Any)#

Bases: DataFormatTool, DefaultMixin

Format values using a standard C format specifier, such as %8.2f.

getFormatSpecifier() → str#

Get the value of the FormatSpecifier attribute.

Returns:: The C-style format specifier to use.
Return type:: str

setFormatSpecifier(value: str) → None#

Set the value of the FormatSpecifier attribute.

Parameters:: value (str) – The C-style format specifier to use.

class DataFormatTool_List(impl: Any)#

Bases: DataFormatTool, DefaultMixin

Creates an ordered (discrete) or unordered (categorical) list of values.

getLevels() → str#

Get the value of the Levels attribute.

Returns:: A list of possible values as a comma separated string.
Return type:: str

getOrdered() → bool#

Get the value of the Ordered attribute.

Returns:: If True, the list of values will be ordered.
Return type:: bool

setLevels(value: str) → None#

Set the value of the Levels attribute.

Parameters:: value (str) – A list of possible values as a comma separated string.

setOrdered(value: bool) → None#

Set the value of the Ordered attribute.

Parameters:: value (bool) – If True, the list of values will be ordered.

class DataFormatTool_Step(impl: Any)#

Bases: DataFormatTool, DefaultMixin

Defines a sequence of values incremented by a given step size.

getStep() → str#

Get the value of the Step attribute.

Returns:: The difference between subsequent formatted values.
Return type:: str

setStep(value: str) → None#

Set the value of the Step attribute.

Parameters:: value (str) – The difference between subsequent formatted values.

class DataMode#

Bases: object

CATEGORICAL: Final[str] = 'Categorical'#

CONTINOUS: Final[str] = 'Continuous'#

DISCRETE: Final[str] = 'Discrete'#

class DataSource(impl: Any)#

Bases: DefinitionItem, DefaultMixin

Data sources contain data obtained with various result readers technologies, such as file sources, ascii extract, and readsim.

getAvailableDataSourceToolTypes() → List[DataSourceToolTypes]#

Get the available types for the DataSourceTool attribute.

Returns:: A list of types for the DataSourceTool attribute
Return type:: List[DataSourceToolTypes]

getDataSourceTool() → DataSourceTool#

Get the value of the DataSourceTool attribute.

Returns:: The Object containing settings for a specific data source type.
Return type:: DataSourceTool

See also

DataSourceToolTypes

getDataSourceToolType() → DataSourceToolTypes#

Returns:: The type of the DataSourceTool attribute.
Return type:: DataSourceToolTypes

getEvaluate() → str#

Get the value of the Evaluate attribute.

Returns:: The fit varname to use for evaluation if applicable, otherwise “@solver”.
Return type:: str

getExtractAfter() → str#

Get the value of the ExtractAfter attribute.

Returns:: Comma separated list of additional Input Variables, Models, Responses, Gradients, and Data Sources that will be processed before this item. Generally these are auto-detected; Extract After is intended for rare situations where auto-detection is not possible.
Return type:: str

getModelParameter() → ModelParameter#

Get the value of the ModelParameter attribute.

Returns:: The input or output entity within the Model.
Return type:: ModelParameter

getSource() → str#

Get the value of the Source attribute.

Returns:: The file to extract data from.
Return type:: str

getSourceFileName() → str#

Get the value of the SourceFileName attribute.

Returns:: The file that will be read by the Data Source. This is generally the solver output file.
Return type:: str

Get the value of the TestRunExpression attribute.

Returns:: The Templex expression that is the equivalent of evaluating this Data Source.
Return type:: hstApiVariant

getTestRunValue() → str#

Get the value of the TestRunValue attribute.

Returns:: The Test Approach value.
Return type:: str

getTool() → str#

Get the value of the Tool attribute.

Returns:

The name of the Data Source tool that contains the settings specific to each type of data source.

FileSource Extract data out of a run file by selecting a subcase, request, and component over all time steps.
ReadSim Extract data out of a run file by selecting a combination of multiple requests, components, and timesteps. Based on the readsim Templex function.
ReadMac Compare modal result to a known reference to correlate results or avoid mode switching. Based on the readmac Templex function.
Area Calculate the area between two curves.
Spreadsheet Extract and store a range of cells in a spreadsheet.
AsciiExtract Extract custom data out of ASCII result files.
Templex Define Templex statements or expressions, which can then be referenced in the Output Response expression.
Python Execute code in a Python interpreter. The code should contain a return command with the Data Source data.
Regex Extract string or numerical data of any human
XML Extract string or numerical data from XML files by selecting the element or entering a query path.

Return type:

str

See also

DataSourceTool

getToolSpecifics() → str#

Get the value of the ToolSpecifics attribute.

Returns:: The settings for the Data Source tool as a string.
Return type:: str

getType() → str#

Get the value of the Type attribute.

Returns:

The data type that the data source extracts.

String Data will be a vector of strings.
Numeric Data will be a vector of real numbers.

Return type:

str

setDataSourceToolType(value: DataSourceToolTypes) → None#

Parameters:: value (DataSourceToolTypes) – The type of the DataSourceTool attribute.
Returns:: None

setEvaluate(value: str) → None#

Set the value of the Evaluate attribute.

Parameters:: value (str) – The fit varname to use for evaluation if applicable, otherwise “@solver”.

setExtractAfter(value: str) → None#

Set the value of the ExtractAfter attribute.

Parameters:: value (str) – Comma separated list of additional Input Variables, Models, Responses, Gradients, and Data Sources that will be processed before this item. Generally these are auto-detected; Extract After is intended for rare situations where auto-detection is not possible.

setSource(value: str) → None#

Set the value of the Source attribute.

Parameters:: value (str) – The file to extract data from.

setSourceFileName(value: str) → None#

Set the value of the SourceFileName attribute.

Parameters:: value (str) – The file that will be read by the Data Source. This is generally the solver output file.

setTool(value: str) → None#

Set the value of the Tool attribute.

Parameters:

value (str) –

The name of the Data Source tool that contains the settings specific to each type of data source.

FileSource Extract data out of a run file by selecting a subcase, request, and component over all time steps.
ReadSim Extract data out of a run file by selecting a combination of multiple requests, components, and timesteps. Based on the readsim Templex function.
ReadMac Compare modal result to a known reference to correlate results or avoid mode switching. Based on the readmac Templex function.
Area Calculate the area between two curves.
Spreadsheet Extract and store a range of cells in a spreadsheet.
AsciiExtract Extract custom data out of ASCII result files.
Templex Define Templex statements or expressions, which can then be referenced in the Output Response expression.
Python Execute code in a Python interpreter. The code should contain a return command with the Data Source data.
Regex Extract string or numerical data of any human
XML Extract string or numerical data from XML files by selecting the element or entering a query path.

See also

DataSourceTool

setToolSpecifics(value: str) → None#

Set the value of the ToolSpecifics attribute.

Parameters:: value (str) – The settings for the Data Source tool as a string.

setType(value: str) → None#

Set the value of the Type attribute.

Parameters:

value (str) –

The data type that the data source extracts.

String Data will be a vector of strings.
Numeric Data will be a vector of real numbers.

class DataSourceList(impl: Any)#

Bases: DefinitionItemList[DataSource], DefaultMixin

A list of DataSource instances.

class DataSourceTool(impl: Any)#

Bases: ExpressionTool, DefaultMixin

The tool Object that defines the behavior of its parent DataSource.

enum DataSourceToolTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_FILESOURCE = <DataSourceToolTypes.TYPE_FILESOURCE: 'FileSource'>#

TYPE_READSIM = <DataSourceToolTypes.TYPE_READSIM: 'ReadSim'>#

TYPE_READMAC = <DataSourceToolTypes.TYPE_READMAC: 'ReadMac'>#

TYPE_AREA = <DataSourceToolTypes.TYPE_AREA: 'Area'>#

TYPE_SPREADSHEET = <DataSourceToolTypes.TYPE_SPREADSHEET: 'Spreadsheet'>#

TYPE_ASCIIEXTRACT = <DataSourceToolTypes.TYPE_ASCIIEXTRACT: 'AsciiExtract'>#

TYPE_TEMPLEX = <DataSourceToolTypes.TYPE_TEMPLEX: 'Templex'>#

TYPE_PYTHON = <DataSourceToolTypes.TYPE_PYTHON: 'Python'>#

TYPE_HSTP = <DataSourceToolTypes.TYPE_HSTP: 'Hstp'>#

TYPE_REGEX = <DataSourceToolTypes.TYPE_REGEX: 'Regex'>#

TYPE_XML = <DataSourceToolTypes.TYPE_XML: 'XML'>#

TYPE_MODEL = <DataSourceToolTypes.TYPE_MODEL: 'Model'>#

class DataSourceTool_Area(impl: Any)#

Bases: DataSourceTool, DefaultMixin

Calculate the area between two curves.

getNormalize() → bool#

Get the value of the Normalize attribute.

Returns:: If True, the area value will be normalized.
Return type:: bool

getSort() → bool#

Get the value of the Sort attribute.

Returns:: If True, data points within the data source are sorted.
Return type:: bool

getTrimXHigh() → bool#

Get the value of the TrimXHigh attribute.

Returns:: Enable trimming above the specified high value.
Return type:: bool

getTrimXHighValue() → float#

Get the value of the TrimXHighValue attribute.

Returns:: Trim x values after scaling above this value.
Return type:: float

getTrimXLow() → bool#

Get the value of the TrimXLow attribute.

Returns:: Enable trimming below the specified low value.
Return type:: bool

getTrimXLowValue() → float#

Get the value of the TrimXLowValue attribute.

Returns:: Trim x values after scaling below this value.
Return type:: float

getX1() → str#

Get the value of the X1 attribute.

Returns:: The varname of the DataSource providing the reference curve X values.
Return type:: str

getX1Scale() → float#

Get the value of the X1Scale attribute.

Returns:: Scale factor for reference curve X values.
Return type:: float

getX2() → str#

Get the value of the X2 attribute.

Returns:: The varname of the DataSource providing the target curve X values.
Return type:: str

getX2Scale() → float#

Get the value of the X2Scale attribute.

Returns:: Scale factor for target curve X values.
Return type:: float

getY1() → str#

Get the value of the Y1 attribute.

Returns:: The varname of the DataSource providing the reference curve Y values.
Return type:: str

getY1Scale() → float#

Get the value of the Y1Scale attribute.

Returns:: Scale factor for reference curve Y values.
Return type:: float

getY2() → str#

Get the value of the Y2 attribute.

Returns:: The varname of the DataSource providing the target curve Y values.
Return type:: str

getY2Scale() → float#

Get the value of the Y2Scale attribute.

Returns:: Scale factor for target curve Y values.
Return type:: float

setNormalize(value: bool) → None#

Set the value of the Normalize attribute.

Parameters:: value (bool) – If True, the area value will be normalized.

setSort(value: bool) → None#

Set the value of the Sort attribute.

Parameters:: value (bool) – If True, data points within the data source are sorted.

setTrimXHigh(value: bool) → None#

Set the value of the TrimXHigh attribute.

Parameters:: value (bool) – Enable trimming above the specified high value.

setTrimXHighValue(value: float) → None#

Set the value of the TrimXHighValue attribute.

Parameters:: value (float) – Trim x values after scaling above this value.

setTrimXLow(value: bool) → None#

Set the value of the TrimXLow attribute.

Parameters:: value (bool) – Enable trimming below the specified low value.

setTrimXLowValue(value: float) → None#

Set the value of the TrimXLowValue attribute.

Parameters:: value (float) – Trim x values after scaling below this value.

setX1(value: str) → None#

Set the value of the X1 attribute.

Parameters:: value (str) – The varname of the DataSource providing the reference curve X values.

setX1Scale(value: float) → None#

Set the value of the X1Scale attribute.

Parameters:: value (float) – Scale factor for reference curve X values.

setX2(value: str) → None#

Set the value of the X2 attribute.

Parameters:: value (str) – The varname of the DataSource providing the target curve X values.

setX2Scale(value: float) → None#

Set the value of the X2Scale attribute.

Parameters:: value (float) – Scale factor for target curve X values.

setY1(value: str) → None#

Set the value of the Y1 attribute.

Parameters:: value (str) – The varname of the DataSource providing the reference curve Y values.

setY1Scale(value: float) → None#

Set the value of the Y1Scale attribute.

Parameters:: value (float) – Scale factor for reference curve Y values.

setY2(value: str) → None#

Set the value of the Y2 attribute.

Parameters:: value (str) – The varname of the DataSource providing the target curve Y values.

setY2Scale(value: float) → None#

Set the value of the Y2Scale attribute.

Parameters:: value (float) – Scale factor for target curve Y values.

class DataSourceTool_AsciiExtract(impl: Any)#

Bases: DataSourceTool, DefaultMixin

Extract custom data out of ASCII result files.

getKeyword() → str#

Get the value of the Keyword attribute.

Returns:: The keyword(s) that appear before the desired value in the text.
Return type:: str

getKeywordState() → bool#

Get the value of the KeywordState attribute.

Returns:: If True, search for the keyword(s) to find the starting location.
Return type:: bool

getLength() → int#

Get the value of the Length attribute.

Returns:: The number of characters to extract from the text.
Return type:: int

getOffset() → int#

Get the value of the Offset attribute.

Returns:: The number of characters after the keyword or beginning of the text that should be ignored before extracting the desired value.
Return type:: int

setKeyword(value: str) → None#

Set the value of the Keyword attribute.

Parameters:: value (str) – The keyword(s) that appear before the desired value in the text.

setKeywordState(value: bool) → None#

Set the value of the KeywordState attribute.

Parameters:: value (bool) – If True, search for the keyword(s) to find the starting location.

setLength(value: int) → None#

Set the value of the Length attribute.

Parameters:: value (int) – The number of characters to extract from the text.

setOffset(value: int) → None#

Set the value of the Offset attribute.

Parameters:: value (int) – The number of characters after the keyword or beginning of the text that should be ignored before extracting the desired value.

class DataSourceTool_FileSource(impl: Any)#

Bases: DataSourceTool, DefaultMixin

Extract data out of a run file by selecting a subcase, request, and component over all time steps.

getComponent() → str#

Get the value of the Component attribute.

Returns:: The data component for the currently specified result type. The available components will vary based on the current result type.
Return type:: str

getReader() → str#

Get the value of the Reader attribute.

Returns:: The name of the results reader to use.
Return type:: str

getReaderVersion() → str#

Get the value of the ReaderVersion attribute.

Returns:: If the reader has reader-version-support, this number indicates the version that is used.
Return type:: str

getReaderVersionSupport() → bool#

Get the value of the ReaderVersionSupport attribute.

Returns:: If True, the reader used has reader-version-support.
Return type:: bool

getRequest() → str#

Get the value of the Request attribute.

Returns:: The data request to read, specified as a string.
Return type:: str

getSubcase() → str#

Get the value of the Subcase attribute.

Returns:: The subcase for the data to be read, specified as a string. Acceptable values are the subcase string (for example, “Subcase 3”), or, if there is no subcase, an empty string (“”) or “nosubcase”.
Return type:: str

getType() → str#

Get the value of the Type attribute.

Returns:: The type of data to read, specified as the type string (for example, “Angular Acceleration”).
Return type:: str

setComponent(value: str) → None#

Set the value of the Component attribute.

Parameters:: value (str) – The data component for the currently specified result type. The available components will vary based on the current result type.

setReader(value: str) → None#

Set the value of the Reader attribute.

Parameters:: value (str) – The name of the results reader to use.

setReaderVersion(value: str) → None#

Set the value of the ReaderVersion attribute.

Parameters:: value (str) – If the reader has reader-version-support, this number indicates the version that is used.

setReaderVersionSupport(value: bool) → None#

Set the value of the ReaderVersionSupport attribute.

Parameters:: value (bool) – If True, the reader used has reader-version-support.

setRequest(value: str) → None#

Set the value of the Request attribute.

Parameters:: value (str) – The data request to read, specified as a string.

setSubcase(value: str) → None#

Set the value of the Subcase attribute.

Parameters:: value (str) – The subcase for the data to be read, specified as a string. Acceptable values are the subcase string (for example, “Subcase 3”), or, if there is no subcase, an empty string (“”) or “nosubcase”.

setType(value: str) → None#

Set the value of the Type attribute.

Parameters:: value (str) – The type of data to read, specified as the type string (for example, “Angular Acceleration”).

class DataSourceTool_Hstp(impl: Any)#

Bases: DataSourceTool, DefaultMixin

This class is deprecated. Use DataSourceTool_XML instead.

getItem() → str#

Get the value of the Item attribute.

Returns:: The label of the item to lookup in the HSTP file.
Return type:: str

getType() → str#

Get the value of the Type attribute.

Returns:: The HSTP data source is being removed and should not be used.
Return type:: str

setItem(value: str) → None#

Set the value of the Item attribute.

Parameters:: value (str) – The label of the item to lookup in the HSTP file.

setType(value: str) → None#

Set the value of the Type attribute.

Parameters:: value (str) – The HSTP data source is being removed and should not be used.

class DataSourceTool_Model(impl: Any)#

Bases: DataSourceTool, DefaultMixin

This handles connection specific results. Data will be extracted directly from the connection.

class DataSourceTool_Python(impl: Any)#

Bases: DataSourceTool, DefaultMixin

Execute code in a Python interpreter. The code should contain a return command with the data source.

getExpression() → str#

Get the value of the Expression attribute.

Returns:: A Python expression that evaluates to a scalar or a vector.
Return type:: str

setExpression(value: str) → None#

Set the value of the Expression attribute.

Parameters:: value (str) – A Python expression that evaluates to a scalar or a vector.

class DataSourceTool_ReadMac(impl: Any)#

Bases: DataSourceTool, DefaultMixin

Compare modal result to a known reference to correlate results or avoid mode switching. Based on the readmac Templex function.

getReader() → str#

Get the value of the Reader attribute.

Returns:: The name of the reader that was used.
Return type:: str

getReaderVersion() → str#

Get the value of the ReaderVersion attribute.

Returns:: If the reader has reader-version-support, this number indicates the version that is used.
Return type:: str

getReaderVersionSupport() → bool#

Get the value of the ReaderVersionSupport attribute.

Returns:: If True, the reader used has reader-version-support.
Return type:: bool

getReferenceMode() → int#

Get the value of the ReferenceMode attribute.

Returns:: ID of reference mode shape. Please refer to the readmac Templex documentation.
Return type:: int

getReferenceSource() → str#

Get the value of the ReferenceSource attribute.

Returns:: Target result file URI.
Return type:: str

getReferenceSubcase() → str#

Get the value of the ReferenceSubcase attribute.

Returns:: Subcase ID in the reference file. Please refer to the readmac Templex documentation.
Return type:: str

getReferenceType() → str#

Get the value of the ReferenceType attribute.

Returns:: Type name (string) in the reference file. Please refer to the readmac Templex documentation.
Return type:: str

getTargetMaxMode() → int#

Get the value of the TargetMaxMode attribute.

Returns:: This specifies the last Mode of the range that will be used. Used only when TargetModeState is True and TargetMinMaxModeState is True.
Return type:: int

getTargetMinMaxModeState() → bool#

Get the value of the TargetMinMaxModeState attribute.

Returns:: If True, use a range of modes. If False, use the first N modes. Used only when TargetModeState is True.
Return type:: bool

getTargetMinMode() → int#

Get the value of the TargetMinMode attribute.

Returns:: This specifies the first Mode of the range that will be used. Used only when TargetModeState is True and TargetMinMaxModeState is True.
Return type:: int

getTargetMode() → int#

Get the value of the TargetMode attribute.

Returns:: This specifies the number of modes to use. Used only when TargetModeState is True and TargetMinMaxModeState is False.
Return type:: int

getTargetModeState() → bool#

Get the value of the TargetModeState attribute.

Returns:: If True, the target use a limited set of Modes. If False, all Modes are used.
Return type:: bool

getTargetSubcase() → str#

Get the value of the TargetSubcase attribute.

Returns:: The simulation subcase corresponding to the target.
Return type:: str

getTargetSubcaseTypeState() → bool#

Get the value of the TargetSubcaseTypeState attribute.

Returns:: If True, the target subcase and target type are used. If False, the reference subcase and type are used for the target.
Return type:: bool

getTargetType() → str#

Get the value of the TargetType attribute.

Returns:: The simulation type corresponding to the target.
Return type:: str

setReader(value: str) → None#

Set the value of the Reader attribute.

Parameters:: value (str) – The name of the reader that was used.

setReaderVersion(value: str) → None#

Set the value of the ReaderVersion attribute.

Parameters:: value (str) – If the reader has reader-version-support, this number indicates the version that is used.

setReaderVersionSupport(value: bool) → None#

Set the value of the ReaderVersionSupport attribute.

Parameters:: value (bool) – If True, the reader used has reader-version-support.

setReferenceMode(value: int) → None#

Set the value of the ReferenceMode attribute.

Parameters:: value (int) – ID of reference mode shape. Please refer to the readmac Templex documentation.

setReferenceSource(value: str) → None#

Set the value of the ReferenceSource attribute.

Parameters:: value (str) – Target result file URI.

setReferenceSubcase(value: str) → None#

Set the value of the ReferenceSubcase attribute.

Parameters:: value (str) – Subcase ID in the reference file. Please refer to the readmac Templex documentation.

setReferenceType(value: str) → None#

Set the value of the ReferenceType attribute.

Parameters:: value (str) – Type name (string) in the reference file. Please refer to the readmac Templex documentation.

setTargetMaxMode(value: int) → None#

Set the value of the TargetMaxMode attribute.

Parameters:: value (int) – This specifies the last Mode of the range that will be used. Used only when TargetModeState is True and TargetMinMaxModeState is True.

setTargetMinMaxModeState(value: bool) → None#

Set the value of the TargetMinMaxModeState attribute.

Parameters:: value (bool) – If True, use a range of modes. If False, use the first N modes. Used only when TargetModeState is True.

setTargetMinMode(value: int) → None#

Set the value of the TargetMinMode attribute.

Parameters:: value (int) – This specifies the first Mode of the range that will be used. Used only when TargetModeState is True and TargetMinMaxModeState is True.

setTargetMode(value: int) → None#

Set the value of the TargetMode attribute.

Parameters:: value (int) – This specifies the number of modes to use. Used only when TargetModeState is True and TargetMinMaxModeState is False.

setTargetModeState(value: bool) → None#

Set the value of the TargetModeState attribute.

Parameters:: value (bool) – If True, the target use a limited set of Modes. If False, all Modes are used.

setTargetSubcase(value: str) → None#

Set the value of the TargetSubcase attribute.

Parameters:: value (str) – The simulation subcase corresponding to the target.

setTargetSubcaseTypeState(value: bool) → None#

Set the value of the TargetSubcaseTypeState attribute.

Parameters:: value (bool) – If True, the target subcase and target type are used. If False, the reference subcase and type are used for the target.

setTargetType(value: str) → None#

Set the value of the TargetType attribute.

Parameters:: value (str) – The simulation type corresponding to the target.

class DataSourceTool_ReadSim(impl: Any)#

Bases: DataSourceTool, DefaultMixin

Extract data out of a run file by selecting a combination of multiple requests, components, and timesteps. Based on the readsim Templex function.

getComponentList() → List[str]#

Get the value of the ComponentList attribute.

Returns:: The list of data components for the currently specified result type. The available components will vary based on the current result type.
Return type:: List[str]

getEndRequest() → str#

Get the value of the EndRequest attribute.

Returns:

The last data request to read, specified as a string. The string can be the specific request or one of the values listed here.

firstrequest The first request in the list.
lastrequest The last request in the list, or an empty string if there is only one request in the list.

Return type:

str

getEndSubcase() → str#

Get the value of the EndSubcase attribute.

Returns:: The subcase for the data to be read, specified as a string. Acceptable values are the subcase string (for example, “Subcase 3”), or, if there is no subcase, an empty string (“”) or “nosubcase”.
Return type:: str

getEndTimeStep() → int#

Get the value of the EndTimeStep attribute.

Returns:: The integer of the zero-based end time step index. A value of -1 corresponds to the last value, -2 to the second last, and so on. If this is set, all values between the start- and end-indices will be returned.
Return type:: int

getEndTimeStepState() → bool#

Get the value of the EndTimeStepState attribute.

Returns:: If True, the end time step will be used when evaluating the data source.
Return type:: bool

getReader() → str#

Get the value of the Reader attribute.

Returns:: The name of the results reader to use.
Return type:: str

getReaderVersion() → str#

Get the value of the ReaderVersion attribute.

Returns:: If the reader has reader-version-support, this number indicates the version that is used.
Return type:: str

getReaderVersionSupport() → bool#

Get the value of the ReaderVersionSupport attribute.

Returns:: If True, the reader used has reader-version-support.
Return type:: bool

getStartRequest() → str#

Get the value of the StartRequest attribute.

Returns:

The first data request to read, specified as a string. Acceptable values are the request string (for example, “Node 5”) or one of the below strings.

firstrequest The first request in the request list.
lastrequest The last request in the request list.

Return type:

str

getStartTimeStep() → int#

Get the value of the StartTimeStep attribute.

Returns:: The integer of the zero-based value index. If specified, it will be the start index of the vector extracted from the full value list. A value of 0 corresponds to the first vector value, 1 corresponds to the second vector value, and so on. -1 corresponds to the last value, -2 to the second last, and so on. If this attribute is not specified, the full vector will be returned.
Return type:: int

getStartTimeStepState() → bool#

Get the value of the StartTimeStepState attribute.

Returns:: If True, the start time step will be used when evaluating the data source.
Return type:: bool

getSubcase() → str#

Get the value of the Subcase attribute.

Returns:: The subcase for the data to be read, specified as a string. Acceptable values are the subcase string (for example, “Subcase 3”), or, if there is no subcase, an empty string (“”) or “nosubcase”.
Return type:: str

getType() → str#

Get the value of the Type attribute.

Returns:: The type of data to read, specified as the type string (for example, “Angular Acceleration”).
Return type:: str

setComponentList(value: List[str]) → None#

Set the value of the ComponentList attribute.

Parameters:: value (List[str]) – The list of data components for the currently specified result type. The available components will vary based on the current result type.

setEndRequest(value: str) → None#

Set the value of the EndRequest attribute.

Parameters:

value (str) –

The last data request to read, specified as a string. The string can be the specific request or one of the values listed here.

firstrequest The first request in the list.
lastrequest The last request in the list, or an empty string if there is only one request in the list.

setEndSubcase(value: str) → None#

Set the value of the EndSubcase attribute.

Parameters:: value (str) – The subcase for the data to be read, specified as a string. Acceptable values are the subcase string (for example, “Subcase 3”), or, if there is no subcase, an empty string (“”) or “nosubcase”.

setEndTimeStep(value: int) → None#

Set the value of the EndTimeStep attribute.

Parameters:: value (int) – The integer of the zero-based end time step index. A value of -1 corresponds to the last value, -2 to the second last, and so on. If this is set, all values between the start- and end-indices will be returned.

setEndTimeStepState(value: bool) → None#

Set the value of the EndTimeStepState attribute.

Parameters:: value (bool) – If True, the end time step will be used when evaluating the data source.

setReader(value: str) → None#

Set the value of the Reader attribute.

Parameters:: value (str) – The name of the results reader to use.

setReaderVersion(value: str) → None#

Set the value of the ReaderVersion attribute.

Parameters:: value (str) – If the reader has reader-version-support, this number indicates the version that is used.

setReaderVersionSupport(value: bool) → None#

Set the value of the ReaderVersionSupport attribute.

Parameters:: value (bool) – If True, the reader used has reader-version-support.

setStartRequest(value: str) → None#

Set the value of the StartRequest attribute.

Parameters:

value (str) –

The first data request to read, specified as a string. Acceptable values are the request string (for example, “Node 5”) or one of the below strings.

firstrequest The first request in the request list.
lastrequest The last request in the request list.

setStartTimeStep(value: int) → None#

Set the value of the StartTimeStep attribute.

Parameters:: value (int) – The integer of the zero-based value index. If specified, it will be the start index of the vector extracted from the full value list. A value of 0 corresponds to the first vector value, 1 corresponds to the second vector value, and so on. -1 corresponds to the last value, -2 to the second last, and so on. If this attribute is not specified, the full vector will be returned.

setStartTimeStepState(value: bool) → None#

Set the value of the StartTimeStepState attribute.

Parameters:: value (bool) – If True, the start time step will be used when evaluating the data source.

setSubcase(value: str) → None#

Set the value of the Subcase attribute.

Parameters:: value (str) – The subcase for the data to be read, specified as a string. Acceptable values are the subcase string (for example, “Subcase 3”), or, if there is no subcase, an empty string (“”) or “nosubcase”.

setType(value: str) → None#

Set the value of the Type attribute.

Parameters:: value (str) – The type of data to read, specified as the type string (for example, “Angular Acceleration”).

class DataSourceTool_RegexExtract(impl: Any)#

Bases: DataSourceTool, DefaultMixin

Extract string or numerical data of any human-readable file via ECMAScript Regular Expressions.

getPostTreatment() → str#

Get the value of the PostTreatment attribute.

Returns:

Additional extractions that should be applied to the result.

ExtractCSV Extract comma separated values from the result.
ExtractRealNumbers Extract float values from the result.
ExtractWords Extract alphabetical sequences from the result.

Return type:

str

getRegexMode() → str#

Get the value of the RegexMode attribute.

Returns:

How data should be extracted from regular expression results.

Capture Only extract values from the primary capture group.
Match Extract values from the entire matched sequence.

Return type:

str

getRegexPattern() → str#

Get the value of the RegexPattern attribute.

Returns:: A regular expression using ECMAScript syntax.
Return type:: str

setPostTreatment(value: str) → None#

Set the value of the PostTreatment attribute.

Parameters:

value (str) –

Additional extractions that should be applied to the result.

ExtractCSV Extract comma separated values from the result.
ExtractRealNumbers Extract float values from the result.
ExtractWords Extract alphabetical sequences from the result.

setRegexMode(value: str) → None#

Set the value of the RegexMode attribute.

Parameters:

value (str) –

How data should be extracted from regular expression results.

Capture Only extract values from the primary capture group.
Match Extract values from the entire matched sequence.

setRegexPattern(value: str) → None#

Set the value of the RegexPattern attribute.

Parameters:: value (str) – A regular expression using ECMAScript syntax.

class DataSourceTool_Templex(impl: Any)#

Bases: DataSourceTool, DefaultMixin

Define Templex statements or expressions, which can then be referenced in the output response expression.

getExpression() → str#

Get the value of the Expression attribute.

Returns:: A Templex expression that evaluates to a scalar or a vector.
Return type:: str

setExpression(value: str) → None#

Set the value of the Expression attribute.

Parameters:: value (str) – A Templex expression that evaluates to a scalar or a vector.

class DataSourceTool_XLS(impl: Any)#

Bases: DataSourceTool, DefaultMixin

Extract and store a range of cells in a spreadsheet.

getRangeList() → List[str]#

Get the value of the RangeList attribute.

Returns:: The list of cell ranges to extract data from.
Return type:: List[str]

getWorkSheet() → str#

Get the value of the WorkSheet attribute.

Returns:: The name of the worksheet to extract data from.
Return type:: str

setRangeList(value: List[str]) → None#

Set the value of the RangeList attribute.

Parameters:: value (List[str]) – The list of cell ranges to extract data from.

setWorkSheet(value: str) → None#

Set the value of the WorkSheet attribute.

Parameters:: value (str) – The name of the worksheet to extract data from.

class DataSourceTool_XML(impl: Any)#

Bases: DataSourceTool, DefaultMixin

Extract string or numerical data from XML files by selecting the element or entering a query path.

getXPath() → str#

Get the value of the XPath attribute.

Returns:: An XPath query specifying the location of the data in the XML file.
Return type:: str

setXPath(value: str) → None#

Set the value of the XPath attribute.

Parameters:: value (str) – An XPath query specifying the location of the data in the XML file.

class DataType#

Bases: object

INTEGER: Final[str] = 'Integer'#

REAL: Final[str] = 'Real'#

STRING: Final[str] = 'String'#

class DefinitionItem(impl: Any)#

Bases: Item, DefaultMixin

An Item that makes up a part of an Approach’s Definition (e.g. Response, Variable, Gradient, etc.).

getState() → bool#

Get the value of the State attribute.

Returns:: If True, the Item is active in the approach and will be used during evaluation.
Return type:: bool

setState(value: bool) → None#

Set the value of the State attribute.

Parameters:: value (bool) – If True, the Item is active in the approach and will be used during evaluation.

class DefinitionItemList(impl: Any)#

Bases: ItemList[T], DefaultMixin

A list of DefinitionItem instances.

class Depot(impl: Any)#

Bases: _ApiInterface, DefaultMixin

This class’s interface is not consistent. It will eventually be available but is not ready for release at this time.

class Distribution(impl: Any)#

Bases: Object, DefaultMixin

The statistical distribution that determines the probability that the Input Variable will take a certain value.

class Distribution_Exponential(impl: Any)#

Bases: Distribution, DefaultMixin

Use to describe the amount of time between occurrences, mean time between failures.

class Distribution_Gumbel(impl: Any)#

Bases: Distribution, DefaultMixin

Used to model the behavior of extreme values, such as the maximum or minimum, from a sample of various distributions. Defined using the location (Alpha) and scale (Beta) parameters.

class Distribution_LogNormal(impl: Any)#

Bases: Distribution, DefaultMixin

Use in risk analyses. Defined using the location (Alpha) and scale (Beta) parameters.

class Distribution_LogNormal_3P(impl: Any)#

Bases: Distribution, DefaultMixin

A Log-Normal distribution with an additional shape (Gamma) parameter.

class Distribution_Normal(impl: Any)#

Bases: Distribution, DefaultMixin

Base class for other Normal Distributions.

class Distribution_Normal_CoV(impl: Any)#

Bases: Distribution_Normal, DefaultMixin

Use to approximate many phenomenons in nature. Defined using the mean (Alpha) and the coefficient of variance (Beta) parameters.

class Distribution_Normal_Var(impl: Any)#

Bases: Distribution_Normal, DefaultMixin

Use to approximate many phenomenons in nature. Defined using the mean (Alpha) and variance (Beta).

class Distribution_Triangular(impl: Any)#

Bases: Distribution, DefaultMixin

Use when the only known information is the minimum, the most likely, and the maximum values. Defined using the lower bound (Alpha), upper bound (Beta), and mode (Gamma) parameters.

class Distribution_Uniform(impl: Any)#

Bases: Distribution, DefaultMixin

Use when all values between the minimum and maximum are equally likely, such as a number from a random number generator. Defined using the lower bound (Alpha) and upper bound (Beta) parameters.

class Distribution_UniformContinuous(impl: Any)#

Bases: Distribution_Uniform, DefaultMixin

Use when all values between the minimum and maximum are equally likely, such as a number from a random number generator. Defined using the lower bound (Alpha) and upper bound (Beta) parameters.

class Distribution_UniformDiscrete(impl: Any)#

Bases: Distribution, DefaultMixin

Use when you have discrete (numeric or string) variables that take values which are equally likely.

class Distribution_Weibull(impl: Any)#

Bases: Distribution, DefaultMixin

Principal applications are situations involving wear, fatigue and failure, failure rates, life-time expectancies. Defined using the shape (Alpha) and scale (Beta) parameters.

class Distribution_Weibull_3P(impl: Any)#

Bases: Distribution, DefaultMixin

A Weibull distribution with an additional location (Gamma) parameter.

enum DoeDesignTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_NOM = <DoeDesignTypes.TYPE_NOM: 'Nom'>#

TYPE_CHK = <DoeDesignTypes.TYPE_CHK: 'Chk'>#

TYPE_SWEEP = <DoeDesignTypes.TYPE_SWEEP: 'Sweep'>#

TYPE_DOPT = <DoeDesignTypes.TYPE_DOPT: 'DOpt'>#

TYPE_FULLFACT = <DoeDesignTypes.TYPE_FULLFACT: 'FullFact'>#

TYPE_CCD = <DoeDesignTypes.TYPE_CCD: 'Ccd'>#

TYPE_FRACFACT = <DoeDesignTypes.TYPE_FRACFACT: 'FracFact'>#

TYPE_PLACKBURM = <DoeDesignTypes.TYPE_PLACKBURM: 'PlackBurm'>#

TYPE_BOX = <DoeDesignTypes.TYPE_BOX: 'Box'>#

TYPE_HAMMERSLEY = <DoeDesignTypes.TYPE_HAMMERSLEY: 'Hammersley'>#

TYPE_LATINHYPERCUBE = <DoeDesignTypes.TYPE_LATINHYPERCUBE: 'LatinHyperCube'>#

TYPE_MELS = <DoeDesignTypes.TYPE_MELS: 'Mels'>#

TYPE_SOBOL = <DoeDesignTypes.TYPE_SOBOL: 'Sobol'>#

TYPE_RUNMATRIX = <DoeDesignTypes.TYPE_RUNMATRIX: 'RunMatrix'>#

TYPE_USER = <DoeDesignTypes.TYPE_USER: 'User'>#

TYPE_TAGUCHI = <DoeDesignTypes.TYPE_TAGUCHI: 'Taguchi'>#

TYPE_INITIAL = <DoeDesignTypes.TYPE_INITIAL: 'Initial'>#

TYPE_EMPTY = <DoeDesignTypes.TYPE_EMPTY: 'Empty'>#

TYPE_FILLRANDOM = <DoeDesignTypes.TYPE_FILLRANDOM: 'FillRandom'>#

TYPE_FILLSTATISTICS = <DoeDesignTypes.TYPE_FILLSTATISTICS: 'FillStatistics'>#

TYPE_SIMPLE = <DoeDesignTypes.TYPE_SIMPLE: 'Simple'>#

TYPE_VOID = <DoeDesignTypes.TYPE_VOID: 'Void'>#

class EnvironmentVariable(impl: Any)#

Bases: Object, DefaultMixin

A name/value pair that will be set in the environment during evaluation.

getName() → str#

Get the value of the Name attribute.

Returns:: The name of the environment variable name, e.g. PATH.
Return type:: str

getOperation() → str#

Get the value of the Operation attribute.

Returns:

The operation to apply to the environment variable.

Set Define variable.
Unset Remove variable.

Return type:

str

getState() → bool#

Get the value of the State attribute.

Returns:: If True, the environment variable will be either set or unset when configuring the solver process environment during Model execution.
Return type:: bool

getValue() → str#

Get the value of the Value attribute.

Returns:: The value that will be set in the environment if the Environment Variable is active.
Return type:: str

See also

EnvironmentVariable.State

setName(value: str) → None#

Set the value of the Name attribute.

Parameters:: value (str) – The name of the environment variable name, e.g. PATH.

setOperation(value: str) → None#

Set the value of the Operation attribute.

Parameters:

value (str) –

The operation to apply to the environment variable.

Set Define variable.
Unset Remove variable.

setState(value: bool) → None#

Set the value of the State attribute.

Parameters:: value (bool) – If True, the environment variable will be either set or unset when configuring the solver process environment during Model execution.

setValue(value: str) → None#

Set the value of the Value attribute.

Parameters:: value (str) – The value that will be set in the environment if the Environment Variable is active.

See also

EnvironmentVariable.State

class EnvironmentVariableList(impl: Any)#

Bases: ObjectList[EnvironmentVariable], DefaultMixin

A list of EnvironmentVariable instances.

enum EvaluatedTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_FAST = <EvaluatedTypes.TYPE_FAST: 'FAST'>#

TYPE_LSR = <EvaluatedTypes.TYPE_LSR: 'LSR'>#

TYPE_MLSM = <EvaluatedTypes.TYPE_MLSM: 'MLSM'>#

TYPE_HK = <EvaluatedTypes.TYPE_HK: 'HK'>#

TYPE_RBF = <EvaluatedTypes.TYPE_RBF: 'RBF'>#

TYPE_EXTRAPOLATION = <EvaluatedTypes.TYPE_EXTRAPOLATION: 'Extrapolation'>#

TYPE_USER_RF = <EvaluatedTypes.TYPE_USER_RF: 'USER.RF'>#

class EvaluationParameter(impl: Any)#

Bases: Item, DefaultMixin

A setting that controls the behavior of model evaluation.

getChangePossible() → bool#

Get the value of the ChangePossible attribute.

Returns:: If True, the Parameter’s value can be changed.
Return type:: bool

getEffectValue() → str#

Get the value of the EffectValue attribute.

Returns:

When the evaluation parameter takes effect.

EvaluationStart At the start of the next evaluation
AppStart At the next application startup.
RealTime Immediately.
TaskStart At the start of the next task.

Return type:

str

getState() → bool#

Get the value of the State attribute.

Returns:: If True, the EvaluationParameter is active in the Approach and will be used during evaluation.
Return type:: bool

getStateChangePossible() → bool#

Get the value of the StateChangePossible attribute.

Returns:: If True, the Evaluation Parameter active/inactive state can be changed.
Return type:: bool

getUnit() → str#

Get the value of the Unit attribute.

Returns:: Get access to the unit object for this evaluation parameter.
Return type:: str

Get the value of the Value attribute.

Returns:: The current value for the evaluation parameter.
Return type:: hstApiVariant

setChangePossible(value: bool) → None#

Set the value of the ChangePossible attribute.

Parameters:: value (bool) – If True, the Parameter’s value can be changed.

setEffectValue(value: str) → None#

Set the value of the EffectValue attribute.

Parameters:

value (str) –

When the evaluation parameter takes effect.

EvaluationStart At the start of the next evaluation
AppStart At the next application startup.
RealTime Immediately.
TaskStart At the start of the next task.

setState(value: bool) → None#

Set the value of the State attribute.

Parameters:: value (bool) – If True, the EvaluationParameter is active in the Approach and will be used during evaluation.

setStateChangePossible(value: bool) → None#

Set the value of the StateChangePossible attribute.

Parameters:: value (bool) – If True, the Evaluation Parameter active/inactive state can be changed.

setUnit(value: str) → None#

Set the value of the Unit attribute.

Parameters:: value (str) – Get access to the unit object for this evaluation parameter.

Set the value of the Value attribute.

Parameters:: value (hstApiVariant) – The current value for the evaluation parameter.

class EvaluationParameterList(impl: Any)#

Bases: ItemList[EvaluationParameter], DefaultMixin

A list of EvaluationParameter instances.

class Example(impl: Any)#

Bases: Item, DefaultMixin

A HyperStudy Quick Start example.

class ExampleList(impl: Any)#

Bases: ItemList[Example], DefaultMixin

A list of Example instances.

class ExpressionTool(impl: Any)#

Bases: Object, DefaultMixin

Base class for other tool classes that evaluate scalar or vector data.

class ExternalAlgorithm(impl: Any)#

Bases: PreferenceItem, DefaultMixin

Base class for other external sampling, fit, or optimization algorithms.

getExternalPath() → str#

Get the value of the ExternalPath attribute.

Returns:: The path to the script defining the algorithm.
Return type:: str

setExternalPath(value: str) → None#

Set the value of the ExternalPath attribute.

Parameters:: value (str) – The path to the script defining the algorithm.

class ExternalFit(impl: Any)#

Bases: ExternalAlgorithm, DefaultMixin

An external fit algorithm with a Python API.

class ExternalFitList(impl: Any)#

Bases: ItemList[ExternalFit], DefaultMixin

A list of ExternalFit instances.

class ExternalFunction(impl: Any)#

Bases: Item, DefaultMixin

A registered function that can be used in a Templex expression.

getFileName() → str#

Get the value of the FileName attribute.

Returns:: The path to the referenced file.
Return type:: str

getFunctionName() → str#

Get the value of the FunctionName attribute.

Returns:: Name of the function. e.g. sort, max, etc.
Return type:: str

getNumberOfArguments() → int#

Get the value of the NumberOfArguments attribute.

Returns:: The number of arguments that the function accepts.
Return type:: int

setFileName(value: str) → None#

Set the value of the FileName attribute.

Parameters:: value (str) – The path to the referenced file.

setFunctionName(value: str) → None#

Set the value of the FunctionName attribute.

Parameters:: value (str) – Name of the function. e.g. sort, max, etc.

setNumberOfArguments(value: int) → None#

Set the value of the NumberOfArguments attribute.

Parameters:: value (int) – The number of arguments that the function accepts.

class ExternalFunctionList(impl: Any)#

Bases: ItemList[ExternalFunction], DefaultMixin

A list of ExternalFunction instances.

class ExternalOptimizer(impl: Any)#

Bases: ExternalAlgorithm, DefaultMixin

An external optimizer with a Python-based API.

class ExternalOptimizerList(impl: Any)#

Bases: ItemList[ExternalOptimizer], DefaultMixin

A list of ExternalOptimizer instances.

class ExternalReader(impl: Any)#

Bases: Item, DefaultMixin

A registered external data reader.

getCache() → bool#

Get the value of the Cache attribute.

Returns:: If True, the reader will be cached.
Return type:: bool

getCategory() → str#

Get the value of the Category attribute.

Returns:

What type of file the reader handles.

ascii The reader only handles files containing ASCII text.
binary The reader only handles files containing binary data.
generic The reader handles various different file formats.

Return type:

str

getExtension() → str#

Get the value of the Extension attribute.

Returns:: A comma separated list of file extensions supported by the reader.
Return type:: str

getFileName() → str#

Get the value of the FileName attribute.

Returns:: The path to the referenced file.
Return type:: str

getType() → str#

Get the value of the Type attribute.

Returns:: Reader type.
Return type:: str

setCache(value: bool) → None#

Set the value of the Cache attribute.

Parameters:: value (bool) – If True, the reader will be cached.

setCategory(value: str) → None#

Set the value of the Category attribute.

Parameters:

value (str) –

What type of file the reader handles.

ascii The reader only handles files containing ASCII text.
binary The reader only handles files containing binary data.
generic The reader handles various different file formats.

setExtension(value: str) → None#

Set the value of the Extension attribute.

Parameters:: value (str) – A comma separated list of file extensions supported by the reader.

setFileName(value: str) → None#

Set the value of the FileName attribute.

Parameters:: value (str) – The path to the referenced file.

setType(value: str) → None#

Set the value of the Type attribute.

Parameters:: value (str) – Reader type.

class ExternalReaderList(impl: Any)#

Bases: ItemList[ExternalReader], DefaultMixin

A list of ExternalReader instances.

class ExternalSampling(impl: Any)#

Bases: ExternalAlgorithm, DefaultMixin

A custom sampling fit defined by a Python script.

class ExternalSamplingFit(impl: Any)#

Bases: ExternalAlgorithm, DefaultMixin

A custom fit defined by a Python script.

class ExternalSamplingFitList(impl: Any)#

Bases: ItemList[ExternalSamplingFit], DefaultMixin

A list of ExternalSamplingFit instances.

class ExternalSamplingList(impl: Any)#

Bases: ItemList[ExternalSampling], DefaultMixin

A list of ExternalSampling instances.

class Fit(impl: Any)#

Bases: DefinitionItem, DefaultMixin

A reduced order model that best fits to a dataset.

getAlgorithm() → str#

Get the value of the Algorithm attribute.

Returns:: The unique identifier of the fit type.
Return type:: str

getAlgorithmSpecifics() → str#

Get the value of the AlgorithmSpecifics attribute.

Returns:: All of the settings as a single string. This follows a special format that must be followed exactly and is intended for Copy/Paste use.
Return type:: str

getAvailableEvaluatedTypes() → List[EvaluatedTypes]#

Get the available types for the Evaluated attribute.

Returns:: A list of types for the Evaluated attribute
Return type:: List[EvaluatedTypes]

getAvailableSpecifiedTypes() → List[SpecifiedTypes]#

Get the available types for the Specified attribute.

Returns:: A list of types for the Specified attribute
Return type:: List[SpecifiedTypes]

getBuildData() → str#

Get the value of the BuildData attribute.

Returns:: Serialized data that can be restored to avoid fully rebuilding the fit.
Return type:: str

getEvaluated() → Fit_Parameters#

Get the value of the Evaluated attribute.

Returns:: The parameters that are set during the process of building the model.
Return type:: Fit_Parameters

getEvaluatedType() → EvaluatedTypes#

Returns:: The type of the Evaluated attribute.
Return type:: EvaluatedTypes

getPurposeUserInterface() → str#

Get the value of the PurposeUserInterface attribute.

Returns:: Shows the fit purpose. Could be Regression, Vector Regression or Classification, among other things.
Return type:: str

getRegressionEquation(displayInGUI: bool, vectorIndex: int) → str#

Get the regression equation for the evaluated fit as as string.

Parameters:

displayInGUI (bool) – If True, an error message will be returned if regression equations are not enabled for this Fit.
vectorIndex (int) – The index of the coefficient. For scalar fits, this should be 0.

Returns:

The string containing the regression equation. This is only applicable to LSR fit types.

Return type:

str

getResponse() → str#

Get the value of the Response attribute.

Returns:: The varname of the output that the Fit is built for.
Return type:: str

getSpecified() → Fit_Parameters#

Get the value of the Specified attribute.

Returns:: The parameters that are specified by the user before building the fit.
Return type:: Fit_Parameters

getSpecifiedType() → SpecifiedTypes#

Returns:: The type of the Specified attribute.
Return type:: SpecifiedTypes

setAlgorithm(value: str) → None#

Set the value of the Algorithm attribute.

Parameters:: value (str) – The unique identifier of the fit type.

setAlgorithmSpecifics(value: str) → None#

Set the value of the AlgorithmSpecifics attribute.

Parameters:: value (str) – All of the settings as a single string. This follows a special format that must be followed exactly and is intended for Copy/Paste use.

setBuildData(value: str) → None#

Set the value of the BuildData attribute.

Parameters:: value (str) – Serialized data that can be restored to avoid fully rebuilding the fit.

setEvaluatedType(value: EvaluatedTypes) → None#

Parameters:: value (EvaluatedTypes) – The type of the Evaluated attribute.
Returns:: None

setResponse(value: str) → None#

Set the value of the Response attribute.

Parameters:: value (str) – The varname of the output that the Fit is built for.

setSpecifiedType(value: SpecifiedTypes) → None#

Parameters:: value (SpecifiedTypes) – The type of the Specified attribute.
Returns:: None

class FitCrossValidationSettings(impl: Any)#

Bases: Object, DefaultMixin

The settings for determing the behavior of a Fit’s cross validation.

getCustom() → bool#

Get the value of the Custom attribute.

Returns:: If True, the cross validation setting are custom.
Return type:: bool

getMaxGroupSize() → int#

Get the value of the MaxGroupSize attribute.

Returns:: This limits the maximum elements in the group.
Return type:: int

setCustom(value: bool) → None#

Set the value of the Custom attribute.

Parameters:: value (bool) – If True, the cross validation setting are custom.

setMaxGroupSize(value: int) → None#

Set the value of the MaxGroupSize attribute.

Parameters:: value (int) – This limits the maximum elements in the group.

class FitList(impl: Any)#

Bases: ItemList[Fit], DefaultMixin

A list of Fit instances.

class FitReference(impl: Any)#

Bases: DefinitionItem, DefaultMixin

This is used to ensure dependencies between Fits and other Items in HyperStudy.

class FitReferenceList(impl: Any)#

Bases: DefinitionItemList[FitReference], DefaultMixin

A list of FitReference instances.

class Fit_Parameters(impl: Any)#

Bases: Perturbation_Single, DefaultMixin

The settings for determining the behavior of a Fit.

See also

Fit

getPerturbationVarname() → str#

Get the value of the PerturbationVarname attribute.

Returns:: The unique perturbation or design name.
Return type:: str

class FitterMetricOptions(impl: Any)#

Bases: Item, DefaultMixin

Settings for a fitter metric algorithm.

getAlgorithm() → str#

Get the value of the Algorithm attribute.

Returns:: The unique identifier of the fit metric to use.
Return type:: str

getMetricOption(key: str) → str#

Get the option value.

Parameters:: key (str) – The name of the option.
Returns:: The option value.
Return type:: str

getMetricOptionKeys() → List[str]#

Get the list of metric option names.

Returns:: A list of option names.
Return type:: List[str]

class FitterMetricOptionsList(impl: Any)#

Bases: ItemList[FitterMetricOptions], DefaultMixin

A list of FitterMetricOptions instances.

enum FormatToolTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_CONTINUOUS = <FormatToolTypes.TYPE_CONTINUOUS: 'Continuous'>#

TYPE_FIXEDPRECISION = <FormatToolTypes.TYPE_FIXEDPRECISION: 'FixedPrecision'>#

TYPE_FORMATSPECIFIER = <FormatToolTypes.TYPE_FORMATSPECIFIER: 'FormatSpecifier'>#

TYPE_STEP = <FormatToolTypes.TYPE_STEP: 'Step'>#

TYPE_LIST = <FormatToolTypes.TYPE_LIST: 'List'>#

class Frame(impl: Any)#

Bases: Item, DefaultMixin

An optional set of known data provided to a HyperStudy approach. This data is not collected during the evaluation phase and is known in advance; this is in contrast to the data in the Run matrix, which is typically collected at the time of a run. How the information is used varies from approach to approach and method to method.

getAvailableOriginTypes() → List[OriginTypes]#

Get the available types for the Origin attribute.

Returns:: A list of types for the Origin attribute
Return type:: List[OriginTypes]

getOrigin() → FrameSource#

Get the value of the Origin attribute.

Returns:: The source or origin tool.
Return type:: FrameSource

See also

OriginTypes

getOriginType() → OriginTypes#

Returns:: The type of the Origin attribute.
Return type:: OriginTypes

getPercentInput() → float#

Get the value of the PercentInput attribute.

Returns:: Data frame or matrix input/testing split in percent.
Return type:: float

Get the value of the RunCountUserInterface attribute.

Returns:: The number of runs in the frame, formatted for the GUI.
Return type:: hstApiVariant

getSource() → str#

Get the value of the Source attribute.

Returns:: The path to the CSV file containing the Frame data.
Return type:: str

getSourceSettings() → str#

Get the value of the SourceSettings attribute.

Returns:: Either the approach varname for the other frame or the path to the text file to import.
Return type:: str

getState() → bool#

Get the value of the State attribute.

Returns:: If True, the frame data will be used in the design.
Return type:: bool

getType() → str#

Get the value of the Type attribute.

Returns:

The name of how the Frame is used.

Input Data will be used to create the fit and tune its parameters.
Testing Data will be used to assess the quality of the fit.
InputAndTesting Data can be partitioned into input and testing by specifying the number of runs or percentage.
Inclusion Data is included in the run matrix.

Return type:

str

getViewEditUserInterface() → str#

Get the value of the ViewEditUserInterface attribute.

Returns:: This attribute is meant for internal use.
Return type:: str

setOriginType(value: OriginTypes) → None#

Parameters:: value (OriginTypes) – The type of the Origin attribute.
Returns:: None

setPercentInput(value: float) → None#

Set the value of the PercentInput attribute.

Parameters:: value (float) – Data frame or matrix input/testing split in percent.

setSource(value: str) → None#

Set the value of the Source attribute.

Parameters:: value (str) – The path to the CSV file containing the Frame data.

setSourceSettings(value: str) → None#

Set the value of the SourceSettings attribute.

Parameters:: value (str) – Either the approach varname for the other frame or the path to the text file to import.

setState(value: bool) → None#

Set the value of the State attribute.

Parameters:: value (bool) – If True, the frame data will be used in the design.

setType(value: str) → None#

Set the value of the Type attribute.

Parameters:

value (str) –

The name of how the Frame is used.

Input Data will be used to create the fit and tune its parameters.
Testing Data will be used to assess the quality of the fit.
InputAndTesting Data can be partitioned into input and testing by specifying the number of runs or percentage.
Inclusion Data is included in the run matrix.

class FrameFilter(impl: Any)#

Bases: Item, DefaultMixin

Conditions for filtering out Frame data from being used during evaluation.

getState() → bool#

Get the value of the State attribute.

Returns:: If True, the FrameFilter is active and will be used when design specifications are applied.
Return type:: bool

setState(value: bool) → None#

Set the value of the State attribute.

Parameters:: value (bool) – If True, the FrameFilter is active and will be used when design specifications are applied.

class FrameFilterList(impl: Any)#

Bases: ItemList[FrameFilter], DefaultMixin

A list of FrameFilter instances.

class FrameList(impl: Any)#

Bases: ItemList[Frame], DefaultMixin

A list of Frame instances.

class FrameSource(impl: Any)#

Bases: Object, DefaultMixin

A source of data for the parent Frame Object.

class FrameSource_Approach(impl: Any)#

Bases: FrameSource, DefaultMixin

A source for an inclusion matrix where the data comes from another Approach.

getApproach() → str#

Get the value of the Approach attribute.

Returns:: The varname of the referenced Approach.
Return type:: str

setApproach(value: str) → None#

Set the value of the Approach attribute.

Parameters:: value (str) – The varname of the referenced Approach.

class FrameSource_Internal(impl: Any)#

Bases: FrameSource, DefaultMixin

A source for an inclusion matrix where the data is internally defined.

class FrameSource_PlainText(impl: Any)#

Bases: FrameSource, DefaultMixin

A source for an inclusion matrix where the data comes from a file.

getFileSettings() → ImportFileImporter#

Get the value of the FileSettings attribute.

Returns:: This attribute is meant for internal use.
Return type:: ImportFileImporter

getMappingList() → ImportFilePersistedMappingList#

Get the value of the MappingList attribute.

Returns:: The list of Mapping Objects.
Return type:: ImportFilePersistedMappingList

See also

ImportFilePersistedMapping

class FunctionItem(impl: Any)#

Bases: Item, DefaultMixin

A function that can be used inside a Templex expression.

getCategory() → str#

Get the value of the Category attribute.

Returns:

What type of function it is.

Python A Python function.
External An externally defined function.
Internal An internally defined function.
General A general use function.
Math and Trigonometry Functions for general mathematical and trigonometric calculations.
Statistical Functions for statistical calculations.
Python-Bridge Functions for evaluating and accessing Python code.
Tcl-Bridge Functions for evaluating and accessing Tcl code.
Text Functions for manipulating and processing text.

Return type:

str

getFileName() → str#

Get the value of the FileName attribute.

Returns:: The path to the referenced file.
Return type:: str

getFunctionName() → str#

Get the value of the FunctionName attribute.

Returns:: Name of the function. e.g. sort, max, etc.
Return type:: str

getNumberOfArguments() → int#

Get the value of the NumberOfArguments attribute.

Returns:: The number of arguments that the function accepts.
Return type:: int

setCategory(value: str) → None#

Set the value of the Category attribute.

Parameters:

value (str) –

What type of function it is.

Python A Python function.
External An externally defined function.
Internal An internally defined function.
General A general use function.
Math and Trigonometry Functions for general mathematical and trigonometric calculations.
Statistical Functions for statistical calculations.
Python-Bridge Functions for evaluating and accessing Python code.
Tcl-Bridge Functions for evaluating and accessing Tcl code.
Text Functions for manipulating and processing text.

setFileName(value: str) → None#

Set the value of the FileName attribute.

Parameters:: value (str) – The path to the referenced file.

setFunctionName(value: str) → None#

Set the value of the FunctionName attribute.

Parameters:: value (str) – Name of the function. e.g. sort, max, etc.

setNumberOfArguments(value: int) → None#

Set the value of the NumberOfArguments attribute.

Parameters:: value (int) – The number of arguments that the function accepts.

class FunctionList(impl: Any)#

Bases: ItemList[FunctionItem], DefaultMixin

A list of FunctionItem instances.

class Goal(impl: Any)#

Bases: DefinitionItem, DefaultMixin

Goals are used to define objectives and constraints. Objectives are metrics to be minimized or maximized in an optimization exploration. Minimizing mass to find a lightweight design is a common example. Constraints need to be satisfied for an optimization to be acceptable. Constraints may also be associated with a DOE. While not used in the evaluation of the DOE, constraints can be useful while visualizing DOE results. Limits on displacement or stress are common examples.

getBoundType() → str#

Get the value of the BoundType attribute.

Returns:

The operator to use to determine if a goal is achieved.

>= The value of the output must be greater than or equal to the goal’s threshold value.
<= The value of the output must be less than or equal to the goal’s bound value.
== The value of the output must be equal to the goal’s bound value, within the specified tolerance.

Return type:

str

getBoundValue() → float#

Get the value of the BoundValue attribute.

Returns:: The value to compare the output against to determine if the constraint is violated.
Return type:: float

getDetailOneUserInterface() → str#

Get the value of the DetailOneUserInterface attribute.

Returns:: Details about the Goal, formatted for the GUI.
Return type:: str

Get the value of the DetailTwoUserInterface attribute.

Returns:: The configuration values specific to the Goal type.
Return type:: hstApiVariant

getResponse() → str#

Get the value of the Response attribute.

Returns:: The varname of the output that the Goal is applied on.
Return type:: str

getResponseUserInterface() → str#

Get the value of the ResponseUserInterface attribute.

Returns:: The formatted name of the response that the Goal is applied on.
Return type:: str

Get the value of the TestRunValue attribute.

Returns:: The Test Approach value.
Return type:: hstApiVariant

getType() → str#

Get the value of the Type attribute.

Returns:

The name of the current goal type.

Maximize Maximize the output value.
Minimize Minimize the output value.
MaxMin Used to solve problems where the minimum of an output response is maximized.
MinMax Used to solve problems where the maximum of an output response is minimized.
MaximizeWeightedSum Maximize the weighted sum of all objectives.
MinimizeWeightedSum Minimize the weighted sum of all objectives.
ProbabilisticConstraint
ArrayConstraint
Constraint
MinimizeMaximum For vector goals, minimize the maximum value in the vector.
MaximizeMinimum For vector goals, maximize the minimum value in the vector.
MinimizeAverage For vector goals, minimize the average value of the vector.
MaximizeAverage For vector goals, maximize the average value of the vector.
SystemIdentification Attempts to minimize the difference between the output response values and the target values of selected objectives.

Return type:

str

getTypeSpecificValue() → float#

Get the value of the TypeSpecificValue attribute.

Returns:: The additional parameter for the Goal. For System Identification, this is the target value of the selected objectives. For MinMax or MaxMin, this is the reference value. For Maximize/Minimize Weighted Sum, this is the weight. For Probabilistic Constraint, this is the cumulative distribution function (CDF).
Return type:: float

getTypeUserInterface() → str#

Get the value of the TypeUserInterface attribute.

Returns:: User displayed column choices for Type - this limits choices to Minimize, Maximize, Constraint, and advanced options.
Return type:: str

setBoundType(value: str) → None#

Set the value of the BoundType attribute.

Parameters:

value (str) –

The operator to use to determine if a goal is achieved.

>= The value of the output must be greater than or equal to the goal’s threshold value.
<= The value of the output must be less than or equal to the goal’s bound value.
== The value of the output must be equal to the goal’s bound value, within the specified tolerance.

setBoundValue(value: float) → None#

Set the value of the BoundValue attribute.

Parameters:: value (float) – The value to compare the output against to determine if the constraint is violated.

setDetailOneUserInterface(value: str) → None#

Set the value of the DetailOneUserInterface attribute.

Parameters:: value (str) – Details about the Goal, formatted for the GUI.

Set the value of the DetailTwoUserInterface attribute.

Parameters:: value (hstApiVariant) – The configuration values specific to the Goal type.

setResponse(value: str) → None#

Set the value of the Response attribute.

Parameters:: value (str) – The varname of the output that the Goal is applied on.

setResponseUserInterface(value: str) → None#

Set the value of the ResponseUserInterface attribute.

Parameters:: value (str) – The formatted name of the response that the Goal is applied on.

setType(value: str) → None#

Set the value of the Type attribute.

Parameters:

value (str) –

The name of the current goal type.

Maximize Maximize the output value.
Minimize Minimize the output value.
MaxMin Used to solve problems where the minimum of an output response is maximized.
MinMax Used to solve problems where the maximum of an output response is minimized.
MaximizeWeightedSum Maximize the weighted sum of all objectives.
MinimizeWeightedSum Minimize the weighted sum of all objectives.
ProbabilisticConstraint
ArrayConstraint
Constraint
MinimizeMaximum For vector goals, minimize the maximum value in the vector.
MaximizeMinimum For vector goals, maximize the minimum value in the vector.
MinimizeAverage For vector goals, minimize the average value of the vector.
MaximizeAverage For vector goals, maximize the average value of the vector.
SystemIdentification Attempts to minimize the difference between the output response values and the target values of selected objectives.

setTypeSpecificValue(value: float) → None#

Set the value of the TypeSpecificValue attribute.

Parameters:: value (float) – The additional parameter for the Goal. For System Identification, this is the target value of the selected objectives. For MinMax or MaxMin, this is the reference value. For Maximize/Minimize Weighted Sum, this is the weight. For Probabilistic Constraint, this is the cumulative distribution function (CDF).

setTypeUserInterface(value: str) → None#

Set the value of the TypeUserInterface attribute.

Parameters:: value (str) – User displayed column choices for Type - this limits choices to Minimize, Maximize, Constraint, and advanced options.

class GoalList(impl: Any)#

Bases: DefinitionItemList[Goal], DefaultMixin

A list of Goal instances.

getConstraintBoundaries() → str#

Get the value of the ConstraintBoundaries attribute.

Returns:

How constraint boundary violations should be handled.

Standard Constraints are considered acceptable if they exceed the bounds within the tolerance limit.
Strict Constraints must be perfectly satisfied with no tolerance. This type of enforcement may require additional iterations from an optimizer for convergence.

Return type:

str

getPercentTolerance() → float#

Get the value of the PercentTolerance attribute.

Returns:: Constraint bound tolerance in percent.
Return type:: float

getToleranceAtZero() → float#

Get the value of the ToleranceAtZero attribute.

Returns:: The absolute tolerance that should be used if the Goal’s bound value is zero.
Return type:: float

setConstraintBoundaries(value: str) → None#

Set the value of the ConstraintBoundaries attribute.

Parameters:

value (str) –

How constraint boundary violations should be handled.

Standard Constraints are considered acceptable if they exceed the bounds within the tolerance limit.
Strict Constraints must be perfectly satisfied with no tolerance. This type of enforcement may require additional iterations from an optimizer for convergence.

setPercentTolerance(value: float) → None#

Set the value of the PercentTolerance attribute.

Parameters:: value (float) – Constraint bound tolerance in percent.

setToleranceAtZero(value: float) → None#

Set the value of the ToleranceAtZero attribute.

Parameters:: value (float) – The absolute tolerance that should be used if the Goal’s bound value is zero.

class Gradient(impl: Any)#

Bases: ScalarVariable, DefaultMixin

Gradients calculate the change of the output responses with respect to the input variables. The gradient information can be used in gradient enabled methods inside of a DOE, Fit, Optimization, or Stochastic approaches.

getAlwaysZero() → bool#

Get the value of the AlwaysZero attribute.

Returns:: If True, the Gradient will always evaluate to 0.
Return type:: bool

getDerivativeOf() → str#

Get the value of the DerivativeOf attribute.

Returns:: The varname of the response that’s being used to calculate the Gradient’s value.
Return type:: str

getDuplicate() → bool#

Get the value of the Duplicate attribute.

Returns:: If True, the Output Response that this Gradient is a derivative of and the Input Variable it is with respect to match another Gradient.
Return type:: bool

getExtractAfter() → str#

Get the value of the ExtractAfter attribute.

Returns:: Comma separated list of additional Input Variables, Models, Responses, Gradients, and Data Sources that will be processed before this item. Generally these are auto-detected; Extract After is intended for rare situations where auto-detection is not possible.
Return type:: str

getRespectTo() → str#

Get the value of the RespectTo attribute.

Returns:: This is generally the Input Variable but could be a Response for advanced chain rule situations.
Return type:: str

getTestRunValue() → float#

Get the value of the TestRunValue attribute.

Returns:: The Test Approach value.
Return type:: float

setAlwaysZero(value: bool) → None#

Set the value of the AlwaysZero attribute.

Parameters:: value (bool) – If True, the Gradient will always evaluate to 0.

setDerivativeOf(value: str) → None#

Set the value of the DerivativeOf attribute.

Parameters:: value (str) – The varname of the response that’s being used to calculate the Gradient’s value.

setDuplicate(value: bool) → None#

Set the value of the Duplicate attribute.

Parameters:: value (bool) – If True, the Output Response that this Gradient is a derivative of and the Input Variable it is with respect to match another Gradient.

setExtractAfter(value: str) → None#

Set the value of the ExtractAfter attribute.

Parameters:: value (str) – Comma separated list of additional Input Variables, Models, Responses, Gradients, and Data Sources that will be processed before this item. Generally these are auto-detected; Extract After is intended for rare situations where auto-detection is not possible.

setRespectTo(value: str) → None#

Set the value of the RespectTo attribute.

Parameters:: value (str) – This is generally the Input Variable but could be a Response for advanced chain rule situations.

class GradientList(impl: Any)#

Bases: ItemList[Gradient], DefaultMixin

A list of Gradient instances.

class Group(impl: Any)#

Bases: Item, DefaultMixin

A collection of other Group containing folders, Approaches, or Approach steps.

getAvailableGroupToolTypes() → List[GroupToolTypes]#

Get the available types for the GroupTool attribute.

Returns:: A list of types for the GroupTool attribute
Return type:: List[GroupToolTypes]

getGroupTool() → GroupTool#

Get the value of the GroupTool attribute.

Returns:: A GroupTool object.
Return type:: GroupTool

getGroupToolType() → GroupToolTypes#

Returns:: The type of the GroupTool attribute.
Return type:: GroupToolTypes

getType() → str#

Get the value of the Type attribute.

Returns:

The name of the Group type.

Folder The Group defines a folder containing one or more approaches.
Approach The Group defines a single approach.

Return type:

str

setGroupToolType(value: GroupToolTypes) → None#

Parameters:: value (GroupToolTypes) – The type of the GroupTool attribute.
Returns:: None

setType(value: str) → None#

Set the value of the Type attribute.

Parameters:

value (str) –

The name of the Group type.

Folder The Group defines a folder containing one or more approaches.
Approach The Group defines a single approach.

class GroupList(impl: Any)#

Bases: ItemList[Group], DefaultMixin

A list of Group instances.

class GroupTool(impl: Any)#

Bases: Object, DefaultMixin

The tool Object that defines the behavior of its parent Group.

enum GroupToolTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_APPROACH = <GroupToolTypes.TYPE_APPROACH: 'Approach'>#

TYPE_FOLDER = <GroupToolTypes.TYPE_FOLDER: 'Folder'>#

class GroupTool_Approach(impl: Any)#

Bases: GroupTool, DefaultMixin

A Group that defines a single Approach.

getApproachVarname() → str#

Get the value of the ApproachVarname attribute.

Returns:: The varname of the referenced Approach.
Return type:: str

setApproachVarname(value: str) → None#

Set the value of the ApproachVarname attribute.

Parameters:: value (str) – The varname of the referenced Approach.

class GroupTool_ApproachStep(impl: Any)#

Bases: Object, DefaultMixin

A GroupTool that defines the various steps in an Approach.

class GroupTool_Folder(impl: Any)#

Bases: GroupTool, DefaultMixin

A Group that defines a folder containing one or more Approaches.

getGroupList() → GroupList#

Get the value of the GroupList attribute.

Returns:: The list of Group Items.
Return type:: GroupList

See also

Group

getLabel() → str#

Get the value of the Label attribute.

Returns:: Display label of a folder.
Return type:: str

setLabel(value: str) → None#

Set the value of the Label attribute.

Parameters:: value (str) – Display label of a folder.

class ImportFile(impl: Any)#

Bases: Item, DefaultMixin

A file that will be imported into an inclusion matrix.

getDescription() → str#

Get the value of the Description attribute.

Returns:: A string describing the type of data being imported.
Return type:: str

getImporter() → ImportFileImporter#

Get the value of the Importer attribute.

Returns:: This attribute is meant for internal use.
Return type:: ImportFileImporter

getState() → bool#

Get the value of the State attribute.

Returns:: This attribute is meant for internal use.
Return type:: bool

setState(value: bool) → None#

Set the value of the State attribute.

Parameters:: value (bool) – This attribute is meant for internal use.

class ImportFileList(impl: Any)#

Bases: ItemList[ImportFile], DefaultMixin

A list of ImportFile instances.

class ImportFilePersistedMapping(impl: Any)#

Bases: Object, DefaultMixin

A mapping from HyperStudy Items to locations in an inclusion matrix file.

getMapFromColumn() → str#

Get the value of the MapFromColumn attribute.

Returns:: The column name to map data from.
Return type:: str

getMapToVarname() → str#

Get the value of the MapToVarname attribute.

Returns:: The unique identifier to map data to.
Return type:: str

setMapFromColumn(value: str) → None#

Set the value of the MapFromColumn attribute.

Parameters:: value (str) – The column name to map data from.

setMapToVarname(value: str) → None#

Set the value of the MapToVarname attribute.

Parameters:: value (str) – The unique identifier to map data to.

class ImportFilePersistedMappingList(impl: Any)#

Bases: ObjectList[ImportFilePersistedMapping], DefaultMixin

A list of ImportFilePersistedMapping instances.

class ImportTemplate(impl: Any)#

Bases: Item, DefaultMixin

getExtension() → str#

Get the value of the Extension attribute.

Returns:: A comma separated list of file extensions supported by the template reader.
Return type:: str

getFileName() → str#

Get the value of the FileName attribute.

Returns:: The path to the referenced file.
Return type:: str

getType() → str#

Get the value of the Type attribute.

Returns:: Reader type.
Return type:: str

setExtension(value: str) → None#

Set the value of the Extension attribute.

Parameters:: value (str) – A comma separated list of file extensions supported by the template reader.

setFileName(value: str) → None#

Set the value of the FileName attribute.

Parameters:: value (str) – The path to the referenced file.

setType(value: str) → None#

Set the value of the Type attribute.

Parameters:: value (str) – Reader type.

class ImportTemplateList(impl: Any)#

Bases: ItemList[ImportTemplate], DefaultMixin

A list of ImportTemplate instances.

class Item(impl: Any)#

Bases: Object, DefaultMixin

An Object that contains additional information such as a varname, label, creation time, and comment.

getComment() → str#

Get the value of the Comment attribute.

Returns:: User supplied information that’s not used by HyperStudy.
Return type:: str

getCreationTime() → int#

Get the value of the CreationTime attribute.

Returns:: Creation time in seconds.
Return type:: int

getFormattedCreationTime() → str#

Get the value of the FormattedCreationTime attribute.

Returns:: Creation time as a formatted string.
Return type:: str

getLabel() → str#

Get the value of the Label attribute.

Returns:: The display name for the Item.
Return type:: str

getTable()#

getTableTypes()#

getVarname() → str#

Get the value of the Varname attribute.

Returns:: The unique identifier for the Item.
Return type:: str

setComment(value: str) → None#

Set the value of the Comment attribute.

Parameters:: value (str) – User supplied information that’s not used by HyperStudy.

setCreationTime(value: int) → None#

Set the value of the CreationTime attribute.

Parameters:: value (int) – Creation time in seconds.

setLabel(value: str) → None#

Set the value of the Label attribute.

Parameters:: value (str) – The display name for the Item.

setVarname(value: str) → None#

Set the value of the Varname attribute.

Parameters:: value (str) – The unique identifier for the Item.

class ItemList(impl: Any)#

Bases: ObjectList[T], DefaultMixin

A list of Item instances.

add(varname: str = '', label: str = '') → T#

get(varname: str, default: T | None = None) → T | None#

remove(varname: str) → None#

removeAtIndex(idx: int) → None#

class MediaSource(impl: Any)#

Bases: DefinitionItem, DefaultMixin

Media sources contain images produced by processes in their respective run directory. Supported image formats are *.jpg, *.jpeg, *.bmp, and *.png. HyperStudy supports all simulation file formats that are supported by HyperView.

getAvailableMediaSourceToolTypes() → List[MediaSourceToolTypes]#

Get the available types for the MediaSourceTool attribute.

Returns:: A list of types for the MediaSourceTool attribute
Return type:: List[MediaSourceToolTypes]

getMediaSourceTool() → MediaSourceTool#

Get the value of the MediaSourceTool attribute.

Returns:: Access the Media Source Tool.
Return type:: MediaSourceTool

getMediaSourceToolType() → MediaSourceToolTypes#

Returns:: The type of the MediaSourceTool attribute.
Return type:: MediaSourceToolTypes

getModelParameter() → ModelParameter#

Get the value of the ModelParameter attribute.

Returns:: The input or output entity within the Model.
Return type:: ModelParameter

getPreview() → str#

Get the value of the Preview attribute.

Returns:: This attribute is meant for internal use.
Return type:: str

getSource() → str#

Get the value of the Source attribute.

Returns:: The path to the media file.
Return type:: str

getTool() → str#

Get the value of the Tool attribute.

Returns:

The current Media Source tool type.

3D_Visualization 3D media files. All file formats supported by HyperView are allowed.
Image Image files. Supported formats are *.jpg, *.jpeg, *.bmp, and *.png.

Return type:

str

getToolSpecifics() → str#

Get the value of the ToolSpecifics attribute.

Returns:: Serialized version of Media Source tool settings.
Return type:: str

See also

MediaSourceTool

getType() → str#

Get the value of the Type attribute.

Returns:: The name of the type of Media Source.
Return type:: str

See also

MediaSourceToolTypes

setMediaSourceToolType(value: MediaSourceToolTypes) → None#

Parameters:: value (MediaSourceToolTypes) – The type of the MediaSourceTool attribute.
Returns:: None

setSource(value: str) → None#

Set the value of the Source attribute.

Parameters:: value (str) – The path to the media file.

setTool(value: str) → None#

Set the value of the Tool attribute.

Parameters:

value (str) –

The current Media Source tool type.

3D_Visualization 3D media files. All file formats supported by HyperView are allowed.
Image Image files. Supported formats are *.jpg, *.jpeg, *.bmp, and *.png.

setToolSpecifics(value: str) → None#

Set the value of the ToolSpecifics attribute.

Parameters:: value (str) – Serialized version of Media Source tool settings.

See also

MediaSourceTool

setType(value: str) → None#

Set the value of the Type attribute.

Parameters:: value (str) – The name of the type of Media Source.

See also

MediaSourceToolTypes

class MediaSourceList(impl: Any)#

Bases: DefinitionItemList[MediaSource], DefaultMixin

A list of MediaSource instances.

class MediaSourceTool(impl: Any)#

Bases: Object, DefaultMixin

Handles the configuration and processing of a media file for a Media Source.

enum MediaSourceToolTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_3D_VISUALIZATION = <MediaSourceToolTypes.TYPE_3D_VISUALIZATION: '3D_Visualization'>#

TYPE_IMAGE = <MediaSourceToolTypes.TYPE_IMAGE: 'Image'>#

class MediaSourceTool_H3D(impl: Any)#

Bases: MediaSourceTool, DefaultMixin

Handles 3D media files. All file formats supported by HyperView are allowed.

getAverageMode() → str#

Get the value of the AverageMode attribute.

Returns:

How element corner results should be averaged.

simple Tensor and vector components are extracted, and the invariants are computed prior to averaging.
advanced Tensor (or vector) results are transformed into a consistent system and then each component is averaged separately to obtain an average tensor (or vector).
none No averaging is applied.
difference The difference between the maximum and minimum corner results at a node.
maximum Extract the maximum values from the surrounding elements attached to a node.
minimum Extract the minimum values from the surrounding elements attached to a node.
max of corner The maximum value from all corners of an element are extracted and the value is shown at the centroid of the element.
min of corner The minimum value from all corners of an element are extracted and the value is shown at the centroid of the element.
extreme of corner The extreme value from all the corners of an element are extracted and the value is shown at the centroid of the element.

Return type:

str

getComponent() → str#

Get the value of the Component attribute.

Returns:: The data component for the currently specified result type. The available components will vary based on the current result type.
Return type:: str

getFilterMode() → str#

Get the value of the FilterMode attribute.

Returns:

How the value filter should behave.

ge Result values must be greater or equal to the specifed threshold.
le Result values must be less than or equal to the specified theshold.
range Result values must be within the specified range.

Return type:

str

getFilterValues() → List[str]#

Get the value of the FilterValues attribute.

Returns:: The bounds for the results filter. If using a greater or equal than filter (ge) or less than or equal to filter (le), only the lower or upper bound value needs to be given. If using a range filter, both the upper and lower bounds need to be given.
Return type:: List[str]

getLayer() → str#

Get the value of the Layer attribute.

Returns:

The element layer to display a contour for.

Max Displays the maximum value among the layers for each entity.
Min Displays the minimum value among the layers for each entity.
Extreme Displays the maximum absolute values among the layers for each entity.
MaxLayer Identifies and plots the layer by name that contributes to the maximum value for each entity.
MinLayer Identifies and plots the layer by name that contributes to the minimum value for each entity.
Sum Displays the (scalar) sum of all values among the layers for each entity.
Range Displays the difference between the maximum and minimum values among the layers for each entity.
Average Displays the (scalar) average value among the layers which contain data for each entity.
ExtremeLayer Identifies and plots the layer by name that contributes to the extreme (absolute maximum) value for each entity.
Count Displays a count of the layers for the given data type.
Top/Bottom Displays the contour of top and bottom layers in the same plot.

Return type:

str

getLegendMax() → float#

Get the value of the LegendMax attribute.

Returns:: The maximum value for the legend.
Return type:: float

getLegendMaxMode() → str#

Get the value of the LegendMaxMode attribute.

Returns:

How the legend maximum should be determined.

Auto Use the initially supplied model file to determine the value
Custom The value is supplied by the user
RunSpecific The value is determined by the model file for each run

Return type:

str

getLegendMin() → float#

Get the value of the LegendMin attribute.

Returns:: The minimum value for the legend.
Return type:: float

getLegendMinMode() → str#

Get the value of the LegendMinMode attribute.

Returns:

How the legend minimum should be determined.

Auto Use the initially supplied model file to determine the value.
Custom The value is supplied by the user.
RunSpecific The value is determined by the model file for each run.

Return type:

str

getReverseLegend() → bool#

Get the value of the ReverseLegend attribute.

Returns:: If True, the legend minimum and maximum will be reversed.
Return type:: bool

getStep() → int#

Get the value of the Step attribute.

Returns:: The simulation time step index.
Return type:: int

getSubcase() → str#

Get the value of the Subcase attribute.

Returns:: The subcase for the data to be read, specified as a string. Acceptable values are the subcase string (for example, “Subcase 3”).
Return type:: str

getType() → str#

Get the value of the Type attribute.

Returns:: Used as part of the selection process to determine what data should be selected.
Return type:: str

getUseCornerData() → bool#

Get the value of the UseCornerData attribute.

Returns:: If True, the media source viewer will use results values from the corners of each element.
Return type:: bool

setAverageMode(value: str) → None#

Set the value of the AverageMode attribute.

Parameters:

value (str) –

How element corner results should be averaged.

simple Tensor and vector components are extracted, and the invariants are computed prior to averaging.
advanced Tensor (or vector) results are transformed into a consistent system and then each component is averaged separately to obtain an average tensor (or vector).
none No averaging is applied.
difference The difference between the maximum and minimum corner results at a node.
maximum Extract the maximum values from the surrounding elements attached to a node.
minimum Extract the minimum values from the surrounding elements attached to a node.
max of corner The maximum value from all corners of an element are extracted and the value is shown at the centroid of the element.
min of corner The minimum value from all corners of an element are extracted and the value is shown at the centroid of the element.
extreme of corner The extreme value from all the corners of an element are extracted and the value is shown at the centroid of the element.

setComponent(value: str) → None#

Set the value of the Component attribute.

Parameters:: value (str) – The data component for the currently specified result type. The available components will vary based on the current result type.

setFilterMode(value: str) → None#

Set the value of the FilterMode attribute.

Parameters:

value (str) –

How the value filter should behave.

ge Result values must be greater or equal to the specifed threshold.
le Result values must be less than or equal to the specified theshold.
range Result values must be within the specified range.

setFilterValues(value: List[str]) → None#

Set the value of the FilterValues attribute.

Parameters:: value (List[str]) – The bounds for the results filter. If using a greater or equal than filter (ge) or less than or equal to filter (le), only the lower or upper bound value needs to be given. If using a range filter, both the upper and lower bounds need to be given.

setLayer(value: str) → None#

Set the value of the Layer attribute.

Parameters:

value (str) –

The element layer to display a contour for.

Max Displays the maximum value among the layers for each entity.
Min Displays the minimum value among the layers for each entity.
Extreme Displays the maximum absolute values among the layers for each entity.
MaxLayer Identifies and plots the layer by name that contributes to the maximum value for each entity.
MinLayer Identifies and plots the layer by name that contributes to the minimum value for each entity.
Sum Displays the (scalar) sum of all values among the layers for each entity.
Range Displays the difference between the maximum and minimum values among the layers for each entity.
Average Displays the (scalar) average value among the layers which contain data for each entity.
ExtremeLayer Identifies and plots the layer by name that contributes to the extreme (absolute maximum) value for each entity.
Count Displays a count of the layers for the given data type.
Top/Bottom Displays the contour of top and bottom layers in the same plot.

setLegendMax(value: float) → None#

Set the value of the LegendMax attribute.

Parameters:: value (float) – The maximum value for the legend.

setLegendMaxMode(value: str) → None#

Set the value of the LegendMaxMode attribute.

Parameters:

value (str) –

How the legend maximum should be determined.

Auto Use the initially supplied model file to determine the value
Custom The value is supplied by the user
RunSpecific The value is determined by the model file for each run

setLegendMin(value: float) → None#

Set the value of the LegendMin attribute.

Parameters:: value (float) – The minimum value for the legend.

setLegendMinMode(value: str) → None#

Set the value of the LegendMinMode attribute.

Parameters:

value (str) –

How the legend minimum should be determined.

Auto Use the initially supplied model file to determine the value.
Custom The value is supplied by the user.
RunSpecific The value is determined by the model file for each run.

setReverseLegend(value: bool) → None#

Set the value of the ReverseLegend attribute.

Parameters:: value (bool) – If True, the legend minimum and maximum will be reversed.

setStep(value: int) → None#

Set the value of the Step attribute.

Parameters:: value (int) – The simulation time step index.

setSubcase(value: str) → None#

Set the value of the Subcase attribute.

Parameters:: value (str) – The subcase for the data to be read, specified as a string. Acceptable values are the subcase string (for example, “Subcase 3”).

setType(value: str) → None#

Set the value of the Type attribute.

Parameters:: value (str) – Used as part of the selection process to determine what data should be selected.

setUseCornerData(value: bool) → None#

Set the value of the UseCornerData attribute.

Parameters:: value (bool) – If True, the media source viewer will use results values from the corners of each element.

class MediaSourceTool_Image(impl: Any)#

Bases: MediaSourceTool, DefaultMixin

Handles image files. Supported formats are *.jpg, *.jpeg, *.bmp, and *.png.

class MetaData(impl: Any)#

Bases: Object, DefaultMixin

This is used to store additional data on a HyperStudy Object.

getDataList() → List[str]#

Get the value of the DataList attribute.

Returns:: The list of values for the metadata.
Return type:: List[str]

getName() → str#

Get the value of the Name attribute.

Returns:: The name used to identify the MetaData.
Return type:: str

setDataList(value: List[str]) → None#

Set the value of the DataList attribute.

Parameters:: value (List[str]) – The list of values for the metadata.

setName(value: str) → None#

Set the value of the Name attribute.

Parameters:: value (str) – The name used to identify the MetaData.

class MetaDataList(impl: Any)#

Bases: ObjectList[MetaData], DefaultMixin

A list of MetaData instances.

class Model(impl: Any)#

Bases: DefinitionItem, DefaultMixin

The model of the system that is subjected to a study.

getArgument() → str#

Get the value of the Argument attribute.

Returns:: A newline or space separated list of arguments that will be added to the command line when the solver is executed. Newlines can be used to increase readability within the GUI or study file.
Return type:: str

getAvailableModelToolTypes() → List[ModelToolTypes]#

Get the available types for the ModelTool attribute.

Returns:: A list of types for the ModelTool attribute
Return type:: List[ModelToolTypes]

getConditionsUserInterface() → str#

Get the value of the ConditionsUserInterface attribute.

Returns:: A description of the conditons applied to the Model for use in the GUI.
Return type:: str

getEnvironmentVariableList() → EnvironmentVariableList#

Get the value of the EnvironmentVariableList attribute.

Returns:: The list of EnvironmentVariable Objects.
Return type:: EnvironmentVariableList

See also

EnvironmentVariable

getEnvironmentVariablesUserInterface() → str#

Get the value of the EnvironmentVariablesUserInterface attribute.

Returns:: The string used to represent the Model’s environment variable list in the GUI.
Return type:: str

getHstpSchemaVersion() → str#

Get the value of the HstpSchemaVersion attribute.

Returns:: The HSTP file version to use, formatted as “hstp_v_<version #>”.
Return type:: str

getImportModelUserInterface() → str#

Get the value of the ImportModelUserInterface attribute.

Returns:: This attribute is meant for internal use.
Return type:: str

getInputDeck() → str#

Get the value of the InputDeck attribute.

Returns:: The solver input deck.
Return type:: str

Get a metadata value.

Parameters:: name (str) – The key to the MetaData Item.
Returns:: The value stored in the MetaData Item.
Return type:: hstApiVariant

See also

MetaData

getMetaDataCompareUserInterface() → str#

Get the value of the MetaDataCompareUserInterface attribute.

Returns:: Provides editing capability to the entire MetaData list via a special formatted compound string. It’s recommended to access the MetaDataList directly.
Return type:: str

getMetaDataList() → MetaDataList#

Get the value of the MetaDataList attribute.

Returns:: The list of MetaData Objects.
Return type:: MetaDataList

See also

MetaData

getModelResourcesCompareUserInterface() → str#

Get the value of the ModelResourcesCompareUserInterface attribute.

Returns:: Special attribute to perform quick model comparisons and copy&paste operations. It is recommended to interact with the ModelResourceList directly.
Return type:: str

getModelTool() → ModelTool#

Get the value of the ModelTool attribute.

Returns:: The Model Tool object is the parent type for different possible Model Tool implementations.
Return type:: ModelTool

See also

ModelToolTypes
Model.setModelToolType
Model.setTool

getModelToolType() → ModelToolTypes#

Returns:: The type of the ModelTool attribute.
Return type:: ModelToolTypes

getResourceList() → ModelResourceList#

Get the value of the ResourceList attribute.

Returns:: The list of ModelResource Items.
Return type:: ModelResourceList

See also

ModelResource

getRunScript() → str#

Get the value of the RunScript attribute.

Returns:: The name of the solver that will be used during Model execution.
Return type:: str

Get the value of the SequenceIndex attribute.

Returns:: The order in which the Model will be executed relative to the other Models.
Return type:: hstApiVariant

getSettingList() → SettingItemList#

Get the value of the SettingList attribute.

Returns:: The list of SettingItem Items.
Return type:: SettingItemList

See also

SettingItem

getSettingSpecifics() → str#

Get the value of the SettingSpecifics attribute.

Returns:: The settings for the Model as a string.
Return type:: str

getSolverUserInterface() → str#

Get the value of the SolverUserInterface attribute.

Returns:: The name of the current solver type, formatted for the GUI.
Return type:: str

getSource() → str#

Get the value of the Source attribute.

Returns:: The primary resource file for the Model.
Return type:: str

getTestTaskUserInterface() → str#

Get the value of the TestTaskUserInterface attribute.

Returns:: This attribute is meant for internal use.
Return type:: str

getTool() → str#

Get the value of the Tool attribute.

Returns:: The tool object that defines the setting for the specific model type. The available model types are defined in the preference mvw files with *RegisterConnection.
Return type:: str

See also

ModelTool

getType() → str#

Get the value of the Type attribute.

Returns:: The Model type.
Return type:: str

setArgument(value: str) → None#

Set the value of the Argument attribute.

Parameters:: value (str) – A newline or space separated list of arguments that will be added to the command line when the solver is executed. Newlines can be used to increase readability within the GUI or study file.

setHstpSchemaVersion(value: str) → None#

Set the value of the HstpSchemaVersion attribute.

Parameters:: value (str) – The HSTP file version to use, formatted as “hstp_v_<version #>”.

setImportModelUserInterface(value: str) → None#

Set the value of the ImportModelUserInterface attribute.

Parameters:: value (str) – This attribute is meant for internal use.

setInputDeck(value: str) → None#

Set the value of the InputDeck attribute.

Parameters:: value (str) – The solver input deck.

Set a metadata value.

Parameters:

name (str) – The key to the MetaData Item.
value (hstApiVariant) – The value that MetaData Item should hold.

See also

MetaData

setModelToolType(value: ModelToolTypes) → None#

Parameters:: value (ModelToolTypes) – The type of the ModelTool attribute.
Returns:: None

setRunScript(value: str) → None#

Set the value of the RunScript attribute.

Parameters:: value (str) – The name of the solver that will be used during Model execution.

setSettingSpecifics(value: str) → None#

Set the value of the SettingSpecifics attribute.

Parameters:: value (str) – The settings for the Model as a string.

setSolverUserInterface(value: str) → None#

Set the value of the SolverUserInterface attribute.

Parameters:: value (str) – The name of the current solver type, formatted for the GUI.

setSource(value: str) → None#

Set the value of the Source attribute.

Parameters:: value (str) – The primary resource file for the Model.

setTestTaskUserInterface(value: str) → None#

Set the value of the TestTaskUserInterface attribute.

Parameters:: value (str) – This attribute is meant for internal use.

setTool(value: str) → None#

Set the value of the Tool attribute.

Parameters:: value (str) – The tool object that defines the setting for the specific model type. The available model types are defined in the preference mvw files with *RegisterConnection.

See also

ModelTool

class ModelList(impl: Any)#

Bases: DefinitionItemList[Model], DefaultMixin

The list of Model instances.

class ModelParameter(impl: Any)#

Bases: Object, DefaultMixin

A model parameter is a property of the model being studied.

getBindings() → ModelValueBindings#

Get the value of the Bindings attribute.

Returns:: The list of relationships between the parent item and the Model Resource it is associated with. For example, variables imported from additional template resources need to be written to the correct template file during evaluation.
Return type:: ModelValueBindings

getMetaDataList() → MetaDataList#

Get the value of the MetaDataList attribute.

Returns:: The list of MetaData Objects.
Return type:: MetaDataList

See also

MetaData

getModelVarname() → str#

Get the value of the ModelVarname attribute.

Returns:: The unique identifier of the Model.
Return type:: str

getName() → str#

Get the value of the Name attribute.

Returns:: The name that the Model connection is referring to the input or output entity by.
Return type:: str

getUnit() → Unit#

Get the value of the Unit attribute.

Returns:: The Unit object for this Model Parameter.
Return type:: Unit

setModelVarname(value: str) → None#

Set the value of the ModelVarname attribute.

Parameters:: value (str) – The unique identifier of the Model.

setName(value: str) → None#

Set the value of the Name attribute.

Parameters:: value (str) – The name that the Model connection is referring to the input or output entity by.

class ModelResource(impl: Any)#

Bases: Item, DefaultMixin

A Model Resource is an association between a file or directory and a Model. Operations may be applied on these resources, such as write, copy, or move.

getAutoGenerated() → bool#

Get the value of the AutoGenerated attribute.

Returns:: If True, the Model Resource was created automatically during the import step. This will trigger additional warnings if the Model Resource is removed since it is likely needed by the model for evaluation.
Return type:: bool

getAvailableModelResourceToolTypes() → List[ModelResourceToolTypes]#

Get the available types for the ModelResourceTool attribute.

Returns:: A list of types for the ModelResourceTool attribute
Return type:: List[ModelResourceToolTypes]

getFormat() → str#

Get the value of the Format attribute.

Returns:
Return type:: str

getModelResourceTool() → ModelResourceTool#

Get the value of the ModelResourceTool attribute.

Returns:: The Model Resource Tool object.
Return type:: ModelResourceTool

getModelResourceToolType() → ModelResourceToolTypes#

Returns:: The type of the ModelResourceTool attribute.
Return type:: ModelResourceToolTypes

getOperation() → str#

Get the value of the Operation attribute.

Returns:

The operation to apply to the model resource.

WriteInput Write the primary resource to the run directory.
Copy Copy the resource file to the run directory.
CopyContent Copy the contents of the resource folder to the run directory.
Move Move the resource folder to the run directory.
MoveContent Move the contents of the resource folder to the run directory.
None Do nothing.
WriteTemplate Fill and write a template (*.tpl) resource file to the run directory.

Return type:

str

getPathLocal() → str#

Get the value of the PathLocal attribute.

Returns:: The path of the Model Resource after copy/move/write operations are applied to it.
Return type:: str

getPathOrigin() → str#

Get the value of the PathOrigin attribute.

Returns:: The URI of the source of the Model Resource file or folder.
Return type:: str

getRole() → str#

Get the value of the Role attribute.

Returns:

The resource type.

file The resource is a single file
folder The resource is a directory

Return type:

str

getTool() → str#

Get the value of the Tool attribute.

Returns:

The name of the current Model Resource Tool type.

Input The resource serves as an input to the model evaluation.
Output The resource is an output from the model evaluation.
Link The resource is an output from a different model.

Return type:

str

setAutoGenerated(value: bool) → None#

Set the value of the AutoGenerated attribute.

Parameters:: value (bool) – If True, the Model Resource was created automatically during the import step. This will trigger additional warnings if the Model Resource is removed since it is likely needed by the model for evaluation.

setFormat(value: str) → None#

Set the value of the Format attribute.

Parameters:: value (str)

setModelResourceToolType(value: ModelResourceToolTypes) → None#

Parameters:: value (ModelResourceToolTypes) – The type of the ModelResourceTool attribute.
Returns:: None

setOperation(value: str) → None#

Set the value of the Operation attribute.

Parameters:

value (str) –

The operation to apply to the model resource.

WriteInput Write the primary resource to the run directory.
Copy Copy the resource file to the run directory.
CopyContent Copy the contents of the resource folder to the run directory.
Move Move the resource folder to the run directory.
MoveContent Move the contents of the resource folder to the run directory.
None Do nothing.
WriteTemplate Fill and write a template (*.tpl) resource file to the run directory.

setPathLocal(value: str) → None#

Set the value of the PathLocal attribute.

Parameters:: value (str) – The path of the Model Resource after copy/move/write operations are applied to it.

setPathOrigin(value: str) → None#

Set the value of the PathOrigin attribute.

Parameters:: value (str) – The URI of the source of the Model Resource file or folder.

setRole(value: str) → None#

Set the value of the Role attribute.

Parameters:

value (str) –

The resource type.

file The resource is a single file
folder The resource is a directory

setTool(value: str) → None#

Set the value of the Tool attribute.

Parameters:

value (str) –

The name of the current Model Resource Tool type.

Input The resource serves as an input to the model evaluation.
Output The resource is an output from the model evaluation.
Link The resource is an output from a different model.

class ModelResourceList(impl: Any)#

Bases: ItemList[ModelResource], DefaultMixin

The list of ModelResource instances.

class ModelResourceTool(impl: Any)#

Bases: Object, DefaultMixin

Handles the configuration and processing of a resource file for a Model Resource.

enum ModelResourceToolTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_INPUT = <ModelResourceToolTypes.TYPE_INPUT: 'Input'>#

TYPE_OUTPUT = <ModelResourceToolTypes.TYPE_OUTPUT: 'Output'>#

TYPE_LINK = <ModelResourceToolTypes.TYPE_LINK: 'Link'>#

class ModelResourceTool_Input(impl: Any)#

Bases: ModelResourceTool, DefaultMixin

A file that does not change.

class ModelResourceTool_Link(impl: Any)#

Bases: ModelResourceTool, DefaultMixin

An Output File or Output Folder that changes with each run.

getLink() → str#

Get the value of the Link attribute.

Returns:: Varname of another Model Resource, thereby linking them.
Return type:: str

setLink(value: str) → None#

Set the value of the Link attribute.

Parameters:: value (str) – Varname of another Model Resource, thereby linking them.

class ModelResourceTool_Output(impl: Any)#

Bases: ModelResourceTool, DefaultMixin

Tags a file or folder that can be referenced by a link resource.

class ModelTool(impl: Any)#

Bases: Object, DefaultMixin

The tool Object that defines the behavior of its parent Model.

enum ModelToolTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_HST_TPL = <ModelToolTypes.TYPE_HST_TPL: 'hst_tpl'>#

TYPE_HST_RADIOSS = <ModelToolTypes.TYPE_HST_RADIOSS: 'hst_radioss'>#

TYPE_HST_OPTISTRUCT = <ModelToolTypes.TYPE_HST_OPTISTRUCT: 'hst_optistruct'>#

TYPE_HST_PAISHAPE = <ModelToolTypes.TYPE_HST_PAISHAPE: 'hst_paishape'>#

TYPE_HST_HM = <ModelToolTypes.TYPE_HST_HM: 'hst_hm'>#

TYPE_HST_PYFIT = <ModelToolTypes.TYPE_HST_PYFIT: 'hst_pyfit'>#

TYPE_HST_FEKO = <ModelToolTypes.TYPE_HST_FEKO: 'hst_feko'>#

TYPE_HST_FLUX = <ModelToolTypes.TYPE_HST_FLUX: 'hst_flux'>#

TYPE_HST_FLUXMOTOR = <ModelToolTypes.TYPE_HST_FLUXMOTOR: 'hst_fluxmotor'>#

TYPE_HST_MV = <ModelToolTypes.TYPE_HST_MV: 'hst_mv'>#

TYPE_HST_OPERATOR = <ModelToolTypes.TYPE_HST_OPERATOR: 'hst_operator'>#

TYPE_HST_INSPIRE_STUDIO = <ModelToolTypes.TYPE_HST_INSPIRE_STUDIO: 'hst_inspire_studio'>#

TYPE_HST_FLOW_SIM = <ModelToolTypes.TYPE_HST_FLOW_SIM: 'hst_flow_sim'>#

TYPE_HST_KNOWLEDGE_STUDIO = <ModelToolTypes.TYPE_HST_KNOWLEDGE_STUDIO: 'hst_knowledge_studio'>#

TYPE_HST_HV = <ModelToolTypes.TYPE_HST_HV: 'hst_hv'>#

TYPE_HST_LOOKUP = <ModelToolTypes.TYPE_HST_LOOKUP: 'hst_lookup'>#

TYPE_HST_INSPIRE = <ModelToolTypes.TYPE_HST_INSPIRE: 'hst_inspire'>#

TYPE_TWINACTIVATE = <ModelToolTypes.TYPE_TWINACTIVATE: 'twinactivate'>#

TYPE_HST_SPREADSHEET = <ModelToolTypes.TYPE_HST_SPREADSHEET: 'hst_spreadsheet'>#

TYPE_HST_BPREPROC = <ModelToolTypes.TYPE_HST_BPREPROC: 'hst_bpreproc'>#

TYPE_HST_WORKBENCH = <ModelToolTypes.TYPE_HST_WORKBENCH: 'hst_workbench'>#

TYPE_HST_SIMLAB = <ModelToolTypes.TYPE_HST_SIMLAB: 'hst_simlab'>#

TYPE_HST_EXISITING_DATA = <ModelToolTypes.TYPE_HST_EXISITING_DATA: 'hst_exisiting_data'>#

TYPE_FMU = <ModelToolTypes.TYPE_FMU: 'fmu'>#

TYPE_HST_INTERNAL_MATH = <ModelToolTypes.TYPE_HST_INTERNAL_MATH: 'hst_internal_math'>#

class ModelValueBindings(impl: Any)#

Bases: Object, DefaultMixin

Provides associations between a Variable and one or more Model Resources. This ensures that Variable updates are only provided for files from which they originated.

See also

ModelResource

getPrimary() → bool#

Get the value of the Primary attribute.

Returns:: If True, the binding is to the primary Model Resource.
Return type:: bool

getResources() → List[str]#

Get the value of the Resources attribute.

Returns:: The list of Model Resource varnames that are associated with the binding.
Return type:: List[str]

setPrimary(value: bool) → None#

Set the value of the Primary attribute.

Parameters:: value (bool) – If True, the binding is to the primary Model Resource.

setResources(value: List[str]) → None#

Set the value of the Resources attribute.

Parameters:: value (List[str]) – The list of Model Resource varnames that are associated with the binding.

enum NominalDesignTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_NOM = <NominalDesignTypes.TYPE_NOM: 'Nom'>#

TYPE_CHK = <NominalDesignTypes.TYPE_CHK: 'Chk'>#

TYPE_SWEEP = <NominalDesignTypes.TYPE_SWEEP: 'Sweep'>#

TYPE_DOPT = <NominalDesignTypes.TYPE_DOPT: 'DOpt'>#

TYPE_FULLFACT = <NominalDesignTypes.TYPE_FULLFACT: 'FullFact'>#

TYPE_CCD = <NominalDesignTypes.TYPE_CCD: 'Ccd'>#

TYPE_FRACFACT = <NominalDesignTypes.TYPE_FRACFACT: 'FracFact'>#

TYPE_PLACKBURM = <NominalDesignTypes.TYPE_PLACKBURM: 'PlackBurm'>#

TYPE_BOX = <NominalDesignTypes.TYPE_BOX: 'Box'>#

TYPE_HAMMERSLEY = <NominalDesignTypes.TYPE_HAMMERSLEY: 'Hammersley'>#

TYPE_LATINHYPERCUBE = <NominalDesignTypes.TYPE_LATINHYPERCUBE: 'LatinHyperCube'>#

TYPE_MELS = <NominalDesignTypes.TYPE_MELS: 'Mels'>#

TYPE_SOBOL = <NominalDesignTypes.TYPE_SOBOL: 'Sobol'>#

TYPE_RUNMATRIX = <NominalDesignTypes.TYPE_RUNMATRIX: 'RunMatrix'>#

TYPE_USER = <NominalDesignTypes.TYPE_USER: 'User'>#

TYPE_TAGUCHI = <NominalDesignTypes.TYPE_TAGUCHI: 'Taguchi'>#

TYPE_INITIAL = <NominalDesignTypes.TYPE_INITIAL: 'Initial'>#

TYPE_EMPTY = <NominalDesignTypes.TYPE_EMPTY: 'Empty'>#

TYPE_FILLRANDOM = <NominalDesignTypes.TYPE_FILLRANDOM: 'FillRandom'>#

TYPE_FILLSTATISTICS = <NominalDesignTypes.TYPE_FILLSTATISTICS: 'FillStatistics'>#

TYPE_SIMPLE = <NominalDesignTypes.TYPE_SIMPLE: 'Simple'>#

TYPE_VOID = <NominalDesignTypes.TYPE_VOID: 'Void'>#

class Object(impl: Any)#

Bases: _ApiObjectInterface, DefaultMixin

The base class for all HyperStudy Objects.

getClassName() → str#

Get the value of the ClassName attribute.

Returns:: The class name of the Object.
Return type:: str

isClass(className: str) → bool#

Checks whether the Item’s class name matches the given class name.

Parameters:: className (str) – The class name to check.
Returns:: True if the class name of the object matches the given class name.
Return type:: bool

class ObjectList(impl: Any)#

Bases: Object, _HstIterator[T], DefaultMixin

A list of HyperStudy instances.

__len__() → int#

add() → T#

getActiveCount() → int#

Get the value of the ActiveCount attribute.

Returns:: The number of Objects in the list where the state is True.
Return type:: int

getAtIndex(idx: int) → T#

getCount() → int#

Get the value of the Count attribute.

Returns:: The number of elements in the list.
Return type:: int

getName() → str#

enum OptimizationDesignTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_ARSM = <OptimizationDesignTypes.TYPE_ARSM: 'ARSM'>#

TYPE_GRSM = <OptimizationDesignTypes.TYPE_GRSM: 'GRSM'>#

TYPE_HMMO = <OptimizationDesignTypes.TYPE_HMMO: 'HMMO'>#

TYPE_SQP = <OptimizationDesignTypes.TYPE_SQP: 'SQP'>#

TYPE_MFD = <OptimizationDesignTypes.TYPE_MFD: 'MFD'>#

TYPE_GA = <OptimizationDesignTypes.TYPE_GA: 'GA'>#

TYPE_MOGA = <OptimizationDesignTypes.TYPE_MOGA: 'MOGA'>#

TYPE_SORA = <OptimizationDesignTypes.TYPE_SORA: 'SORA'>#

TYPE_SORA_ARSM = <OptimizationDesignTypes.TYPE_SORA_ARSM: 'SORA_ARSM'>#

TYPE_SRO = <OptimizationDesignTypes.TYPE_SRO: 'SRO'>#

TYPE_VOID = <OptimizationDesignTypes.TYPE_VOID: 'Void'>#

enum OriginTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_APPROACH = <OriginTypes.TYPE_APPROACH: 'Approach'>#

TYPE_INTERNAL = <OriginTypes.TYPE_INTERNAL: 'Internal'>#

TYPE_TEXTFILE = <OriginTypes.TYPE_TEXTFILE: 'TextFile'>#

class PerturbationBase(impl: Any)#

Bases: Object, DefaultMixin

Base class for all other perturbation classes.

class Perturbation_AdaptiveFit(impl: Any)#

Bases: Perturbation_Single, DefaultMixin

A design used by the the Adaptive Fit Approach.

See also

ApproachTool_AdaptiveFit

getFilterEntireRow() → bool#

Get the value of the FilterEntireRow attribute.

Returns:: If True, ignore the entirety of runs with bad numbers, otherwise just the bad numbers will be ignored.
Return type:: bool

setFilterEntireRow(value: bool) → None#

Set the value of the FilterEntireRow attribute.

Parameters:: value (bool) – If True, ignore the entirety of runs with bad numbers, otherwise just the bad numbers will be ignored.

class Perturbation_None(impl: Any)#

Bases: PerturbationBase, DefaultMixin

The perturbation used by the test Approach.

See also

Approach_Test

ApproachTool_Test

class Perturbation_Optimization(impl: Any)#

Bases: Perturbation_Single, DefaultMixin

A perturbation used by the the Optimization Approach.

See also

ApproachTool_Optimization

class Perturbation_SamplingBase(impl: Any)#

Bases: Perturbation_Single, DefaultMixin

Base class for all other sampling perturbation classes.

class Perturbation_SamplingStandard(impl: Any)#

Bases: Perturbation_SamplingBase, DefaultMixin

Used by Basic, DOE, and Nominal Approaches.

See also

ApproachTool_Basic
ApproachTool_Doe
ApproachTool_Nominal

class Perturbation_SamplingStochastic(impl: Any)#

Bases: Perturbation_SamplingBase, DefaultMixin

Use by Stochastic Approaches.

See also

ApproachTool_Stochastics

getUseCorrelation() → bool#

Get the value of the UseCorrelation attribute.

Returns:: Use the correlation matrix to create desired correlations.
Return type:: bool

setUseCorrelation(value: bool) → None#

Set the value of the UseCorrelation attribute.

Parameters:: value (bool) – Use the correlation matrix to create desired correlations.

class Perturbation_Single(impl: Any)#

Bases: PerturbationBase, DefaultMixin

Base class for perturbations that use the HyperStudy mathematics algorithms.

class Perturbation_Verify(impl: Any)#

Bases: PerturbationBase, DefaultMixin

Base class for all other verification perturbation classes.

getApproachVarname() → str#

Get the value of the ApproachVarname attribute.

Returns:: The varname of the referenced Approach.
Return type:: str

setApproachVarname(value: str) → None#

Set the value of the ApproachVarname attribute.

Parameters:: value (str) – The varname of the referenced Approach.

class Perturbation_VerifyOptimal(impl: Any)#

Bases: Perturbation_Verify, DefaultMixin

A perturbation that is used to verify the correctness of the optimal points found by a fit-based optimization Approach.

See also

ApproachTool_Optimization

class Perturbation_VerifyPoints(impl: Any)#

Bases: Perturbation_Verify, DefaultMixin

A perturbation that is used to verify the correctness of the points found by a fit-based Approach.

getEvaluationIndexList() → List[str]#

Get the value of the EvaluationIndexList attribute.

Returns:: The list of runs to verify.
Return type:: List[str]

getEvaluationIndexListUserInterface() → str#

Get the value of the EvaluationIndexListUserInterface attribute.

Returns:: The list of runs to verify, as a comma separated string.
Return type:: str

setEvaluationIndexList(value: List[str]) → None#

Set the value of the EvaluationIndexList attribute.

Parameters:: value (List[str]) – The list of runs to verify.

setEvaluationIndexListUserInterface(value: str) → None#

Set the value of the EvaluationIndexListUserInterface attribute.

Parameters:: value (str) – The list of runs to verify, as a comma separated string.

class Perturbation_VerifyTradeOff(impl: Any)#

Bases: Perturbation_Verify, DefaultMixin

A perturbation that is used to verify the correctness of values found in a fit- based trade-off.

getInputListUserInterface() → str#

Get the value of the InputListUserInterface attribute.

Returns:: User interface attribute that combines input names and values used for easy copy & paste. It is recommended to use the InputNames and InputValues attributes directly instead.
Return type:: str

getInputNames() → List[str]#

Get the value of the InputNames attribute.

Returns:: List of varnames of inputs used for the trade-off. Otherwise the nominal value will be used as a default.
Return type:: List[str]

getInputValues() → List[str]#

Get the value of the InputValues attribute.

Returns:: List of values used for the trade-off. Otherwise the nominal value will be used as a default.
Return type:: List[str]

setInputListUserInterface(value: str) → None#

Set the value of the InputListUserInterface attribute.

Parameters:: value (str) – User interface attribute that combines input names and values used for easy copy & paste. It is recommended to use the InputNames and InputValues attributes directly instead.

setInputNames(value: List[str]) → None#

Set the value of the InputNames attribute.

Parameters:: value (List[str]) – List of varnames of inputs used for the trade-off. Otherwise the nominal value will be used as a default.

setInputValues(value: List[str]) → None#

Set the value of the InputValues attribute.

Parameters:: value (List[str]) – List of values used for the trade-off. Otherwise the nominal value will be used as a default.

class PreferenceItem(impl: Any)#

Bases: Item, DefaultMixin

An Item defined in a preference file.

getPreferenceFile() → str#

Get the value of the PreferenceFile attribute.

Returns:: In case of a HyperStudy or HyperWorks preference source type, this says which preference file it is found in.
Return type:: str

getPreferenceSourceType() → str#

Get the value of the PreferenceSourceType attribute.

Returns:

For item derived from the class, the source type indicates where it was defined.

HyperStudy The preference is set in the HyperStudy settings file (*.xml).
HyperWorks The preference is set in the HyperWorks prefernces file (*.mvw).
Internal The preference is managed internally by HyperStudy.
Environment Variable The preference is set using an environment variable.
Unknown The preference source is unknown. This is usually an error.

Return type:

str

class Profile(impl: Any)#

Bases: Item, DefaultMixin

Used to determine the level of tabs displayed in the work area.

getDescription() → str#

Get the value of the Description attribute.

Returns:: The description of the profile.
Return type:: str

getPath() → str#

Get the value of the Path attribute.

Returns:: The path to the XML file defining the profile.
Return type:: str

class ProfileList(impl: Any)#

Bases: ItemList[Profile], DefaultMixin

A list of Profile instances.

class PythonFunction(impl: Any)#

Bases: PreferenceItem, DefaultMixin

A function that has been defined in a registered Python script.

getFileName() → str#

Get the value of the FileName attribute.

Returns:: The path to the referenced file.
Return type:: str

getFunctionName() → str#

Get the value of the FunctionName attribute.

Returns:: The name of the Python function to run.
Return type:: str

getNumberOfArguments() → int#

Get the value of the NumberOfArguments attribute.

Returns:: The number of arguments that the Python function accepts.
Return type:: int

setFileName(value: str) → None#

Set the value of the FileName attribute.

Parameters:: value (str) – The path to the referenced file.

setFunctionName(value: str) → None#

Set the value of the FunctionName attribute.

Parameters:: value (str) – The name of the Python function to run.

setNumberOfArguments(value: int) → None#

Set the value of the NumberOfArguments attribute.

Parameters:: value (int) – The number of arguments that the Python function accepts.

class PythonFunctionList(impl: Any)#

Bases: ItemList[PythonFunction], DefaultMixin

A list of PythonFunction instances.

class Report(impl: Any)#

Bases: PreferenceItem, DefaultMixin

A report containing data generated during the Study evaluation.

getDescription() → str#

Get the value of the Description attribute.

Returns:: The description of the Report.
Return type:: str

getEnabled() → bool#

Get the value of the Enabled attribute.

Returns:: If True, the Report is enabled and can be generated if active.
Return type:: bool

getExternalPath() → str#

Get the value of the ExternalPath attribute.

Returns:: The path to the Python script that defines the Report.
Return type:: str

getPeriodic() → bool#

Get the value of the Periodic attribute.

Returns:: If True, the report will periodically generate during evaluation.
Return type:: bool

getSettingList() → SettingItemList#

Get the value of the SettingList attribute.

Returns:: The list of SettingItem Items.
Return type:: SettingItemList

See also

SettingItem

getSettingSpecifics() → str#

Get the value of the SettingSpecifics attribute.

Returns:: The settings for the Report as a string.
Return type:: str

getState() → bool#

Get the value of the State attribute.

Returns:: If True, the Report is active and will be used during evaluation.
Return type:: bool

setDescription(value: str) → None#

Set the value of the Description attribute.

Parameters:: value (str) – The description of the Report.

setEnabled(value: bool) → None#

Set the value of the Enabled attribute.

Parameters:: value (bool) – If True, the Report is enabled and can be generated if active.

setExternalPath(value: str) → None#

Set the value of the ExternalPath attribute.

Parameters:: value (str) – The path to the Python script that defines the Report.

setPeriodic(value: bool) → None#

Set the value of the Periodic attribute.

Parameters:: value (bool) – If True, the report will periodically generate during evaluation.

setSettingSpecifics(value: str) → None#

Set the value of the SettingSpecifics attribute.

Parameters:: value (str) – The settings for the Report as a string.

setState(value: bool) → None#

Set the value of the State attribute.

Parameters:: value (bool) – If True, the Report is active and will be used during evaluation.

class ReportList(impl: Any)#

Bases: ItemList[Report], DefaultMixin

A list of Report instances.

class Report_Python(impl: Any)#

Bases: Report, DefaultMixin

A report that is defined by a registered Python script.

class Response(impl: Any)#

Bases: ScalarVariable, DefaultMixin

An output response is a measurement of system performances, such as weight, volume, displacement, stress, strain, reaction forces, and frequency.

getEvaluate() → str#

Get the value of the Evaluate attribute.

Returns:: The Fit varname to use for evaluation if applicable, otherwise “@solver”.
Return type:: str

getExtractAfter() → str#

Get the value of the ExtractAfter attribute.

Returns:: Comma separated list of additional Input Variables, Models, Responses, Gradients, and Data Sources that will be processed before this item. Generally these are auto-detected; Extract After is intended for rare situations where auto-detection is not possible.
Return type:: str

getGoalsUserInterface() → str#

Get the value of the GoalsUserInterface attribute.

Returns:: Abbreviated description of the Goals for this Response.
Return type:: str

Get the value of the TestRunValue attribute.

Returns:: The Test Approach value.
Return type:: hstApiVariant

getType() → str#

Get the value of the Type attribute.

Returns:: The data type of the Response value.
Return type:: str

setEvaluate(value: str) → None#

Set the value of the Evaluate attribute.

Parameters:: value (str) – The Fit varname to use for evaluation if applicable, otherwise “@solver”.

setExtractAfter(value: str) → None#

Set the value of the ExtractAfter attribute.

Parameters:: value (str) – Comma separated list of additional Input Variables, Models, Responses, Gradients, and Data Sources that will be processed before this item. Generally these are auto-detected; Extract After is intended for rare situations where auto-detection is not possible.

setType(value: str) → None#

Set the value of the Type attribute.

Parameters:: value (str) – The data type of the Response value.

class ResponseList(impl: Any)#

Bases: ItemList[Response], DefaultMixin

A list of Response instances.

class ScalarTool(impl: Any)#

Bases: ExpressionTool, DefaultMixin

The tool Object that defines the behavior of its parent ScalarVariable.

enum ScalarToolTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_CONNECTION = <ScalarToolTypes.TYPE_CONNECTION: 'Connection'>#

TYPE_TEMPLEX = <ScalarToolTypes.TYPE_TEMPLEX: 'Templex'>#

class ScalarTool_Connection(impl: Any)#

Bases: ScalarTool, DefaultMixin

A ScalarTool that extracts data directly from a connection.

getLabel() → str#

Get the value of the Label attribute.

Returns:: Label used by a scalar value for connection purposes.
Return type:: str

getModel() → str#

Get the value of the Model attribute.

Returns:: The unique identifier of the Model.
Return type:: str

getName() → str#

Get the value of the Name attribute.

Returns:: The name of the scalar tool used with a connection.
Return type:: str

getType() → str#

Get the value of the Type attribute.

Returns:

The HSTP item type.

input The item will be an Input Variable.
output The Item will be a Response.
gradient The Item will be a Gradient.

Return type:

str

setLabel(value: str) → None#

Set the value of the Label attribute.

Parameters:: value (str) – Label used by a scalar value for connection purposes.

setModel(value: str) → None#

Set the value of the Model attribute.

Parameters:: value (str) – The unique identifier of the Model.

setName(value: str) → None#

Set the value of the Name attribute.

Parameters:: value (str) – The name of the scalar tool used with a connection.

setType(value: str) → None#

Set the value of the Type attribute.

Parameters:

value (str) –

The HSTP item type.

input The item will be an Input Variable.
output The Item will be a Response.
gradient The Item will be a Gradient.

class ScalarTool_Templex(impl: Any)#

Bases: ScalarTool, DefaultMixin

A ScalarTool that evaluates a Templex expression.

getExpression() → str#

Get the value of the Expression attribute.

Returns:: A Templex expression that evaluates to a scalar value.
Return type:: str

setExpression(value: str) → None#

Set the value of the Expression attribute.

Parameters:: value (str) – A Templex expression that evaluates to a scalar value.

class ScalarVariable(impl: Any)#

Bases: DefinitionItem, DefaultMixin

A scalar input or output.

getAvailableScalarToolTypes() → List[ScalarToolTypes]#

Get the available types for the ScalarTool attribute.

Returns:: A list of types for the ScalarTool attribute
Return type:: List[ScalarToolTypes]

getEquation() → str#

Get the value of the Equation attribute.

Returns:: The Templex expression to evaluate when getting the value.
Return type:: str

getModelParameter() → ModelParameter#

Get the value of the ModelParameter attribute.

Returns:: The input or output entity within the Model.
Return type:: ModelParameter

getModelParameterUserInterface() → str#

Get the value of the ModelParameterUserInterface attribute.

Returns:: Special attribute to perform quick comparisons and copy&paste operations. It is recommended to interact with the Variable directly.
Return type:: str

getScalarTool() → ExpressionTool#

Get the value of the ScalarTool attribute.

Returns:: The tool object that handles the evaluation of a Definition item to a scalar value.
Return type:: ExpressionTool

getScalarToolType() → ScalarToolTypes#

Returns:: The type of the ScalarTool attribute.
Return type:: ScalarToolTypes

setEquation(value: str) → None#

Set the value of the Equation attribute.

Parameters:: value (str) – The Templex expression to evaluate when getting the value.

setScalarToolType(value: ScalarToolTypes) → None#

Parameters:: value (ScalarToolTypes) – The type of the ScalarTool attribute.
Returns:: None

class Session(impl: Any)#

Bases: Item, DefaultMixin

This contains the Study list and other information used throughout HyperStudy.

getExampleList() → ExampleList#

Get the value of the ExampleList attribute.

Returns:: The list of Example Items.
Return type:: ExampleList

See also

Example

getExternalFitList() → ExternalFitList#

Get the value of the ExternalFitList attribute.

Returns:: The list of ExternalFit Items.
Return type:: ExternalFitList

See also

ExternalFit

getExternalOptimizerList() → ExternalOptimizerList#

Get the value of the ExternalOptimizerList attribute.

Returns:: The list of ExternalOptimizer Items.
Return type:: ExternalOptimizerList

See also

ExternalOptimizer

getExternalSamplingFitList() → ExternalSamplingFitList#

Get the value of the ExternalSamplingFitList attribute.

Returns:: The list of ExternalSampingFit Items.
Return type:: ExternalSamplingFitList

See also

ExternalSamplingFit

getExternalSamplingList() → ExternalSamplingList#

Get the value of the ExternalSamplingList attribute.

Returns:: The list of ExternalSampling Items.
Return type:: ExternalSamplingList

See also

ExternalSampling

getFitterMetricOptionsList() → FitterMetricOptionsList#

Get the value of the FitterMetricOptionsList attribute.

Returns:: The list of FitterMetricOptions Objects.
Return type:: FitterMetricOptionsList

See also

FitterMetricOptions

getProfileList() → ProfileList#

Get the value of the ProfileList attribute.

Returns:: The list of Profile Items.
Return type:: ProfileList

See also

Profile

getPythonFunctionList() → PythonFunctionList#

Get the value of the PythonFunctionList attribute.

Returns:: The list of PythonFunction Items.
Return type:: PythonFunctionList

See also

PythonFunction

getReportList() → ReportList#

Get the value of the ReportList attribute.

Returns:: The list of Report Items.
Return type:: ReportList

See also

Report

getSolverList() → SolverList#

Get the value of the SolverList attribute.

Returns:: The list of Solver Items.
Return type:: SolverList

See also

Solver

getStudyList() → StudyList#

Get the value of the StudyList attribute.

Returns:: The list of Study Items.
Return type:: StudyList

See also

Study

getUserUtilityList() → UserUtilityList#

Get the value of the UserUtilityList attribute.

Returns:: The list of UserUtility Items.
Return type:: UserUtilityList

See also

UserUtility

class SettingItem(impl: Any)#

Bases: Item, DefaultMixin

A configuration for a parent Object.

Get the value of the Value attribute.

Returns:: The current value for the setting.
Return type:: hstApiVariant

Set the value of the Value attribute.

Parameters:: value (hstApiVariant) – The current value for the setting.

class SettingItemList(impl: Any)#

Bases: ItemList[SettingItem], DefaultMixin

A list of SettingItem instances.

class SetupContext(impl: Any)#

Bases: Item, DefaultMixin

This is a Study’s Definition. A Definition is used in the Setup and approaches to define the models, input variables, and output responses used in the study. When creating an approach, you can choose to clone the Definition that was defined in either the Setup or an existing approach.

getConditionList() → ConditionList#

Get the value of the ConditionList attribute.

Returns:: The list of Condition Items.
Return type:: ConditionList

See also

Condition

getDataSourceList() → DataSourceList#

Get the value of the DataSourceList attribute.

Returns:: The list of DataSource Items.
Return type:: DataSourceList

See also

DataSource

getDesignVariableList() → VariableList#

Get the value of the DesignVariableList attribute.

Returns:: The list of Variable Items.
Return type:: VariableList

See also

Variable

getFitReferenceList() → FitReferenceList#

Get the value of the FitReferenceList attribute.

Returns:: The list of FitReference Objects.
Return type:: FitReferenceList

See also

FitReference

getGoalList() → GoalList#

Get the value of the GoalList attribute.

Returns:: The list of Goal Items.
Return type:: GoalList

See also

Goal

getGradientList() → GradientList#

Get the value of the GradientList attribute.

Returns:: The list of Gradient Items.
Return type:: GradientList

See also

Gradient

getMediaSourceList() → MediaSourceList#

Get the value of the MediaSourceList attribute.

Returns:: The list of MediaSource Items.
Return type:: MediaSourceList

See also

MediaSource

getModelList() → ModelList#

Get the value of the ModelList attribute.

Returns:: The list of Model Items.
Return type:: ModelList

See also

Model

getResponseList() → ResponseList#

Get the value of the ResponseList attribute.

Returns:: The list of Response Items.
Return type:: ResponseList

See also

Response

getTestApproach() → Approach#

Get the value of the TestApproach attribute.

Returns:: The Test Approach is a special Approach which has one run and is used inside of the Definition for testing the setup and creating outputs.
Return type:: Approach

getVariableConstraintList() → ConstraintList#

Get the value of the VariableConstraintList attribute.

Returns:: The list of Constraint Items.
Return type:: ConstraintList

See also

Constraint

class Solver(impl: Any)#

Bases: PreferenceItem, DefaultMixin

Contains settings and information for a registered solver script.

getAvailableSolverToolTypes() → List[SolverToolTypes]#

Get the available types for the SolverTool attribute.

Returns:: A list of types for the SolverTool attribute
Return type:: List[SolverToolTypes]

getConnectionPath() → str#

Get the value of the ConnectionPath attribute.

Returns:: The path to the solver script.
Return type:: str

getIsInternal() → bool#

Get the value of the IsInternal attribute.

Returns:: If True, the solver is internal to the model type.
Return type:: bool

getPath() → str#

Get the value of the Path attribute.

Returns:: The path to the solver script.
Return type:: str

getSolverTool() → SolverTool#

Get the value of the SolverTool attribute.

Returns:: The tool object that handles settings specific to the solver type.
Return type:: SolverTool

getSolverToolType() → SolverToolTypes#

Returns:: The type of the SolverTool attribute.
Return type:: SolverToolTypes

getSystemArguments() → str#

Get the value of the SystemArguments attribute.

Returns:: Arguments that will be added to the command line when the solver is executed.
Return type:: str

getType() → str#

Get the value of the Type attribute.

Returns:: The type name of the Solver.
Return type:: str

getTypeLabel() → str#

Get the value of the TypeLabel attribute.

Returns:: The label for the Solver type.
Return type:: str

getTypeName() → str#

Get the value of the TypeName attribute.

Returns:: The name of the Solver type.
Return type:: str

getUserArguments() → str#

Get the value of the UserArguments attribute.

Returns:: User supplied arguments that will be added to the command line when the solver is executed.
Return type:: str

setPath(value: str) → None#

Set the value of the Path attribute.

Parameters:: value (str) – The path to the solver script.

setSolverToolType(value: SolverToolTypes) → None#

Parameters:: value (SolverToolTypes) – The type of the SolverTool attribute.
Returns:: None

setSystemArguments(value: str) → None#

Set the value of the SystemArguments attribute.

Parameters:: value (str) – Arguments that will be added to the command line when the solver is executed.

setUserArguments(value: str) → None#

Set the value of the UserArguments attribute.

Parameters:: value (str) – User supplied arguments that will be added to the command line when the solver is executed.

class SolverList(impl: Any)#

Bases: ItemList[Solver], DefaultMixin

A list of Solver instances.

class SolverTool(impl: Any)#

Bases: Object, DefaultMixin

The tool Object that defines the behavior of its parent Solver.

enum SolverToolTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_HST_OTHER_APPLICATION = <SolverToolTypes.TYPE_HST_OTHER_APPLICATION: 'hst_other_application'>#

TYPE_HST_RADIOSS = <SolverToolTypes.TYPE_HST_RADIOSS: 'hst_radioss'>#

TYPE_HST_OPTISTRUCT = <SolverToolTypes.TYPE_HST_OPTISTRUCT: 'hst_optistruct'>#

TYPE_HST_PAISHAPE = <SolverToolTypes.TYPE_HST_PAISHAPE: 'hst_paishape'>#

TYPE_HST_PYFIT = <SolverToolTypes.TYPE_HST_PYFIT: 'hst_pyfit'>#

TYPE_HST_ACCESS_DESKTOP = <SolverToolTypes.TYPE_HST_ACCESS_DESKTOP: 'hst_access_desktop'>#

TYPE_HST_MOTIONSOLVE = <SolverToolTypes.TYPE_HST_MOTIONSOLVE: 'hst_motionsolve'>#

TYPE_HST_PYTHON = <SolverToolTypes.TYPE_HST_PYTHON: 'hst_python'>#

TYPE_HST_FEKO = <SolverToolTypes.TYPE_HST_FEKO: 'hst_feko'>#

TYPE_HST_FLUX = <SolverToolTypes.TYPE_HST_FLUX: 'hst_flux'>#

TYPE_HST_FLUXMOTOR = <SolverToolTypes.TYPE_HST_FLUXMOTOR: 'hst_fluxmotor'>#

TYPE_HST_FLOW_SIM = <SolverToolTypes.TYPE_HST_FLOW_SIM: 'hst_flow_sim'>#

TYPE_HST_KNOWLEDGE_STUDIO = <SolverToolTypes.TYPE_HST_KNOWLEDGE_STUDIO: 'hst_knowledge_studio'>#

TYPE_HST_HV = <SolverToolTypes.TYPE_HST_HV: 'hst_hv'>#

TYPE_HST_LOOKUP = <SolverToolTypes.TYPE_HST_LOOKUP: 'hst_lookup'>#

TYPE_HST_INSPIRE = <SolverToolTypes.TYPE_HST_INSPIRE: 'hst_inspire'>#

TYPE_TWINACTIVATE = <SolverToolTypes.TYPE_TWINACTIVATE: 'twinactivate'>#

TYPE_HST_SPREADSHEET = <SolverToolTypes.TYPE_HST_SPREADSHEET: 'hst_spreadsheet'>#

TYPE_HST_BPREPROC = <SolverToolTypes.TYPE_HST_BPREPROC: 'hst_bpreproc'>#

TYPE_HST_WORKBENCH = <SolverToolTypes.TYPE_HST_WORKBENCH: 'hst_workbench'>#

TYPE_HST_SIMLAB = <SolverToolTypes.TYPE_HST_SIMLAB: 'hst_simlab'>#

TYPE_FMU = <SolverToolTypes.TYPE_FMU: 'fmu'>#

TYPE_HST_INTERNAL_MATH = <SolverToolTypes.TYPE_HST_INTERNAL_MATH: 'hst_internal_math'>#

TYPE_HST_INTERNAL_PYTHON = <SolverToolTypes.TYPE_HST_INTERNAL_PYTHON: 'hst_internal_python'>#

TYPE_HST_NONE = <SolverToolTypes.TYPE_HST_NONE: 'hst_none'>#

enum SpecifiedTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_FAST = <SpecifiedTypes.TYPE_FAST: 'FAST'>#

TYPE_LSR = <SpecifiedTypes.TYPE_LSR: 'LSR'>#

TYPE_MLSM = <SpecifiedTypes.TYPE_MLSM: 'MLSM'>#

TYPE_HK = <SpecifiedTypes.TYPE_HK: 'HK'>#

TYPE_RBF = <SpecifiedTypes.TYPE_RBF: 'RBF'>#

TYPE_EXTRAPOLATION = <SpecifiedTypes.TYPE_EXTRAPOLATION: 'Extrapolation'>#

TYPE_USER_RF = <SpecifiedTypes.TYPE_USER_RF: 'USER.RF'>#

enum StochasticDesignTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_NOM = <StochasticDesignTypes.TYPE_NOM: 'Nom'>#

TYPE_CHK = <StochasticDesignTypes.TYPE_CHK: 'Chk'>#

TYPE_SWEEP = <StochasticDesignTypes.TYPE_SWEEP: 'Sweep'>#

TYPE_DOPT = <StochasticDesignTypes.TYPE_DOPT: 'DOpt'>#

TYPE_FULLFACT = <StochasticDesignTypes.TYPE_FULLFACT: 'FullFact'>#

TYPE_CCD = <StochasticDesignTypes.TYPE_CCD: 'Ccd'>#

TYPE_FRACFACT = <StochasticDesignTypes.TYPE_FRACFACT: 'FracFact'>#

TYPE_PLACKBURM = <StochasticDesignTypes.TYPE_PLACKBURM: 'PlackBurm'>#

TYPE_BOX = <StochasticDesignTypes.TYPE_BOX: 'Box'>#

TYPE_HAMMERSLEY = <StochasticDesignTypes.TYPE_HAMMERSLEY: 'Hammersley'>#

TYPE_LATINHYPERCUBE = <StochasticDesignTypes.TYPE_LATINHYPERCUBE: 'LatinHyperCube'>#

TYPE_MELS = <StochasticDesignTypes.TYPE_MELS: 'Mels'>#

TYPE_SOBOL = <StochasticDesignTypes.TYPE_SOBOL: 'Sobol'>#

TYPE_RUNMATRIX = <StochasticDesignTypes.TYPE_RUNMATRIX: 'RunMatrix'>#

TYPE_USER = <StochasticDesignTypes.TYPE_USER: 'User'>#

TYPE_TAGUCHI = <StochasticDesignTypes.TYPE_TAGUCHI: 'Taguchi'>#

TYPE_INITIAL = <StochasticDesignTypes.TYPE_INITIAL: 'Initial'>#

TYPE_EMPTY = <StochasticDesignTypes.TYPE_EMPTY: 'Empty'>#

TYPE_FILLRANDOM = <StochasticDesignTypes.TYPE_FILLRANDOM: 'FillRandom'>#

TYPE_FILLSTATISTICS = <StochasticDesignTypes.TYPE_FILLSTATISTICS: 'FillStatistics'>#

TYPE_SIMPLE = <StochasticDesignTypes.TYPE_SIMPLE: 'Simple'>#

TYPE_VOID = <StochasticDesignTypes.TYPE_VOID: 'Void'>#

class StochasticReliability(impl: Any)#

Bases: Item, DefaultMixin

Used to determine the reliability of design.

getBoundType() → str#

Get the value of the BoundType attribute.

Returns:

The operator used to determine if the design is reliable.

>= The output must be greater or equal to the bound value.
<= The output must be less than or equal to the bound value.

Return type:

str

getBoundValue() → float#

Get the value of the BoundValue attribute.

Returns:: The value to compare the calculated reliability against.
Return type:: float

getFailureProbability() → float#

Get the value of the FailureProbability attribute.

Returns:: The probability that the design will fail.
Return type:: float

getReliability() → float#

Get the value of the Reliability attribute.

Returns:: The percentage of designs that would satisfy the reliability bound value.
Return type:: float

getResponse() → str#

Get the value of the Response attribute.

Returns:: The varname of the Response that is used to calculate the reliability.
Return type:: str

getState() → bool#

Get the value of the State attribute.

Returns:: If True, the StochasticReliability is active. This state may be used by custom reports.
Return type:: bool

setBoundType(value: str) → None#

Set the value of the BoundType attribute.

Parameters:

value (str) –

The operator used to determine if the design is reliable.

>= The output must be greater or equal to the bound value.
<= The output must be less than or equal to the bound value.

setBoundValue(value: float) → None#

Set the value of the BoundValue attribute.

Parameters:: value (float) – The value to compare the calculated reliability against.

setReliability(value: float) → None#

Set the value of the Reliability attribute.

Parameters:: value (float) – The percentage of designs that would satisfy the reliability bound value.

setResponse(value: str) → None#

Set the value of the Response attribute.

Parameters:: value (str) – The varname of the Response that is used to calculate the reliability.

setState(value: bool) → None#

Set the value of the State attribute.

Parameters:: value (bool) – If True, the StochasticReliability is active. This state may be used by custom reports.

class StochasticReliabilityList(impl: Any)#

Bases: ItemList[StochasticReliability], DefaultMixin

A list of StochasticReliability instances.

class Study(impl: Any)#

Bases: Item, DefaultMixin

A Study is a self-contained project in which models, variables, output responses, and approaches are defined. A study is saved into a .xml file, with a .hstudy extension.

exportAltairBinaryFormat(filePath: str) → None#

Save data tables for each approach to an Altair Binary Format (*.abf) file.

Parameters:: filePath (str) – The output path for the report.

getApproachList() → ApproachList#

Get the value of the ApproachList attribute.

Returns:: The list of Approach Items.
Return type:: ApproachList

See also

Approach

getCommandList() → CommandList#

Get the value of the CommandList attribute.

Returns:: The list of Command Items.
Return type:: CommandList

See also

Command

getDirectory() → str#

Get the value of the Directory attribute.

Returns:: The directory that contains the Study file, Approach directory, and other resources.
Return type:: str

getFlagDirty() → bool#

Get the value of the FlagDirty attribute.

Returns:: Whether the Study has unsaved changes.
Return type:: bool

getFolder() → str#

Get the value of the Folder attribute.

Returns:: File system folder containing the Study contents. Usually shouldn’t be changed after the study has content.
Return type:: str

getGroupList() → GroupList#

Get the value of the GroupList attribute.

Returns:: The list of Group Items.
Return type:: GroupList

See also

Group

getImportFileList() → ImportFileList#

Get the value of the ImportFileList attribute.

Returns:: The list of data importers.
Return type:: ImportFileList

getReportsDirectory() → str#

Get the value of the ReportsDirectory attribute.

Returns:: The path to the directory containing reports generated by approach evaluations.
Return type:: str

getStudyFile() → str#

Get the value of the StudyFile attribute.

Returns:: The path to the Study’s *.hstudy file.
Return type:: str

getUserChannelList() → UserChannelList#

Get the value of the UserChannelList attribute.

Returns:: The list of UserChannel Items.
Return type:: UserChannelList

See also

UserChannel

save() → bool#

Save the study to its *.hstudy file.

Returns:: True if the study was saved successfully.
Return type:: bool

saveArchive(filePath: str) → bool#

Save the study as an archive (*.hstx, *.hstxc).

Parameters:: filePath (str) – The path to export the archive to.
Returns:: True if the study was exported successfully.
Return type:: bool

setDirectory(value: str) → None#

Set the value of the Directory attribute.

Parameters:: value (str) – The directory that contains the Study file, Approach directory, and other resources.

setFolder(value: str) → None#

Set the value of the Folder attribute.

Parameters:: value (str) – File system folder containing the Study contents. Usually shouldn’t be changed after the study has content.

setStudyFile(value: str) → None#

Set the value of the StudyFile attribute.

Parameters:: value (str) – The path to the Study’s *.hstudy file.

class StudyList(impl: Any)#

Bases: ItemList[Study], DefaultMixin

A list of Study instances.

closeStudy(varname: str) → None#

Close the Study with the specified varname.

Parameters:: varname (str) – The varname of the Study to close.

openArchive(filePath: str) → bool#

Open a Study archive from a specified file.

Parameters:: filePath (str) – The path to the archive to open (*.hstx, *.hstxc)
Returns:: True if the archive is opened successfully.
Return type:: bool

openStudy(filePath: str) → bool#

Open a Study from a specified file.

Parameters:: filePath (str) – The path to the study file to open (*.hstudy, *.xml)
Returns:: True if the Study file was opened successfully.
Return type:: bool

saveStudy(varname: str, filePath: str) → bool#

Save the Study with the specified varname.

Parameters:

varname (str) – The varname of the Study to save
filePath (str) – The file path to save the *.hstudy file to.

Returns:

True if the Study is saved successfully.

Return type:

bool

class Table(impl: Any)#

Bases: _ApiInterface, DefaultMixin

This class’s interface is not consistent. It will eventually be available but is not ready for release at this time.

class TableTypes#: Bases: object

enum UncontrolledDesignTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_NOM = <UncontrolledDesignTypes.TYPE_NOM: 'Nom'>#

TYPE_CHK = <UncontrolledDesignTypes.TYPE_CHK: 'Chk'>#

TYPE_SWEEP = <UncontrolledDesignTypes.TYPE_SWEEP: 'Sweep'>#

TYPE_DOPT = <UncontrolledDesignTypes.TYPE_DOPT: 'DOpt'>#

TYPE_FULLFACT = <UncontrolledDesignTypes.TYPE_FULLFACT: 'FullFact'>#

TYPE_CCD = <UncontrolledDesignTypes.TYPE_CCD: 'Ccd'>#

TYPE_FRACFACT = <UncontrolledDesignTypes.TYPE_FRACFACT: 'FracFact'>#

TYPE_PLACKBURM = <UncontrolledDesignTypes.TYPE_PLACKBURM: 'PlackBurm'>#

TYPE_BOX = <UncontrolledDesignTypes.TYPE_BOX: 'Box'>#

TYPE_HAMMERSLEY = <UncontrolledDesignTypes.TYPE_HAMMERSLEY: 'Hammersley'>#

TYPE_LATINHYPERCUBE = <UncontrolledDesignTypes.TYPE_LATINHYPERCUBE: 'LatinHyperCube'>#

TYPE_MELS = <UncontrolledDesignTypes.TYPE_MELS: 'Mels'>#

TYPE_SOBOL = <UncontrolledDesignTypes.TYPE_SOBOL: 'Sobol'>#

TYPE_RUNMATRIX = <UncontrolledDesignTypes.TYPE_RUNMATRIX: 'RunMatrix'>#

TYPE_USER = <UncontrolledDesignTypes.TYPE_USER: 'User'>#

TYPE_TAGUCHI = <UncontrolledDesignTypes.TYPE_TAGUCHI: 'Taguchi'>#

TYPE_INITIAL = <UncontrolledDesignTypes.TYPE_INITIAL: 'Initial'>#

TYPE_EMPTY = <UncontrolledDesignTypes.TYPE_EMPTY: 'Empty'>#

TYPE_FILLRANDOM = <UncontrolledDesignTypes.TYPE_FILLRANDOM: 'FillRandom'>#

TYPE_FILLSTATISTICS = <UncontrolledDesignTypes.TYPE_FILLSTATISTICS: 'FillStatistics'>#

TYPE_SIMPLE = <UncontrolledDesignTypes.TYPE_SIMPLE: 'Simple'>#

TYPE_VOID = <UncontrolledDesignTypes.TYPE_VOID: 'Void'>#

class Unit(impl: Any)#

Bases: Object, DefaultMixin

The name and type of a quantity.

getName() → str#

Get the value of the Name attribute.

Returns:: The name of the Unit.
Return type:: str

getType() → str#

Get the value of the Type attribute.

Returns:: Indicates what the unit is measuring e.g volume, length, mass.
Return type:: str

setName(value: str) → None#

Set the value of the Name attribute.

Parameters:: value (str) – The name of the Unit.

setType(value: str) → None#

Set the value of the Type attribute.

Parameters:: value (str) – Indicates what the unit is measuring e.g volume, length, mass.

class UserChannel(impl: Any)#

Bases: PreferenceItem, DefaultMixin

A table column defined by a registered Python script.

getScript() → str#

Get the value of the Script attribute.

Returns:: The path to the Python script that defines the User Channel.
Return type:: str

getSettingList() → SettingItemList#

Get the value of the SettingList attribute.

Returns:: The list of SettingItem Items.
Return type:: SettingItemList

See also

SettingItem

getSettingSpecifics() → str#

Get the value of the SettingSpecifics attribute.

Returns:: The settings for the User Channel as a string.
Return type:: str

getState() → bool#

Get the value of the State attribute.

Returns:: If True, the UserChannel is active and will be used during post-processing.
Return type:: bool

setScript(value: str) → None#

Set the value of the Script attribute.

Parameters:: value (str) – The path to the Python script that defines the User Channel.

setSettingSpecifics(value: str) → None#

Set the value of the SettingSpecifics attribute.

Parameters:: value (str) – The settings for the User Channel as a string.

setState(value: bool) → None#

Set the value of the State attribute.

Parameters:: value (bool) – If True, the UserChannel is active and will be used during post-processing.

updateRow(approachVarname: str, row: int, column: int) → None#

Update the value in a UserChannel row.

Parameters:

approachVarname (str) – The varname of the Approach the UserChannel is associated with.
row (int) – The row number to update.
column (int) – The column number to update.

class UserChannelList(impl: Any)#

Bases: ItemList[UserChannel], DefaultMixin

A list of UserChannel instances.

class UserUtility(impl: Any)#

Bases: PreferenceItem, DefaultMixin

Runs external programs from within the HyperStudy interface.

getInterpreter() → str#

Get the value of the Interpreter attribute.

Returns:: The interpreter path in a user utility usually points to an executable like Python. Depending on the type, it might also point to a script file.
Return type:: str

getScope() → str#

Get the value of the Scope attribute.

Returns:

Where the User Utility is available for use.

Default Default.
Context Utility only available in a user context from a context menu.
Empty Session Utility only available when no Study is loaded.

Return type:

str

getScript() → str#

Get the value of the Script attribute.

Returns:: The path to the Python script if the utility is an internal Python automation, otherwise the path to the executable to run.
Return type:: str

getType() → str#

Get the value of the Type attribute.

Returns:

Determines the context for executing the user utility.

EXTERNAL Separate executable.
INTERNAL_PYTHON A Python script that will be run within HyperStudy.

Return type:

str

setInterpreter(value: str) → None#

Set the value of the Interpreter attribute.

Parameters:: value (str) – The interpreter path in a user utility usually points to an executable like Python. Depending on the type, it might also point to a script file.

setScope(value: str) → None#

Set the value of the Scope attribute.

Parameters:

value (str) –

Where the User Utility is available for use.

Default Default.
Context Utility only available in a user context from a context menu.
Empty Session Utility only available when no Study is loaded.

setScript(value: str) → None#

Set the value of the Script attribute.

Parameters:: value (str) – The path to the Python script if the utility is an internal Python automation, otherwise the path to the executable to run.

setType(value: str) → None#

Set the value of the Type attribute.

Parameters:

value (str) –

Determines the context for executing the user utility.

EXTERNAL Separate executable.
INTERNAL_PYTHON A Python script that will be run within HyperStudy.

class UserUtilityList(impl: Any)#

Bases: ItemList[UserUtility], DefaultMixin

A list of UserUtility instances.

class Variable(impl: Any)#

Bases: ScalarVariable, DefaultMixin

An input Variable is a system parameter that influences the system performance in the chosen output response. It is an object that is varied by the study based on certain rules.

getAvailableFormatToolTypes() → List[FormatToolTypes]#

Get the available types for the FormatTool attribute.

Returns:: A list of types for the FormatTool attribute
Return type:: List[FormatToolTypes]

getCategory() → str#

Get the value of the Category attribute.

Returns:

Whether the variable can be changed in controlled or uncontrolled portion of the DOE.

Controlled The value can be changed to improve the system performance in the chosen output response. Its value is under the control of the designer.
Uncontrolled The value cannot be changed, but that influence the system performance in the chosen output response. Its values are not under the control of the designer.

Return type:

str

getDataType() → str#

Get the value of the DataType attribute.

Returns:

The type of values that the variable can have.

String Character sequences.
Integer Whole numbers.
Real Decimal values or real numbers.

Return type:

str

See also

DataType

getDistribution() → str#

Get the value of the Distribution attribute.

Returns:

The statistical distribution that determines the probability that the Input Variable will take a certain value.

Normal_Variance Use to approximate many phenomenons in nature. Defined using the mean (Alpha) and variance (Beta).
Normal_CoV Use to approximate many phenomenons in nature. Defined using the mean (Alpha) and the coefficient of variance (Beta) parameters.
Uniform Use when all values between the minimum and maximum are equally likely, such as a number from a random number generator. Defined using the lower bound (Alpha) and upper bound (Beta) parameters.
Uniform_Discrete Use when you have discrete (numeric or string) variables that take values which are equally likely.
Triangular Use when the only known information is the minimum, the most likely, and the maximum values. Defined using the lower bound (Alpha), upper bound (Beta), and mode (Gamma) parameters.
Exponential Use to describe the amount of time between occurrences, mean time between failures.
Weibull Principal applications are situations involving wear, fatigue and failure, failure rates, life.
Weibull_3P A Weibull distribution with an additional location (Gamma) parameter.
LogNormal Use in risk analyses. Defined using the location (Alpha) and scale (Beta) parameters.
LogNormal_3P A LogNormal distribution with with an additioal shape (Gamma) parameter.
Gumbel Used to model the behavior of extreme values, such as the maximum or minimum, from a sample of various distributions. Defined using the location (Alpha) and scale (Beta) parameters.

Return type:

str

See also

Variable.setDistributionParameterAlpha
Variable.setDistributionParameterBeta
Variable.setDistributionParameterGamma

getDistributionAlphaLabel() → str#

Get the value of the DistributionAlphaLabel attribute.

Returns:: The label for the particular value that the parameter affects.
Return type:: str

See also

Variable.getDistribution

getDistributionBetaLabel() → str#

Get the value of the DistributionBetaLabel attribute.

Returns:: The label for the particular value that the parameter affects.
Return type:: str

See also

Variable.getDistribution

getDistributionGammaLabel() → str#

Get the value of the DistributionGammaLabel attribute.

Returns:: The label for the particular value that the parameter affects.
Return type:: str

See also

Variable.getDistribution

getDistributionLinksUserInterface() → str#

Get the value of the DistributionLinksUserInterface attribute.

Returns:: This attribute is meant for internal use.
Return type:: str

Get the value of the DistributionParameterAlpha attribute.

Returns:: The mean, lower bound, scale, shape, or location value depending on the Distribution type.
Return type:: hstApiVariant

See also

Variable.getDistribution

Get the value of the DistributionParameterBeta attribute.

Returns:: The variance, upper bound, scale, or coefficient of variation depending on the Distribution type. Not applicable to all distributions.
Return type:: hstApiVariant

See also

Variable.getDistribution

Get the value of the DistributionParameterGamma attribute.

Returns:: The Distribution’s mode, shape, location depending on the distribution type. Not applicable to all distributions.
Return type:: hstApiVariant

See also

Variable.getDistribution

getDoubleValues() → List[str]#

Get the value of the DoubleValues attribute.

Returns:: The list of float values that the variable can have, converted to strings.
Return type:: List[str]

getFormatTool() → DataFormatTool#

Get the value of the FormatTool attribute.

Returns:: The formatting tool to use when getting variable values during evaluation.
Return type:: DataFormatTool

getFormatToolType() → FormatToolTypes#

Returns:: The type of the FormatTool attribute.
Return type:: FormatToolTypes

getFormatType() → str#

Get the value of the FormatType attribute.

Returns:: The type of formatting to apply to the values.
Return type:: str

getIndependent() → bool#

Get the value of the Independent attribute.

Returns:: If True, the variable is not linked to any other variable or expression.
Return type:: bool

Get the value of the InitialValueUserInterface attribute.

Returns:: The Variable’s nominal value, formatted for the GUI.
Return type:: hstApiVariant

Get the value of the LowerBound attribute.

Returns:: The minimum value that the variable can have.
Return type:: hstApiVariant

Get the value of the MaxValueUserInterface attribute.

Returns:: The Variable’s upper bound, formatted for the GUI.
Return type:: hstApiVariant

Get the value of the MinValueUserInterface attribute.

Returns:: The Variable’s lower bound, formatted for the GUI.
Return type:: hstApiVariant

getMode() → str#

Get the value of the Mode attribute.

Returns:: Returns if the variable is ‘Continuous’, ‘Discrete’ or ‘Categorical’.
Return type:: str

getModelParameterReference() → str#

Get the value of the ModelParameterReference attribute.

Returns:: A generated id name to reference the corrent ModelParameter. Usually of the form model_varname.modelparameter_varname.
Return type:: str

See also

ModelParameter

getModelType() → str#

Get the value of the ModelType attribute.

Returns:: The model type is a string identifier for the connection used by this model.
Return type:: str

Get the value of the NominalValue attribute.

Returns:: The initial value that the variable has.
Return type:: hstApiVariant

getParameterList() → List[str]#

Get the value of the ParameterList attribute.

Returns:: Return a list of [alpha, beta, gamma].
Return type:: List[str]

getRandomVariable() → VariableRandomAttributes#

Get the value of the RandomVariable attribute.

Returns:: The Object containing probabilistic input properties.
Return type:: VariableRandomAttributes

getRole() → str#

Get the value of the Role attribute.

Returns:

The distribution role of the Variable when the sample data is generated.

RandomParameter The variable is probabilistic and not controllable by design.
DesignWithRandom The variable is probabilistic and controllable by design.
Design The variable is deterministic.

Return type:

str

getRoleDescription() → str#

Get the value of the RoleDescription attribute.

Returns:

The description of the distribution role of the Variable.

Random Parameter The Variable is probabilistic and not controllable by design.
Design with Random The Variable is probabilistic and controllable by design.
Design The Variable is deterministic.

Return type:

str

getStringValues() → List[str]#

Get the value of the StringValues attribute.

Returns:: The values that a Variable could take, formatted as strings.
Return type:: List[str]

getToolSpecifics() → str#

Get the value of the ToolSpecifics attribute.

Returns:: The Variable’s scalar tool settings as a string.
Return type:: str

See also

DataFormatTool

Get the value of the UpperBound attribute.

Returns:: The maximum value the variable can have.
Return type:: hstApiVariant

getValues() → str#

Get the value of the Values attribute.

Returns:: The list of possible values the Input Variable can have. This is only applicable to list format variables.
Return type:: str

setCategory(value: str) → None#

Set the value of the Category attribute.

Parameters:

value (str) –

Whether the variable can be changed in controlled or uncontrolled portion of the DOE.

Controlled The value can be changed to improve the system performance in the chosen output response. Its value is under the control of the designer.
Uncontrolled The value cannot be changed, but that influence the system performance in the chosen output response. Its values are not under the control of the designer.

setDataType(value: str) → None#

Set the value of the DataType attribute.

Parameters:

value (str) –

The type of values that the variable can have.

String Character sequences.
Integer Whole numbers.
Real Decimal values or real numbers.

See also

DataType

setDistribution(value: str) → None#

Set the value of the Distribution attribute.

Parameters:

value (str) –

The statistical distribution that determines the probability that the Input Variable will take a certain value.

Normal_Variance Use to approximate many phenomenons in nature. Defined using the mean (Alpha) and variance (Beta).
Normal_CoV Use to approximate many phenomenons in nature. Defined using the mean (Alpha) and the coefficient of variance (Beta) parameters.
Uniform Use when all values between the minimum and maximum are equally likely, such as a number from a random number generator. Defined using the lower bound (Alpha) and upper bound (Beta) parameters.
Uniform_Discrete Use when you have discrete (numeric or string) variables that take values which are equally likely.
Triangular Use when the only known information is the minimum, the most likely, and the maximum values. Defined using the lower bound (Alpha), upper bound (Beta), and mode (Gamma) parameters.
Exponential Use to describe the amount of time between occurrences, mean time between failures.
Weibull Principal applications are situations involving wear, fatigue and failure, failure rates, life.
Weibull_3P A Weibull distribution with an additional location (Gamma) parameter.
LogNormal Use in risk analyses. Defined using the location (Alpha) and scale (Beta) parameters.
LogNormal_3P A LogNormal distribution with with an additioal shape (Gamma) parameter.
Gumbel Used to model the behavior of extreme values, such as the maximum or minimum, from a sample of various distributions. Defined using the location (Alpha) and scale (Beta) parameters.

See also

Variable.setDistributionParameterAlpha
Variable.setDistributionParameterBeta
Variable.setDistributionParameterGamma

Set the value of the DistributionParameterAlpha attribute.

Parameters:: value (hstApiVariant) – The mean, lower bound, scale, shape, or location value depending on the Distribution type.

See also

Variable.getDistribution

Set the value of the DistributionParameterBeta attribute.

Parameters:: value (hstApiVariant) – The variance, upper bound, scale, or coefficient of variation depending on the Distribution type. Not applicable to all distributions.

See also

Variable.getDistribution

Set the value of the DistributionParameterGamma attribute.

Parameters:: value (hstApiVariant) – The Distribution’s mode, shape, location depending on the distribution type. Not applicable to all distributions.

See also

Variable.getDistribution

setDoubleValues(value: List[str]) → None#

Set the value of the DoubleValues attribute.

Parameters:: value (List[str]) – The list of float values that the variable can have, converted to strings.

setFormatToolType(value: FormatToolTypes) → None#

Parameters:: value (FormatToolTypes) – The type of the FormatTool attribute.
Returns:: None

setFormatType(value: str) → None#

Set the value of the FormatType attribute.

Parameters:: value (str) – The type of formatting to apply to the values.

Set the value of the InitialValueUserInterface attribute.

Parameters:: value (hstApiVariant) – The Variable’s nominal value, formatted for the GUI.

Set the value of the LowerBound attribute.

Parameters:: value (hstApiVariant) – The minimum value that the variable can have.

Set the value of the MaxValueUserInterface attribute.

Parameters:: value (hstApiVariant) – The Variable’s upper bound, formatted for the GUI.

Set the value of the MinValueUserInterface attribute.

Parameters:: value (hstApiVariant) – The Variable’s lower bound, formatted for the GUI.

Set the value of the NominalValue attribute.

Parameters:: value (hstApiVariant) – The initial value that the variable has.

setParameterList(value: List[str]) → None#

Set the value of the ParameterList attribute.

Parameters:: value (List[str]) – Return a list of [alpha, beta, gamma].

setRole(value: str) → None#

Set the value of the Role attribute.

Parameters:

value (str) –

The distribution role of the Variable when the sample data is generated.

RandomParameter The variable is probabilistic and not controllable by design.
DesignWithRandom The variable is probabilistic and controllable by design.
Design The variable is deterministic.

setRoleDescription(value: str) → None#

Set the value of the RoleDescription attribute.

Parameters:

value (str) –

The description of the distribution role of the Variable.

Random Parameter The Variable is probabilistic and not controllable by design.
Design with Random The Variable is probabilistic and controllable by design.
Design The Variable is deterministic.

setStringValues(value: List[str]) → None#

Set the value of the StringValues attribute.

Parameters:: value (List[str]) – The values that a Variable could take, formatted as strings.

setToolSpecifics(value: str) → None#

Set the value of the ToolSpecifics attribute.

Parameters:: value (str) – The Variable’s scalar tool settings as a string.

See also

DataFormatTool

Set the value of the UpperBound attribute.

Parameters:: value (hstApiVariant) – The maximum value the variable can have.

setValues(value: str) → None#

Set the value of the Values attribute.

Parameters:: value (str) – The list of possible values the Input Variable can have. This is only applicable to list format variables.

class VariableCategory#

Bases: object

ALL: Final[str] = 'All'#

CONTROLLED: Final[str] = 'Controlled'#

UNCONTROLLED: Final[str] = 'Uncontrolled'#

class VariableList(impl: Any)#

Bases: DefinitionItemList[Variable], DefaultMixin

A list of Variable Items.

class VariableRandomAttributes(impl: Any)#

Bases: Object, DefaultMixin

Settings that define the random characteristics of a Variable.

See also

Variable

getDistributionAlphaLabel() → str#

Get the value of the DistributionAlphaLabel attribute.

Returns:: The label for the particular value that the parameter affects.
Return type:: str

See also

Variable.getDistribution

getDistributionBetaLabel() → str#

Get the value of the DistributionBetaLabel attribute.

Returns:: The label for the particular value that the parameter affects.
Return type:: str

See also

Variable.getDistribution

getDistributionGammaLabel() → str#

Get the value of the DistributionGammaLabel attribute.

Returns:: The label for the particular value that the parameter affects.
Return type:: str

See also

Variable.getDistribution

getDistributionParameterAlpha() → float#

Get the value of the DistributionParameterAlpha attribute.

Returns:: The mean, lower bound, scale, shape, or location value depending on the Distribution type.
Return type:: float

See also

Variable.getDistribution

getDistributionParameterBeta() → float#

Get the value of the DistributionParameterBeta attribute.

Returns:: The variance, upper bound, scale, or coefficient of variation depending on the Distribution type. Not applicable to all Distributions.
Return type:: float

See also

Variable.getDistribution

getDistributionParameterGamma() → float#

Get the value of the DistributionParameterGamma attribute.

Returns:: The Distribution’s mode, shape, location depending on the distribution type. Not applicable to all distributions.
Return type:: float

See also

Variable.getDistribution

getStatisticalDistribution() → str#

Get the value of the StatisticalDistribution attribute.

Returns:: The name of the statistical distribution to use for the Input variable.
Return type:: str

setDistributionParameterAlpha(value: float) → None#

Set the value of the DistributionParameterAlpha attribute.

Parameters:: value (float) – The mean, lower bound, scale, shape, or location value depending on the Distribution type.

See also

Variable.getDistribution

setDistributionParameterBeta(value: float) → None#

Set the value of the DistributionParameterBeta attribute.

Parameters:: value (float) – The variance, upper bound, scale, or coefficient of variation depending on the Distribution type. Not applicable to all Distributions.

See also

Variable.getDistribution

setDistributionParameterGamma(value: float) → None#

Set the value of the DistributionParameterGamma attribute.

Parameters:: value (float) – The Distribution’s mode, shape, location depending on the distribution type. Not applicable to all distributions.

See also

Variable.getDistribution

setStatisticalDistribution(value: str) → None#

Set the value of the StatisticalDistribution attribute.

Parameters:: value (str) – The name of the statistical distribution to use for the Input variable.

class VariableRole#

Bases: object

DESIGN: Final[str] = 'Design'#

DESIGN_RANDOM: Final[str] = 'DesignWithRandom'#

RANDOM: Final[str] = 'RandomParameter'#

enum VerifyDesignTypes(value)#

Bases: Enum

Valid values are as follows:

TYPE_VERIFYPOINTS = <VerifyDesignTypes.TYPE_VERIFYPOINTS: 'VerifyPoints'>#

TYPE_VERIFYOPTIMAL = <VerifyDesignTypes.TYPE_VERIFYOPTIMAL: 'VerifyOptimal'>#

TYPE_VERIFYTRADEOFF = <VerifyDesignTypes.TYPE_VERIFYTRADEOFF: 'VerifyTradeOff'>#