gemseo / post

post_factory module

A factory to create or execute a post-processor from its class name.

class gemseo.post.post_factory.PostFactory

Bases: object

Post-processing factory to run optimization post-processors.

List the available post-processors on the current configuration and execute them on demand.

Work both from memory, from a ran optimization problem, and from disk, from a serialized optimization problem.

create(opt_problem, post_name)

Create a post-processor from its class name.

Parameters:

• opt_problem (OptimizationProblem) – The optimization problem to be post-processed.

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

Return type:

OptPostProcessor

execute(opt_problem, post_name, save=True, show=False, file_path=None, directory_path=None, file_name=None, file_extension=None, **options)

Post-process an optimization problem.

Parameters:

• opt_problem (str | OptimizationProblem) – The optimization problem to be post-processed.

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

• save (bool) –

  If True, save the figure.

  By default it is set to True.

• show (bool) –

  If True, display the figure.

  By default it is set to False.

• file_path (str | Path | None) – The path of the file to save the figures. If the extension is missing, use file_extension. If None, create a file path from directory_path, file_name and file_extension.

• directory_path (str | Path | None) – The path of the directory to save the figures. If None, use the current working directory.

• file_name (str | None) – The name of the file to save the figures. If None, use a default one generated by the post-processing.

• file_extension (str | None) – A file extension, e.g. ‘png’, ‘pdf’, ‘svg’, … If None, use a default file extension.

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

Return type:

dict[str, Figure]

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.

Examples using PostFactory

Pareto front on Binh and Korn problem

Pareto front on Binh and Korn problem