gemseo_calibration / post

Hide inherited members

factory module

A factory to post-process a CalibrationScenario.

class gemseo_calibration.post.factory.CalibrationPostFactory[source]

Bases: PostFactory

A factory for calibration post-processing.

Return type:

Any

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

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)[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.

  • 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

get_class(name)

Return a class from its name.

Parameters:

name (str) – The name of the class.

Returns:

The class.

Raises:

ImportError – If the class is not available.

Return type:

type[T]

get_default_option_values(name)

Return the constructor kwargs default values of a class.

Parameters:

name (str) – The name of the class.

Returns:

The mapping from the argument names to their default values.

Return type:

dict[str, str | int | float | bool]

get_default_sub_option_values(name, **options)

Return the default values of the sub options of a class.

Parameters:

  • name (str) – The name of the class.

  • **options (str) – The options to be passed to the class required to deduce the sub options.

Returns:

The JSON grammar.

Return type:

JSONGrammar

get_library_name(name)

Return the name of the library related to the name of a class.

Parameters:

name (str) – The name of the class.

Returns:

The name of the library.

Return type:

str

get_options_doc(name)

Return the constructor documentation of a class.

Parameters:

name (str) – The name of the class.

Returns:

The mapping from the argument names to their documentation.

Return type:

dict[str, str]

get_options_grammar(name, write_schema=False, schema_path='')

Return the options JSON grammar for a class.

Attempt to generate a JSONGrammar from the arguments of the __init__ method of the class.

Parameters:

  • name (str) – The name of the class.

  • write_schema (bool) –

    If True, write the JSON schema to a file.

    By default it is set to False.

  • schema_path (Path | str) –

    The path to the JSON schema file. If None, the file is saved in the current directory in a file named after the name of the class.

    By default it is set to “”.

Returns:

The JSON grammar.

Return type:

JSONGrammar

get_sub_options_grammar(name, **options)

Return the JSONGrammar of the sub options of a class.

Parameters:

  • name (str) – The name of the class.

  • **options (str) – The options to be passed to the class required to deduce the sub options.

Returns:

The JSON grammar.

Return type:

JSONGrammar

is_available(name)

Return whether a class can be instantiated.

Parameters:

name (str) – The name of the class.

Returns:

Whether the class can be instantiated.

Return type:

bool

list_generated_plots()

The generated plot files.

Return type:

set[str]

update()

Search for the classes that can be instantiated.

The search is done in the following order:

  1. The fully qualified module names

  2. The plugin packages

  3. The packages from the environment variables

Return type:

None

PLUGIN_ENTRY_POINT: ClassVar[str] = 'gemseo_plugins'

The name of the setuptools entry point for declaring plugins.

property class_names: list[str]

The sorted names of the available classes.

failed_imports: dict[str, str]

The class names bound to the import errors.

property posts: list[str]

The available post processors.