geolib.models.dstability.states

This module handles the three types of state types in DStability.

Classes

DStabilityObject(**data)

DStabilityStateLinePoint(**data)

DStabilityStatePoint(**data)

DStability StatePoint

DStabilityStress(**data)

DStability Stress

class geolib.models.dstability.states.DStabilityObject(**data)
Parameters:

data (Any)

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

class geolib.models.dstability.states.DStabilityStateLinePoint(**data)
Parameters:

data (Any)

above: DStabilityStress
below: DStabilityStress
id: int
is_above_and_below_correlated: bool
is_probabilistic: bool
label: str
model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'above': FieldInfo(annotation=DStabilityStress, required=True), 'below': FieldInfo(annotation=DStabilityStress, required=True), 'id': FieldInfo(annotation=int, required=False, default=-1), 'is_above_and_below_correlated': FieldInfo(annotation=bool, required=False, default=False), 'is_probabilistic': FieldInfo(annotation=bool, required=False, default=False), 'label': FieldInfo(annotation=str, required=False, default=''), 'x': FieldInfo(annotation=float, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

x: float
class geolib.models.dstability.states.DStabilityStatePoint(**data)

DStability StatePoint

Parameters:
  • id (int) – id of the statepoint

  • layer_id (int) – id of the layer to add the statepoint, note that the API does not check if this point is within the layer

  • pop (float) – POP value, defaults to 0.0

  • point (Point) – location of the statepoint

  • stress (DStabilityStress) – DStabilityStress object

  • is_probabilistic (bool) – is probabilistic, default to false

  • label (str) – label of the statepoint

  • data (Any)

id: int
is_probabilistic: bool
label: str
layer_id: int
model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'id': FieldInfo(annotation=int, required=False, default=-1), 'is_probabilistic': FieldInfo(annotation=bool, required=False, default=False), 'label': FieldInfo(annotation=str, required=False, default=''), 'layer_id': FieldInfo(annotation=int, required=True), 'point': FieldInfo(annotation=Point, required=True), 'stress': FieldInfo(annotation=DStabilityStress, required=True)}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

point: Point
stress: DStabilityStress
class geolib.models.dstability.states.DStabilityStress(**data)

DStability Stress

Parameters:
model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'forbid', 'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_fields: ClassVar[dict[str, FieldInfo]] = {'ocr': FieldInfo(annotation=float, required=False, default=1.0), 'pop': FieldInfo(annotation=float, required=False, default=0.0), 'state_type': FieldInfo(annotation=InternalStateTypeEnum, required=False, default=<InternalStateTypeEnum.POP: 'Pop'>), 'stochastic_parameter': FieldInfo(annotation=PersistableStochasticParameter, required=False, default=PersistableStochasticParameter(IsProbabilistic=False, Mean=1.0, StandardDeviation=0.0))}

Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].

This replaces Model.__fields__ from Pydantic V1.

ocr: float
pop: float
state_type: InternalStateTypeEnum
stochastic_parameter: PersistableStochasticParameter