gemseo.uncertainty.distributions.base_settings.normal_settings module#

Base settings for defining a normal distribution.

Settings BaseNormalDistribution_Settings(*, mu=0.0, sigma=1.0)[source]#

Bases: BaseDistribution_Settings

The base settings of a normal distribution.

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:

  • mu (float) --

    By default it is set to 0.0.

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

    By default it is set to 1.0.

Return type:

None

mu: float = 0.0#

The mean of the normal random variable.

sigma: PositiveFloat = 1.0#

The standard deviation of the normal random variable.

Constraints:

  • gt = 0