gemseo.post.radar_chart_settings module#

Settings for post-processing.

Settings RadarChart_Settings(*, save=True, show=False, file_path='', directory_path='', file_name='', file_extension='', fig_size=(6.4, 4.8), iteration=None, constraint_names=(), show_names_radially=False)[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 (6.4, 4.8).

  • iteration (int | None)

  • constraint_names (Sequence[str]) --

    By default it is set to ().

  • show_names_radially (bool) --

    By default it is set to False.

Return type:

None

constraint_names: Sequence[str] = ()#

The names of the constraints. If empty, use all the constraints.

iteration: int | None = None#

Either an iteration in \(\{-N,\ldots,-1,1,\ldots,N\}\) or None for the iteration at which the optimum is located, where \(N\) is the length of the database.

show_names_radially: bool = False#

Whether to write the names of the constraints in the radial direction. Otherwise, write them horizontally. The radial direction can be useful for a high number of constraints.

model_post_init(context, /)#

We need to both initialize private attributes and call the user-defined model_post_init method.

Parameters:

  • self (BaseModel)

  • context (Any)

Return type:

None