gemseo_calibration / post

factory module

A factory to post-process a CalibrationScenario.

class gemseo_calibration.post.factory.CalibrationPostFactory[source]

Bases: PostFactory

A factory for calibration post-processing.

create(opt_problem, reference_data, prior_model_data, posterior_model_data, post_name)[source]

Create the post-processing.

Parameters:
  • opt_problem (OptimizationProblem) – The optimization problem containing the data to post-process.

  • reference_data (Dataset) – The reference data used during the calibration stage.

  • prior_model_data (Dataset) – The model data before the calibration stage.

  • posterior_model_data (Dataset) – The model data after the calibration stage.

  • post_name (str) – The name of the post-processing method.

Returns:

The post-processing of the optimization problem.

Return type:

CalibrationPostProcessor

execute(opt_problem, reference_data, prior_model_data, posterior_model_data, post_name, **options)[source]

Compute the post-processing.

Parameters:
  • opt_problem (str | OptimizationProblem) – The optimization problem containing the data to post-process.

  • reference_data (Dataset) – The reference data used during the calibration stage.

  • prior_model_data (Dataset) – The model data before the calibration stage.

  • posterior_model_data (Dataset) – The model data after the calibration stage.

  • post_name (str) – The name of the post-processing method.

  • **options (Any) – The options of the post-processing method.

Returns:

The executed post-processing of the optimization problem.

Return type:

CalibrationPostProcessor

is_available(name)

Check the availability of a post-processor.

Parameters:

name (str) – The name of the post-processor.

Returns:

Whether the post-processor is available.

Return type:

bool

list_generated_plots()

The generated plot files.

Return type:

set[str]

property posts: list[str]

The available post processors.