gemseo.uncertainty.distributions.openturns.weibull module#
The OpenTURNS-based Weibull distribution.
- class OTWeibullDistribution(location=0.0, scale=1.0, shape=1.0, use_weibull_min=True, transformation='', lower_bound=None, upper_bound=None, threshold=0.5)[source]#
Bases:
OTDistribution
The OpenTURNS-based Weibull distribution.
Examples
>>> from gemseo.uncertainty.distributions.openturns.distribution import ( ... OTDistribution, ... ) >>> distribution = OTDistribution("Exponential", (3, 2)) >>> print(distribution) Exponential(3, 2)
Initialize self. See help(type(self)) for accurate signature.
- Parameters:
location (float) --
The location parameter \(\gamma\) of the Weibull distribution.
By default it is set to 0.0.
scale (float) --
The scale parameter of the Weibull distribution.
By default it is set to 1.0.
shape (float) --
The shape parameter of the Weibull distribution.
By default it is set to 1.0.
use_weibull_min (bool) --
Whether to use the Weibull minimum extreme value distribution (the support of the random variable is \([\gamma,+\infty[\)) or the Weibull maximum extreme value distribution (the support of the random variable is \(]-\infty[,\gamma]\)).
By default it is set to True.
transformation (str) --
A transformation applied to the random variable, e.g. \(\sin(x)\). If empty, no transformation.
By default it is set to "".
lower_bound (float | None) -- A lower bound to truncate the probability distribution. If
None
, no lower truncation.upper_bound (float | None) -- An upper bound to truncate the probability distribution. If
None
, no upper truncation.threshold (float) --
A threshold in [0,1] (see OpenTURNS documentation).
By default it is set to 0.5.