gemseo_calibration / post

Show inherited members

factory module

A factory to post-process a CalibrationScenario.

class gemseo_calibration.post.factory.CalibrationPostFactory

Bases: PostFactory

A factory for calibration post-processing.

Return type:

Any

create(post_name, opt_problem, reference_data, prior_model_data, posterior_model_data)

Create the post-processing.

Parameters:

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

• 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.

Returns:

The post-processing of the optimization problem.

Raises:

TypeError – If the class cannot be instantiated.

Return type:

CalibrationPostProcessor

execute(opt_problem, reference_data, prior_model_data, posterior_model_data, post_name, save=True, show=False, file_path='', directory_path='', file_name='', file_extension='', **options)

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.

• save (bool) –

  Whether to save the figure.

  By default it is set to True.

• show (bool) –

  Whether to display the figure.

  By default it is set to False.

• file_path (str | Path) –

  The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

  By default it is set to “”.

• directory_path (str | Path) –

  The path of the directory to save the figures. If empty, use the current working directory.

  By default it is set to “”.

• file_name (str) –

  The name of the file to save the figures. If empty, use a default one generated by the post-processing.

  By default it is set to “”.

• file_extension (str) –

  A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If empty, use a default file extension.

  By default it is set to “”.

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

Returns:

The executed post-processing of the optimization problem.

Return type:

CalibrationPostProcessor

failed_imports: dict[str, str]

The class names bound to the import errors.