gemseo.post.opt_history_view_settings module#

Settings for post-processing.

Settings OptHistoryView_Settings(*, save=True, show=False, file_path='', directory_path='', file_name='', file_extension='', fig_size=(11.0, 6.0), variable_names=(), obj_relative=False, obj_min=None, obj_max=None)[source]#

Bases: BasePostSettings

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

  • save (bool) --

    By default it is set to True.

  • show (bool) --

    By default it is set to False.

  • file_path (Path | str) --

    By default it is set to "".

  • directory_path (Path | str) --

    By default it is set to "".

  • file_name (str) --

    By default it is set to "".

  • file_extension (str) --

    By default it is set to "".

  • fig_size (tuple[Annotated[float, Gt(gt=0)], Annotated[float, Gt(gt=0)]]) --

    By default it is set to (11.0, 6.0).

  • variable_names (Sequence[str]) --

    By default it is set to ().

  • obj_relative (bool) --

    By default it is set to False.

  • obj_min (float | None)

  • obj_max (float | None)

Return type:

None

obj_max: float | None = None#

The upper limit of the y-axis on which the objective is plotted. This limit must be greater than or equal to the maximum value of the objective history. If None, use the maximum value of the objective history.

obj_min: float | None = None#

The lower limit of the y-axis on which the objective is plotted. This limit must be less than or equal to the minimum value of the objective history. If None, use the minimum value of the objective history.

obj_relative: bool = False#

Whether the difference between the objective and its initial value is plotted instead of the objective.

variable_names: Sequence[str] = ()#

The names of the variables to display. If empty, use all design variables.

model_post_init(context, /)#

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that's what pydantic-core passes when calling it.

Parameters:

  • self (BaseModel) -- The BaseModel instance.

  • context (Any) -- The context.

Return type:

None