gemseo / post

post_factory module

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

Classes:

PostFactory()

Post-processing factory to run optimization post-processors.

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.

Methods:

create(opt_problem, post_name)	Create a post-processor from its class name.
execute(opt_problem, post_name[, save, ...])	Post-process an optimization problem.
is_available(name)	Check the availability of a post-processor.
list_generated_plots()	The generated plot files.

Attributes:

posts

The available post processors.

create(opt_problem, post_name)

Create a post-processor from its class name.

Parameters

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

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

Return type

gemseo.post.opt_post_processor.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 (Union[str, gemseo.algos.opt_problem.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 (Optional[Union[str, pathlib.Path]]) –

  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.

  By default it is set to None.

• directory_path (Optional[Union[str, pathlib.Path]]) –

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

  By default it is set to None.

• file_name (Optional[str]) –

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

  By default it is set to None.

• file_extension (Optional[str]) –

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

  By default it is set to None.

• **options (Union[int, float, str, bool, Sequence[str]]) – The options of the post-processor.

Return type

Dict[str, matplotlib.figure.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

The available post processors.