gemseo.post.correlations_settings module#

Settings for post-processing.

Settings Correlations_Settings(*, save=True, show=False, file_path='', directory_path='', file_name='', file_extension='', fig_size=(15.0, 10.0), n_plots_x=5, n_plots_y=5, coeff_limit=0.95, func_names=())[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 (15.0, 10.0).

  • n_plots_x (Annotated[int, Gt(gt=0)]) --

    By default it is set to 5.

  • n_plots_y (Annotated[int, Gt(gt=0)]) --

    By default it is set to 5.

  • coeff_limit (Annotated[float, Ge(ge=0.0), Le(le=1.0)]) --

    By default it is set to 0.95.

  • func_names (Sequence[str]) --

    By default it is set to ().

Return type:

None

coeff_limit: float = 0.95#

The minimum correlation coefficient below which the variable is not plotted.

Constraints:

  • ge = 0.0

  • le = 1.0

func_names: Sequence[str] = ()#

The names of the functions to be considered. If empty, all the functions are considered.

n_plots_x: PositiveInt = 5#

The number of horizontal plots.

Constraints:

  • gt = 0

n_plots_y: PositiveInt = 5#

The number of vertical plots.

Constraints:

  • gt = 0

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