gemseo / post

Show inherited members

animation module

Make an animated GIF from an OptPostProcessor.

class gemseo.post.animation.Animation(opt_problem)

Bases: OptPostProcessor

Animated GIF maker from an OptPostProcessor.

Parameters:

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

Raises:

ValueError – If the JSON grammar file for the options of the post-processor does not exist.

check_options(**options)

Check the options to execute Animation.

This includes the options of the OptPostProcessor.

Parameters:

**options (int | float | str | bool | Sequence[str] | tuple[float, float]) – The options of the Animation.

Raises:

InvalidDataError – If an option is invalid according to the grammar.

Return type:

None

DEFAULT_OPT_POST_PROCESSOR: ClassVar[str] = 'BasicHistory'

The class name of the default OptPostProcessor.

database: Database

The database generated by the optimization problem.

materials_for_plotting: dict[Any, Any]

The materials to eventually rebuild the plot in another framework.

opt_problem: OptimizationProblem

The optimization problem.