gemseo.uncertainty.sensitivity package

Capabilities to run a sensitivity analysis.

This package contains:

• an abstract class BaseSensitivityAnalysis to define the concept of sensitivity analysis,

• a factory SensitivityAnalysisFactory to create instances of BaseSensitivityAnalysis,

• concrete classes implementing this abstract class:

  • CorrelationAnalysis (based on OpenTURNS capabilities)

  • MorrisAnalysis,

  • SobolAnalysis (based on OpenTURNS capabilities),

  • HSICAnalysis (based on OpenTURNS capabilities).

Submodules

• gemseo.uncertainty.sensitivity.base_sensitivity_analysis module
  • BaseSensitivityAnalysis
    • BaseSensitivityAnalysis.Method
      • BaseSensitivityAnalysis.Method.NONE
    • BaseSensitivityAnalysis.SensitivityIndices
    • BaseSensitivityAnalysis.compute_indices()
    • BaseSensitivityAnalysis.compute_samples()
    • BaseSensitivityAnalysis.plot()
    • BaseSensitivityAnalysis.plot_bar()
    • BaseSensitivityAnalysis.plot_comparison()
    • BaseSensitivityAnalysis.plot_field()
    • BaseSensitivityAnalysis.plot_radar()
    • BaseSensitivityAnalysis.sort_input_variables()
    • BaseSensitivityAnalysis.standardize_indices()
    • BaseSensitivityAnalysis.to_dataset()
    • BaseSensitivityAnalysis.DEFAULT_DRIVER
    • BaseSensitivityAnalysis.dataset
    • BaseSensitivityAnalysis.default_output_names
    • BaseSensitivityAnalysis.indices
    • BaseSensitivityAnalysis.input_names
    • BaseSensitivityAnalysis.main_indices
    • BaseSensitivityAnalysis.main_method
• gemseo.uncertainty.sensitivity.correlation_analysis module
  • CorrelationAnalysis
    • CorrelationAnalysis.Method
      • CorrelationAnalysis.Method.KENDALL
      • CorrelationAnalysis.Method.PCC
      • CorrelationAnalysis.Method.PEARSON
      • CorrelationAnalysis.Method.PRCC
      • CorrelationAnalysis.Method.SPEARMAN
      • CorrelationAnalysis.Method.SRC
      • CorrelationAnalysis.Method.SRRC
      • CorrelationAnalysis.Method.SSRC
    • CorrelationAnalysis.SensitivityIndices
      • CorrelationAnalysis.SensitivityIndices.kendall
      • CorrelationAnalysis.SensitivityIndices.pcc
      • CorrelationAnalysis.SensitivityIndices.pearson
      • CorrelationAnalysis.SensitivityIndices.prcc
      • CorrelationAnalysis.SensitivityIndices.spearman
      • CorrelationAnalysis.SensitivityIndices.src
      • CorrelationAnalysis.SensitivityIndices.srrc
      • CorrelationAnalysis.SensitivityIndices.ssrc
    • CorrelationAnalysis.compute_indices()
    • CorrelationAnalysis.plot()
    • CorrelationAnalysis.plot_radar()
    • CorrelationAnalysis.DEFAULT_DRIVER
• gemseo.uncertainty.sensitivity.factory module
  • SensitivityAnalysisFactory
• gemseo.uncertainty.sensitivity.hsic_analysis module
  • HSICAnalysis
    • HSICAnalysis.AnalysisType
      • HSICAnalysis.AnalysisType.CONDITIONAL
      • HSICAnalysis.AnalysisType.GLOBAL
      • HSICAnalysis.AnalysisType.TARGET
    • HSICAnalysis.CovarianceModel
      • HSICAnalysis.CovarianceModel.GAUSSIAN
    • HSICAnalysis.Method
      • HSICAnalysis.Method.HSIC
      • HSICAnalysis.Method.P_VALUE_ASYMPTOTIC
      • HSICAnalysis.Method.P_VALUE_PERMUTATION
      • HSICAnalysis.Method.R2_HSIC
    • HSICAnalysis.SensitivityIndices
      • HSICAnalysis.SensitivityIndices.hsic
      • HSICAnalysis.SensitivityIndices.p_value_asymptotic
      • HSICAnalysis.SensitivityIndices.p_value_permutation
      • HSICAnalysis.SensitivityIndices.r2_hsic
    • HSICAnalysis.StatisticEstimator
      • HSICAnalysis.StatisticEstimator.USTAT
      • HSICAnalysis.StatisticEstimator.VSTAT
    • HSICAnalysis.compute_indices()
    • HSICAnalysis.DEFAULT_DRIVER
• gemseo.uncertainty.sensitivity.morris_analysis module
  • OAT technique
  • Morris technique
  • MorrisAnalysis
    • MorrisAnalysis.Method
      • MorrisAnalysis.Method.MU_STAR
      • MorrisAnalysis.Method.SIGMA
    • MorrisAnalysis.SensitivityIndices
      • MorrisAnalysis.SensitivityIndices.max
      • MorrisAnalysis.SensitivityIndices.min
      • MorrisAnalysis.SensitivityIndices.mu
      • MorrisAnalysis.SensitivityIndices.mu_star
      • MorrisAnalysis.SensitivityIndices.relative_sigma
      • MorrisAnalysis.SensitivityIndices.sigma
    • MorrisAnalysis.compute_indices()
    • MorrisAnalysis.compute_samples()
    • MorrisAnalysis.plot()
    • MorrisAnalysis.DEFAULT_DRIVER
    • MorrisAnalysis.n_replicates
    • MorrisAnalysis.outputs_bounds
• gemseo.uncertainty.sensitivity.sobol_analysis module
  • SobolAnalysis
    • SobolAnalysis.Algorithm
      • SobolAnalysis.Algorithm.JANSEN
      • SobolAnalysis.Algorithm.MARTINEZ
      • SobolAnalysis.Algorithm.MAUNTZ_KUCHERENKO
      • SobolAnalysis.Algorithm.SALTELLI
    • SobolAnalysis.ControlVariate
      • SobolAnalysis.ControlVariate.discipline
      • SobolAnalysis.ControlVariate.indices
      • SobolAnalysis.ControlVariate.n_samples
      • SobolAnalysis.ControlVariate.variance
    • SobolAnalysis.Method
      • SobolAnalysis.Method.FIRST
      • SobolAnalysis.Method.TOTAL
    • SobolAnalysis.SensitivityIndices
      • SobolAnalysis.SensitivityIndices.first
      • SobolAnalysis.SensitivityIndices.second
      • SobolAnalysis.SensitivityIndices.total
    • SobolAnalysis.compute_indices()
    • SobolAnalysis.compute_samples()
    • SobolAnalysis.get_intervals()
    • SobolAnalysis.plot()
    • SobolAnalysis.unscale_indices()
    • SobolAnalysis.DEFAULT_DRIVER
    • SobolAnalysis.output_standard_deviations
    • SobolAnalysis.output_variances