Sensitivity Analysis

Contains the implementations for the sensitivity analysis methods

Implements the supported sensitivity analysis methods.

class calisim.sensitivity.implementation.SensitivityAnalysisMethod(calibration_func: Callable, specification: SensitivityAnalysisMethodModel, engine: str = 'salib', implementation: CalibrationWorkflowBase | None = None)[source]: The sensitivity analysis method class.

pydantic model calisim.sensitivity.implementation.SensitivityAnalysisMethodModel[source]

The sensitivity analysis method data model.

Parameters:

BaseModel (CalibrationModel) – The calibration base model class.

Config:

arbitrary_types_allowed: bool = True
protected_namespaces: tuple = ()

Fields:

order (int)

field order: int = 2: The order for the polynomial chaos expansion

calisim.sensitivity.implementation.get_implementations() → dict[str, type[CalibrationWorkflowBase]][source]

Get the calibration implementations for sensitivity analysis.

Returns:

The dictionary of: calibration implementations for sensitivity analysis.

Return type:

Dict[str, type[CalibrationWorkflowBase]]

OpenTurns

Contains the implementations for sensitivity analysis methods using OpenTurns

Implements the supported sensitivity analysis methods using the OpenTurns library.

class calisim.sensitivity.openturns_wrapper.OpenTurnsSensitivityAnalysis(calibration_func: Callable, specification: CalibrationModel, task: str)[source]

The OpenTurns sensitivity analysis method class.

analyze() → None[source]: Analyze the results of the simulation calibration procedure.

execute() → None[source]: Execute the simulation calibration procedure.

SALib

Contains the implementations for sensitivity analysis methods using SALib

Implements the supported sensitivity analysis methods using the SALib library.

class calisim.sensitivity.salib_wrapper.SALibSensitivityAnalysis(calibration_func: Callable, specification: CalibrationModel, task: str)[source]

The SALib sensitivity analysis method class.

analyze() → None[source]: Analyze the results of the simulation calibration procedure.

execute() → None[source]: Execute the simulation calibration procedure.

specify() → None[source]: Specify the parameters of the model calibration procedure.