Data Models#
Hazard Models#
Earthquake Models#
- pydantic model erad.models.hazard.earthquake.EarthQuakeModel#
Show JSON schema
{ "title": "EarthQuakeModel", "type": "object", "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "title": "Name", "type": "string" }, "timestamp": { "format": "date-time", "title": "Timestamp", "type": "string" }, "origin": { "default": null, "title": "Origin" }, "depth": { "title": "Depth" }, "magnitude": { "title": "Magnitude", "type": "number" } }, "additionalProperties": false, "required": [ "name", "timestamp", "depth", "magnitude" ] }
- Config:
str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True
- Fields:
- Validators:
- field depth: Distance [Required]#
- field magnitude: float [Required]#
- field origin: Point [Required]#
- Validated by:
- field timestamp: datetime [Required]#
- classmethod from_earthquake_code(earthquake_code: str) EarthQuakeModel#
- plot(time_index: int = 0, figure: ~plotly.graph_objs._figure.Figure = Figure({ 'data': [], 'layout': {'template': '...'} }), map_obj: type[~plotly.graph_objs._scattergeo.Scattergeo | ~plotly.graph_objs._scattermap.Scattermap] = <class 'plotly.graph_objs._scattermap.Scattermap'>) int#
- serialize_location(point: Point, _info)#
Wind Models#
- pydantic model erad.models.hazard.wind.WindModel#
Show JSON schema
{ "title": "WindModel", "type": "object", "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "title": "Name", "type": "string" }, "timestamp": { "format": "date-time", "title": "Timestamp", "type": "string" }, "center": { "default": null, "title": "Center" }, "max_wind_speed": { "title": "Max Wind Speed" }, "radius_of_max_wind": { "title": "Radius Of Max Wind" }, "radius_of_closest_isobar": { "title": "Radius Of Closest Isobar" }, "air_pressure": { "title": "Air Pressure" } }, "additionalProperties": false, "required": [ "name", "timestamp", "max_wind_speed", "radius_of_max_wind", "radius_of_closest_isobar", "air_pressure" ] }
- Config:
str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True
- Fields:
- Validators:
- field center: Point [Required]#
- Validated by:
- field radius_of_closest_isobar: Distance [Required]#
- field radius_of_max_wind: Distance [Required]#
- field timestamp: datetime [Required]#
- classmethod example() WindModel#
Return an example instance of the model.
- Raises:
NotImplementedError – Raised if the model does not implement this method.
- plot(time_index: int = 0, figure: ~plotly.graph_objs._figure.Figure = Figure({ 'data': [], 'layout': {'template': '...'} }), map_obj: type[~plotly.graph_objs._scattergeo.Scattergeo | ~plotly.graph_objs._scattermap.Scattermap] = <class 'plotly.graph_objs._scattermap.Scattermap'>) int#
- serialize_location(point: Point, _info)#
Flood Models#
- pydantic model erad.models.hazard.flood.FloodModelArea#
Show JSON schema
{ "title": "FloodModelArea", "type": "object", "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "affected_area": { "default": null, "title": "Affected Area" }, "water_velocity": { "title": "Water Velocity" }, "water_elevation": { "title": "Water Elevation" } }, "additionalProperties": false, "required": [ "water_velocity", "water_elevation" ] }
- Config:
str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True
- Fields:
- Validators:
- field affected_area: Polygon [Required]#
- Validated by:
- field name: str = ''#
- field water_elevation: Distance [Required]#
- validator deserialize_polygon » affected_area#
- classmethod example() FloodModelArea#
Return an example instance of the model.
- Raises:
NotImplementedError – Raised if the model does not implement this method.
- serialize_polygon(poly: Polygon, _info)#
- pydantic model erad.models.hazard.flood.FloodModel#
Show JSON schema
{ "title": "FloodModel", "type": "object", "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "title": "Name", "type": "string" }, "timestamp": { "format": "date-time", "title": "Timestamp", "type": "string" }, "affected_areas": { "default": null, "title": "Affected Areas" } }, "additionalProperties": false, "required": [ "name", "timestamp" ] }
- Config:
str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True
- Fields:
- field affected_areas: list[FloodModelArea] [Required]#
- field timestamp: datetime [Required]#
- classmethod example() FloodModel#
Return an example instance of the model.
- Raises:
NotImplementedError – Raised if the model does not implement this method.
- plot(time_index: int = 0, figure: ~plotly.graph_objs._figure.Figure = Figure({ 'data': [], 'layout': {'template': '...'} }), map_obj: type[~plotly.graph_objs._scattergeo.Scattergeo | ~plotly.graph_objs._scattermap.Scattermap] = <class 'plotly.graph_objs._scattermap.Scattermap'>) int#
Fire Models#
- pydantic model erad.models.hazard.wild_fire.FireModel#
Show JSON schema
{ "title": "FireModel", "type": "object", "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "title": "Name", "type": "string" }, "timestamp": { "format": "date-time", "title": "Timestamp", "type": "string" }, "affected_areas": { "default": null, "title": "Affected Areas" } }, "additionalProperties": false, "required": [ "name", "timestamp" ] }
- Config:
str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True
- Fields:
- field affected_areas: list[FireModelArea] [Required]#
- field timestamp: datetime [Required]#
- classmethod example() FireModel#
Return an example instance of the model.
- Raises:
NotImplementedError – Raised if the model does not implement this method.
- plot(time_index: int = 0, figure: ~plotly.graph_objs._figure.Figure = Figure({ 'data': [], 'layout': {'template': '...'} }), map_obj: type[~plotly.graph_objs._scattergeo.Scattergeo | ~plotly.graph_objs._scattermap.Scattermap] = <class 'plotly.graph_objs._scattermap.Scattermap'>) int#
- pydantic model erad.models.hazard.wild_fire.FireModelArea#
Show JSON schema
{ "title": "FireModelArea", "type": "object", "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "affected_area": { "default": null, "title": "Affected Area" }, "wind_speed": { "title": "Wind Speed" }, "wind_direction": { "title": "Wind Direction" } }, "additionalProperties": false, "required": [ "wind_speed", "wind_direction" ] }
- Config:
str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True
- Fields:
- Validators:
- field affected_area: Polygon [Required]#
- Validated by:
- field name: str = ''#
- field wind_direction: Angle [Required]#
- validator deserialize_polygon » affected_area#
- classmethod example() FireModelArea#
Return an example instance of the model.
- Raises:
NotImplementedError – Raised if the model does not implement this method.
- serialize_polygon(poly: Polygon, _info)#
Asset Model#
- pydantic model erad.models.asset.AssetState#
Show JSON schema
{ "title": "AssetState", "type": "object", "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "timestamp": { "format": "date-time", "title": "Timestamp", "type": "string" }, "wind_speed": { "anyOf": [ { "$ref": "#/$defs/SpeedProbability" }, { "type": "null" } ], "default": null }, "flood_velocity": { "anyOf": [ { "$ref": "#/$defs/SpeedProbability" }, { "type": "null" } ], "default": null }, "flood_depth": { "anyOf": [ { "$ref": "#/$defs/DistanceProbability" }, { "type": "null" } ], "default": null }, "fire_boundary_dist": { "anyOf": [ { "$ref": "#/$defs/DistanceProbability" }, { "type": "null" } ], "default": null }, "peak_ground_velocity": { "anyOf": [ { "$ref": "#/$defs/SpeedProbability" }, { "type": "null" } ], "default": null }, "peak_ground_acceleration": { "anyOf": [ { "$ref": "#/$defs/AccelerationProbability" }, { "type": "null" } ], "default": null } }, "$defs": { "AccelerationProbability": { "additionalProperties": false, "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "survival_probability": { "default": 1.0, "description": "Asset survival probability", "maximum": 1.0, "minimum": 0.0, "title": "Survival Probability", "type": "number" }, "acceleration": { "default": "0 meter / second ** 2", "title": "Acceleration" } }, "title": "AccelerationProbability", "type": "object" }, "DistanceProbability": { "additionalProperties": false, "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "survival_probability": { "default": 1.0, "description": "Asset survival probability", "maximum": 1.0, "minimum": 0.0, "title": "Survival Probability", "type": "number" }, "distance": { "default": "-9999 meter", "description": "Distance of asset from the source / boundary of a disaster event", "title": "Distance" } }, "title": "DistanceProbability", "type": "object" }, "SpeedProbability": { "additionalProperties": false, "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "survival_probability": { "default": 1.0, "description": "Asset survival probability", "maximum": 1.0, "minimum": 0.0, "title": "Survival Probability", "type": "number" }, "speed": { "description": "Represents the speed of a scenario parameter experienced by the asset e.g speed of wind", "title": "Speed" } }, "required": [ "speed" ], "title": "SpeedProbability", "type": "object" } }, "additionalProperties": false, "required": [ "timestamp" ] }
- Config:
str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True
- Fields:
fire_boundary_dist (erad.models.probability.DistanceProbability | None)flood_depth (erad.models.probability.DistanceProbability | None)flood_velocity (erad.models.probability.SpeedProbability | None)peak_ground_acceleration (erad.models.probability.AccelerationProbability | None)peak_ground_velocity (erad.models.probability.SpeedProbability | None)wind_speed (erad.models.probability.SpeedProbability | None)
- field fire_boundary_dist: DistanceProbability | None = None#
- field flood_depth: DistanceProbability | None = None#
- field flood_velocity: SpeedProbability | None = None#
- field name: str = ''#
- field peak_ground_acceleration: AccelerationProbability | None = None#
- field peak_ground_velocity: SpeedProbability | None = None#
- field timestamp: datetime [Required]#
- field wind_speed: SpeedProbability | None = None#
- calculate_earthquake_vectors(asset_coordinate: Point, hazard_model: EarthQuakeModel)#
Sources:
Atkinson, G.M., & Wald, D.J. (2007). “Did You Feel It?” intensity data: A surprisingly good measure of earthquake ground motion. Seismological Research Letters, 78(3), 362–368.
- calculate_fire_vectors(asset_coordinate: Point, hazard_model: FireModel)#
Sources:
“Integrating Wildfire Risk Modeling with Electric Grid Asset Management” (EPRI) “Modeling and Mitigating Wildfire Risk to the Power Grid” (PNNL, 2021) “A Framework for Assessing Wildfire Ignition Risk on Distribution Systems”
(IEEE Transactions on Power Systems, 2020)
Improving Grid Safety and Resilience to Mitigate Ignition Incident and Fire Risks – EPRI Wildfire Risk Reduction Methods 2024 – EPRI
- calculate_flood_vectors(asset_coordinate: Point, hazard_model: FloodModel, asset_total_elevation: Distance)#
- classmethod example() AssetState#
Return an example instance of the model.
- Raises:
NotImplementedError – Raised if the model does not implement this method.
- property survival_probability: float#
- pydantic model erad.models.asset.Asset#
Show JSON schema
{ "title": "Asset", "type": "object", "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "title": "Name", "type": "string" }, "distribution_asset": { "description": "UUID of the distribution asset", "format": "uuid", "title": "Distribution Asset", "type": "string" }, "connections": { "default": [], "description": "List of UUIDs of connected assets", "items": { "format": "uuid", "type": "string" }, "title": "Connections", "type": "array" }, "devices": { "default": [], "description": "List of UUIDs of devices associated with the asset", "items": { "format": "uuid", "type": "string" }, "title": "Devices", "type": "array" }, "asset_type": { "$ref": "#/$defs/AssetTypes", "description": "Type of the asset" }, "height": { "description": "Height of the asset", "title": "Height" }, "latitude": { "description": "Latitude in degrees", "maximum": 90.0, "minimum": -90.0, "title": "Latitude", "type": "number" }, "longitude": { "description": "Longitude in degrees", "maximum": 180.0, "minimum": -180.0, "title": "Longitude", "type": "number" }, "asset_state": { "description": "List of asset states associated with the asset", "items": { "$ref": "#/$defs/AssetState" }, "title": "Asset State", "type": "array" } }, "$defs": { "AccelerationProbability": { "additionalProperties": false, "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "survival_probability": { "default": 1.0, "description": "Asset survival probability", "maximum": 1.0, "minimum": 0.0, "title": "Survival Probability", "type": "number" }, "acceleration": { "default": "0 meter / second ** 2", "title": "Acceleration" } }, "title": "AccelerationProbability", "type": "object" }, "AssetState": { "additionalProperties": false, "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "timestamp": { "format": "date-time", "title": "Timestamp", "type": "string" }, "wind_speed": { "anyOf": [ { "$ref": "#/$defs/SpeedProbability" }, { "type": "null" } ], "default": null }, "flood_velocity": { "anyOf": [ { "$ref": "#/$defs/SpeedProbability" }, { "type": "null" } ], "default": null }, "flood_depth": { "anyOf": [ { "$ref": "#/$defs/DistanceProbability" }, { "type": "null" } ], "default": null }, "fire_boundary_dist": { "anyOf": [ { "$ref": "#/$defs/DistanceProbability" }, { "type": "null" } ], "default": null }, "peak_ground_velocity": { "anyOf": [ { "$ref": "#/$defs/SpeedProbability" }, { "type": "null" } ], "default": null }, "peak_ground_acceleration": { "anyOf": [ { "$ref": "#/$defs/AccelerationProbability" }, { "type": "null" } ], "default": null } }, "required": [ "timestamp" ], "title": "AssetState", "type": "object" }, "AssetTypes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13 ], "title": "AssetTypes", "type": "integer" }, "DistanceProbability": { "additionalProperties": false, "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "survival_probability": { "default": 1.0, "description": "Asset survival probability", "maximum": 1.0, "minimum": 0.0, "title": "Survival Probability", "type": "number" }, "distance": { "default": "-9999 meter", "description": "Distance of asset from the source / boundary of a disaster event", "title": "Distance" } }, "title": "DistanceProbability", "type": "object" }, "SpeedProbability": { "additionalProperties": false, "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "survival_probability": { "default": 1.0, "description": "Asset survival probability", "maximum": 1.0, "minimum": 0.0, "title": "Survival Probability", "type": "number" }, "speed": { "description": "Represents the speed of a scenario parameter experienced by the asset e.g speed of wind", "title": "Speed" } }, "required": [ "speed" ], "title": "SpeedProbability", "type": "object" } }, "additionalProperties": false, "required": [ "name", "distribution_asset", "asset_type", "height", "latitude", "longitude", "asset_state" ] }
- Config:
str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True
- Fields:
- field asset_state: list[AssetState] [Required]#
List of asset states associated with the asset
- field asset_type: AssetTypes [Required]#
Type of the asset
- field connections: list[UUID] = []#
List of UUIDs of connected assets
- field devices: list[UUID] = []#
List of UUIDs of devices associated with the asset
- field distribution_asset: UUID [Required]#
UUID of the distribution asset
- field height: Distance [Required]#
Height of the asset
- field latitude: float [Required]#
Latitude in degrees
- Constraints:
ge = -90
le = 90
- field longitude: float [Required]#
Longitude in degrees
- Constraints:
ge = -180
le = 180
- calculate_probabilities(asset_state: AssetState, frag_curves)#
- classmethod example() Asset#
Return an example instance of the model.
- Raises:
NotImplementedError – Raised if the model does not implement this method.
- get_vadid_curve(frag_curves, field: SyntaxError) float#
- model_post_init(context: Any, /) None#
This function is meant to behave like a BaseModel method to initialise private attributes.
It takes context as an argument since that’s what pydantic-core passes when calling it.
- Parameters:
self – The BaseModel instance.
context – The context.
- update_survival_probability(time_stamp: datetime, hazard_model: BaseDisasterModel, frag_curves)#
- property elevation: Distance#
Asset Mapping Model#
- pydantic model erad.models.asset_mapping.ComponentFilterModel#
Show JSON schema
{ "title": "ComponentFilterModel", "type": "object", "properties": { "component_type": { "title": "Component Type" }, "component_filter": { "default": null, "title": "Component Filter" } }, "additionalProperties": false, "required": [ "component_type" ] }
- Config:
arbitrary_types_allowed: bool = True
extra: str = forbid
- Fields:
- field component_filter: Callable | None = None#
- field component_type: Type[Component] [Required]#
- pydantic model erad.models.asset_mapping.AssetComponentMap#
Show JSON schema
{ "title": "AssetComponentMap", "type": "object", "properties": { "asset_type": { "$ref": "#/$defs/AssetTypes" }, "filters": { "default": null, "title": "Filters" } }, "$defs": { "AssetTypes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13 ], "title": "AssetTypes", "type": "integer" } }, "additionalProperties": false, "required": [ "asset_type" ] }
- Config:
arbitrary_types_allowed: bool = True
extra: str = forbid
- Fields:
- field asset_type: AssetTypes [Required]#
- field filters: list[ComponentFilterModel] = []#
Fragility Model#
- pydantic model erad.models.fragility_curve.ProbabilityFunction#
Show JSON schema
{ "title": "ProbabilityFunction", "type": "object", "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "distribution": { "enum": [ "BSpline", "CensoredData", "FitDataError", "FitError", "FitSolverError", "FitUniformFixedScaleDataError", "Iterable", "LowLevelCallable", "Polynomial", "alpha", "alpha_gen", "anglit", "anglit_gen", "arcsine", "arcsine_gen", "argus", "argus_gen", "beta", "beta_gen", "betaprime", "betaprime_gen", "bradford", "bradford_gen", "burr", "burr12", "burr12_gen", "burr_gen", "cached_property", "cauchy", "cauchy_gen", "chi", "chi2", "chi2_gen", "chi_gen", "cosine", "cosine_gen", "crystalball", "crystalball_gen", "ctypes", "dgamma", "dgamma_gen", "dpareto_lognorm", "dpareto_lognorm_gen", "dweibull", "dweibull_gen", "erlang", "erlang_gen", "expon", "expon_gen", "exponnorm", "exponnorm_gen", "exponpow", "exponpow_gen", "exponweib", "exponweib_gen", "extend_notes_in_docstring", "f", "f_gen", "fatiguelife", "fatiguelife_gen", "fisk", "fisk_gen", "foldcauchy", "foldcauchy_gen", "foldnorm", "foldnorm_gen", "gamma", "gamma_gen", "gausshyper", "gausshyper_gen", "genexpon", "genexpon_gen", "genextreme", "genextreme_gen", "gengamma", "gengamma_gen", "genhalflogistic", "genhalflogistic_gen", "genhyperbolic", "genhyperbolic_gen", "geninvgauss", "geninvgauss_gen", "genlogistic", "genlogistic_gen", "gennorm", "gennorm_gen", "genpareto", "genpareto_gen", "get_distribution_names", "gibrat", "gibrat_gen", "gompertz", "gompertz_gen", "gumbel_l", "gumbel_l_gen", "gumbel_r", "gumbel_r_gen", "halfcauchy", "halfcauchy_gen", "halfgennorm", "halfgennorm_gen", "halflogistic", "halflogistic_gen", "halfnorm", "halfnorm_gen", "hypsecant", "hypsecant_gen", "inherit_docstring_from", "integrate", "invgamma", "invgamma_gen", "invgauss", "invgauss_gen", "invweibull", "invweibull_gen", "irwinhall", "irwinhall_gen", "jf_skew_t", "jf_skew_t_gen", "johnsonsb", "johnsonsb_gen", "johnsonsu", "johnsonsu_gen", "kappa3", "kappa3_gen", "kappa4", "kappa4_gen", "kolmogn", "kolmogni", "kolmognp", "ksone", "ksone_gen", "kstwo", "kstwo_gen", "kstwobign", "kstwobign_gen", "landau", "landau_gen", "laplace", "laplace_asymmetric", "laplace_asymmetric_gen", "laplace_gen", "levy", "levy_gen", "levy_l", "levy_l_gen", "loggamma", "loggamma_gen", "logistic", "logistic_gen", "loglaplace", "loglaplace_gen", "lognorm", "lognorm_gen", "loguniform", "lomax", "lomax_gen", "maxwell", "maxwell_gen", "mielke", "mielke_gen", "moyal", "moyal_gen", "nakagami", "nakagami_gen", "ncf", "ncf_gen", "nct", "nct_gen", "ncx2", "ncx2_gen", "norm", "norm_gen", "norminvgauss", "norminvgauss_gen", "np", "operator", "optimize", "pairs", "pareto", "pareto_gen", "pearson3", "pearson3_gen", "powerlaw", "powerlaw_gen", "powerlognorm", "powerlognorm_gen", "powernorm", "powernorm_gen", "rayleigh", "rayleigh_gen", "rdist", "rdist_gen", "recipinvgauss", "recipinvgauss_gen", "reciprocal", "reciprocal_gen", "rel_breitwigner", "rel_breitwigner_gen", "replace_notes_in_docstring", "rice", "rice_gen", "root_scalar", "rv_continuous", "rv_histogram", "sc", "scu", "semicircular", "semicircular_gen", "skewcauchy", "skewcauchy_gen", "skewnorm", "skewnorm_gen", "stats", "studentized_range", "studentized_range_gen", "t", "t_gen", "trapezoid", "trapezoid_gen", "triang", "triang_gen", "truncexpon", "truncexpon_gen", "truncnorm", "truncnorm_gen", "truncpareto", "truncpareto_gen", "truncweibull_min", "truncweibull_min_gen", "tukeylambda", "tukeylambda_gen", "uniform", "uniform_gen", "vonmises", "vonmises_gen", "vonmises_line", "wald", "wald_gen", "warnings", "weibull_max", "weibull_max_gen", "weibull_min", "weibull_min_gen", "wrapcauchy", "wrapcauchy_gen", "wraps", "xpx" ], "title": "Distribution", "type": "string" }, "parameters": { "items": { "anyOf": [ { "type": "number" }, {} ] }, "title": "Parameters", "type": "array" } }, "additionalProperties": false, "required": [ "distribution", "parameters" ] }
- Config:
str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True
- Fields:
- Validators:
- field distribution: Literal['BSpline', 'CensoredData', 'FitDataError', 'FitError', 'FitSolverError', 'FitUniformFixedScaleDataError', 'Iterable', 'LowLevelCallable', 'Polynomial', 'alpha', 'alpha_gen', 'anglit', 'anglit_gen', 'arcsine', 'arcsine_gen', 'argus', 'argus_gen', 'beta', 'beta_gen', 'betaprime', 'betaprime_gen', 'bradford', 'bradford_gen', 'burr', 'burr12', 'burr12_gen', 'burr_gen', 'cached_property', 'cauchy', 'cauchy_gen', 'chi', 'chi2', 'chi2_gen', 'chi_gen', 'cosine', 'cosine_gen', 'crystalball', 'crystalball_gen', 'ctypes', 'dgamma', 'dgamma_gen', 'dpareto_lognorm', 'dpareto_lognorm_gen', 'dweibull', 'dweibull_gen', 'erlang', 'erlang_gen', 'expon', 'expon_gen', 'exponnorm', 'exponnorm_gen', 'exponpow', 'exponpow_gen', 'exponweib', 'exponweib_gen', 'extend_notes_in_docstring', 'f', 'f_gen', 'fatiguelife', 'fatiguelife_gen', 'fisk', 'fisk_gen', 'foldcauchy', 'foldcauchy_gen', 'foldnorm', 'foldnorm_gen', 'gamma', 'gamma_gen', 'gausshyper', 'gausshyper_gen', 'genexpon', 'genexpon_gen', 'genextreme', 'genextreme_gen', 'gengamma', 'gengamma_gen', 'genhalflogistic', 'genhalflogistic_gen', 'genhyperbolic', 'genhyperbolic_gen', 'geninvgauss', 'geninvgauss_gen', 'genlogistic', 'genlogistic_gen', 'gennorm', 'gennorm_gen', 'genpareto', 'genpareto_gen', 'get_distribution_names', 'gibrat', 'gibrat_gen', 'gompertz', 'gompertz_gen', 'gumbel_l', 'gumbel_l_gen', 'gumbel_r', 'gumbel_r_gen', 'halfcauchy', 'halfcauchy_gen', 'halfgennorm', 'halfgennorm_gen', 'halflogistic', 'halflogistic_gen', 'halfnorm', 'halfnorm_gen', 'hypsecant', 'hypsecant_gen', 'inherit_docstring_from', 'integrate', 'invgamma', 'invgamma_gen', 'invgauss', 'invgauss_gen', 'invweibull', 'invweibull_gen', 'irwinhall', 'irwinhall_gen', 'jf_skew_t', 'jf_skew_t_gen', 'johnsonsb', 'johnsonsb_gen', 'johnsonsu', 'johnsonsu_gen', 'kappa3', 'kappa3_gen', 'kappa4', 'kappa4_gen', 'kolmogn', 'kolmogni', 'kolmognp', 'ksone', 'ksone_gen', 'kstwo', 'kstwo_gen', 'kstwobign', 'kstwobign_gen', 'landau', 'landau_gen', 'laplace', 'laplace_asymmetric', 'laplace_asymmetric_gen', 'laplace_gen', 'levy', 'levy_gen', 'levy_l', 'levy_l_gen', 'loggamma', 'loggamma_gen', 'logistic', 'logistic_gen', 'loglaplace', 'loglaplace_gen', 'lognorm', 'lognorm_gen', 'loguniform', 'lomax', 'lomax_gen', 'maxwell', 'maxwell_gen', 'mielke', 'mielke_gen', 'moyal', 'moyal_gen', 'nakagami', 'nakagami_gen', 'ncf', 'ncf_gen', 'nct', 'nct_gen', 'ncx2', 'ncx2_gen', 'norm', 'norm_gen', 'norminvgauss', 'norminvgauss_gen', 'np', 'operator', 'optimize', 'pairs', 'pareto', 'pareto_gen', 'pearson3', 'pearson3_gen', 'powerlaw', 'powerlaw_gen', 'powerlognorm', 'powerlognorm_gen', 'powernorm', 'powernorm_gen', 'rayleigh', 'rayleigh_gen', 'rdist', 'rdist_gen', 'recipinvgauss', 'recipinvgauss_gen', 'reciprocal', 'reciprocal_gen', 'rel_breitwigner', 'rel_breitwigner_gen', 'replace_notes_in_docstring', 'rice', 'rice_gen', 'root_scalar', 'rv_continuous', 'rv_histogram', 'sc', 'scu', 'semicircular', 'semicircular_gen', 'skewcauchy', 'skewcauchy_gen', 'skewnorm', 'skewnorm_gen', 'stats', 'studentized_range', 'studentized_range_gen', 't', 't_gen', 'trapezoid', 'trapezoid_gen', 'triang', 'triang_gen', 'truncexpon', 'truncexpon_gen', 'truncnorm', 'truncnorm_gen', 'truncpareto', 'truncpareto_gen', 'truncweibull_min', 'truncweibull_min_gen', 'tukeylambda', 'tukeylambda_gen', 'uniform', 'uniform_gen', 'vonmises', 'vonmises_gen', 'vonmises_line', 'wald', 'wald_gen', 'warnings', 'weibull_max', 'weibull_max_gen', 'weibull_min', 'weibull_min_gen', 'wrapcauchy', 'wrapcauchy_gen', 'wraps', 'xpx'] [Required]#
- field name: str = ''#
- field parameters: list[float | BaseQuantity] [Required]#
- Validated by:
- classmethod example() ProbabilityFunction#
Return an example instance of the model.
- Raises:
NotImplementedError – Raised if the model does not implement this method.
- validator validate_parameters » parameters#
- property prob_model: ProbabilityFunctionBuilder#
- pydantic model erad.models.fragility_curve.FragilityCurve#
Show JSON schema
{ "title": "FragilityCurve", "type": "object", "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "asset_type": { "$ref": "#/$defs/AssetTypes" }, "prob_function": { "$ref": "#/$defs/ProbabilityFunction" } }, "$defs": { "AssetTypes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13 ], "title": "AssetTypes", "type": "integer" }, "ProbabilityFunction": { "additionalProperties": false, "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "distribution": { "enum": [ "BSpline", "CensoredData", "FitDataError", "FitError", "FitSolverError", "FitUniformFixedScaleDataError", "Iterable", "LowLevelCallable", "Polynomial", "alpha", "alpha_gen", "anglit", "anglit_gen", "arcsine", "arcsine_gen", "argus", "argus_gen", "beta", "beta_gen", "betaprime", "betaprime_gen", "bradford", "bradford_gen", "burr", "burr12", "burr12_gen", "burr_gen", "cached_property", "cauchy", "cauchy_gen", "chi", "chi2", "chi2_gen", "chi_gen", "cosine", "cosine_gen", "crystalball", "crystalball_gen", "ctypes", "dgamma", "dgamma_gen", "dpareto_lognorm", "dpareto_lognorm_gen", "dweibull", "dweibull_gen", "erlang", "erlang_gen", "expon", "expon_gen", "exponnorm", "exponnorm_gen", "exponpow", "exponpow_gen", "exponweib", "exponweib_gen", "extend_notes_in_docstring", "f", "f_gen", "fatiguelife", "fatiguelife_gen", "fisk", "fisk_gen", "foldcauchy", "foldcauchy_gen", "foldnorm", "foldnorm_gen", "gamma", "gamma_gen", "gausshyper", "gausshyper_gen", "genexpon", "genexpon_gen", "genextreme", "genextreme_gen", "gengamma", "gengamma_gen", "genhalflogistic", "genhalflogistic_gen", "genhyperbolic", "genhyperbolic_gen", "geninvgauss", "geninvgauss_gen", "genlogistic", "genlogistic_gen", "gennorm", "gennorm_gen", "genpareto", "genpareto_gen", "get_distribution_names", "gibrat", "gibrat_gen", "gompertz", "gompertz_gen", "gumbel_l", "gumbel_l_gen", "gumbel_r", "gumbel_r_gen", "halfcauchy", "halfcauchy_gen", "halfgennorm", "halfgennorm_gen", "halflogistic", "halflogistic_gen", "halfnorm", "halfnorm_gen", "hypsecant", "hypsecant_gen", "inherit_docstring_from", "integrate", "invgamma", "invgamma_gen", "invgauss", "invgauss_gen", "invweibull", "invweibull_gen", "irwinhall", "irwinhall_gen", "jf_skew_t", "jf_skew_t_gen", "johnsonsb", "johnsonsb_gen", "johnsonsu", "johnsonsu_gen", "kappa3", "kappa3_gen", "kappa4", "kappa4_gen", "kolmogn", "kolmogni", "kolmognp", "ksone", "ksone_gen", "kstwo", "kstwo_gen", "kstwobign", "kstwobign_gen", "landau", "landau_gen", "laplace", "laplace_asymmetric", "laplace_asymmetric_gen", "laplace_gen", "levy", "levy_gen", "levy_l", "levy_l_gen", "loggamma", "loggamma_gen", "logistic", "logistic_gen", "loglaplace", "loglaplace_gen", "lognorm", "lognorm_gen", "loguniform", "lomax", "lomax_gen", "maxwell", "maxwell_gen", "mielke", "mielke_gen", "moyal", "moyal_gen", "nakagami", "nakagami_gen", "ncf", "ncf_gen", "nct", "nct_gen", "ncx2", "ncx2_gen", "norm", "norm_gen", "norminvgauss", "norminvgauss_gen", "np", "operator", "optimize", "pairs", "pareto", "pareto_gen", "pearson3", "pearson3_gen", "powerlaw", "powerlaw_gen", "powerlognorm", "powerlognorm_gen", "powernorm", "powernorm_gen", "rayleigh", "rayleigh_gen", "rdist", "rdist_gen", "recipinvgauss", "recipinvgauss_gen", "reciprocal", "reciprocal_gen", "rel_breitwigner", "rel_breitwigner_gen", "replace_notes_in_docstring", "rice", "rice_gen", "root_scalar", "rv_continuous", "rv_histogram", "sc", "scu", "semicircular", "semicircular_gen", "skewcauchy", "skewcauchy_gen", "skewnorm", "skewnorm_gen", "stats", "studentized_range", "studentized_range_gen", "t", "t_gen", "trapezoid", "trapezoid_gen", "triang", "triang_gen", "truncexpon", "truncexpon_gen", "truncnorm", "truncnorm_gen", "truncpareto", "truncpareto_gen", "truncweibull_min", "truncweibull_min_gen", "tukeylambda", "tukeylambda_gen", "uniform", "uniform_gen", "vonmises", "vonmises_gen", "vonmises_line", "wald", "wald_gen", "warnings", "weibull_max", "weibull_max_gen", "weibull_min", "weibull_min_gen", "wrapcauchy", "wrapcauchy_gen", "wraps", "xpx" ], "title": "Distribution", "type": "string" }, "parameters": { "items": { "anyOf": [ { "type": "number" }, {} ] }, "title": "Parameters", "type": "array" } }, "required": [ "distribution", "parameters" ], "title": "ProbabilityFunction", "type": "object" } }, "additionalProperties": false, "required": [ "asset_type", "prob_function" ] }
- Config:
str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True
- Fields:
- field asset_type: AssetTypes [Required]#
- field name: str = ''#
- field prob_function: ProbabilityFunction [Required]#
- classmethod example() FragilityCurve#
Return an example instance of the model.
- Raises:
NotImplementedError – Raised if the model does not implement this method.
- pydantic model erad.models.fragility_curve.HazardFragilityCurves#
Show JSON schema
{ "title": "HazardFragilityCurves", "type": "object", "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "DEFAULT_CURVES", "title": "Name", "type": "string" }, "asset_state_param": { "enum": [ "wind_speed", "flood_velocity", "flood_depth", "fire_boundary_dist", "peak_ground_velocity", "peak_ground_acceleration" ], "title": "Asset State Param", "type": "string" }, "curves": { "items": { "$ref": "#/$defs/FragilityCurve" }, "title": "Curves", "type": "array" } }, "$defs": { "AssetTypes": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13 ], "title": "AssetTypes", "type": "integer" }, "FragilityCurve": { "additionalProperties": false, "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "asset_type": { "$ref": "#/$defs/AssetTypes" }, "prob_function": { "$ref": "#/$defs/ProbabilityFunction" } }, "required": [ "asset_type", "prob_function" ], "title": "FragilityCurve", "type": "object" }, "ProbabilityFunction": { "additionalProperties": false, "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "distribution": { "enum": [ "BSpline", "CensoredData", "FitDataError", "FitError", "FitSolverError", "FitUniformFixedScaleDataError", "Iterable", "LowLevelCallable", "Polynomial", "alpha", "alpha_gen", "anglit", "anglit_gen", "arcsine", "arcsine_gen", "argus", "argus_gen", "beta", "beta_gen", "betaprime", "betaprime_gen", "bradford", "bradford_gen", "burr", "burr12", "burr12_gen", "burr_gen", "cached_property", "cauchy", "cauchy_gen", "chi", "chi2", "chi2_gen", "chi_gen", "cosine", "cosine_gen", "crystalball", "crystalball_gen", "ctypes", "dgamma", "dgamma_gen", "dpareto_lognorm", "dpareto_lognorm_gen", "dweibull", "dweibull_gen", "erlang", "erlang_gen", "expon", "expon_gen", "exponnorm", "exponnorm_gen", "exponpow", "exponpow_gen", "exponweib", "exponweib_gen", "extend_notes_in_docstring", "f", "f_gen", "fatiguelife", "fatiguelife_gen", "fisk", "fisk_gen", "foldcauchy", "foldcauchy_gen", "foldnorm", "foldnorm_gen", "gamma", "gamma_gen", "gausshyper", "gausshyper_gen", "genexpon", "genexpon_gen", "genextreme", "genextreme_gen", "gengamma", "gengamma_gen", "genhalflogistic", "genhalflogistic_gen", "genhyperbolic", "genhyperbolic_gen", "geninvgauss", "geninvgauss_gen", "genlogistic", "genlogistic_gen", "gennorm", "gennorm_gen", "genpareto", "genpareto_gen", "get_distribution_names", "gibrat", "gibrat_gen", "gompertz", "gompertz_gen", "gumbel_l", "gumbel_l_gen", "gumbel_r", "gumbel_r_gen", "halfcauchy", "halfcauchy_gen", "halfgennorm", "halfgennorm_gen", "halflogistic", "halflogistic_gen", "halfnorm", "halfnorm_gen", "hypsecant", "hypsecant_gen", "inherit_docstring_from", "integrate", "invgamma", "invgamma_gen", "invgauss", "invgauss_gen", "invweibull", "invweibull_gen", "irwinhall", "irwinhall_gen", "jf_skew_t", "jf_skew_t_gen", "johnsonsb", "johnsonsb_gen", "johnsonsu", "johnsonsu_gen", "kappa3", "kappa3_gen", "kappa4", "kappa4_gen", "kolmogn", "kolmogni", "kolmognp", "ksone", "ksone_gen", "kstwo", "kstwo_gen", "kstwobign", "kstwobign_gen", "landau", "landau_gen", "laplace", "laplace_asymmetric", "laplace_asymmetric_gen", "laplace_gen", "levy", "levy_gen", "levy_l", "levy_l_gen", "loggamma", "loggamma_gen", "logistic", "logistic_gen", "loglaplace", "loglaplace_gen", "lognorm", "lognorm_gen", "loguniform", "lomax", "lomax_gen", "maxwell", "maxwell_gen", "mielke", "mielke_gen", "moyal", "moyal_gen", "nakagami", "nakagami_gen", "ncf", "ncf_gen", "nct", "nct_gen", "ncx2", "ncx2_gen", "norm", "norm_gen", "norminvgauss", "norminvgauss_gen", "np", "operator", "optimize", "pairs", "pareto", "pareto_gen", "pearson3", "pearson3_gen", "powerlaw", "powerlaw_gen", "powerlognorm", "powerlognorm_gen", "powernorm", "powernorm_gen", "rayleigh", "rayleigh_gen", "rdist", "rdist_gen", "recipinvgauss", "recipinvgauss_gen", "reciprocal", "reciprocal_gen", "rel_breitwigner", "rel_breitwigner_gen", "replace_notes_in_docstring", "rice", "rice_gen", "root_scalar", "rv_continuous", "rv_histogram", "sc", "scu", "semicircular", "semicircular_gen", "skewcauchy", "skewcauchy_gen", "skewnorm", "skewnorm_gen", "stats", "studentized_range", "studentized_range_gen", "t", "t_gen", "trapezoid", "trapezoid_gen", "triang", "triang_gen", "truncexpon", "truncexpon_gen", "truncnorm", "truncnorm_gen", "truncpareto", "truncpareto_gen", "truncweibull_min", "truncweibull_min_gen", "tukeylambda", "tukeylambda_gen", "uniform", "uniform_gen", "vonmises", "vonmises_gen", "vonmises_line", "wald", "wald_gen", "warnings", "weibull_max", "weibull_max_gen", "weibull_min", "weibull_min_gen", "wrapcauchy", "wrapcauchy_gen", "wraps", "xpx" ], "title": "Distribution", "type": "string" }, "parameters": { "items": { "anyOf": [ { "type": "number" }, {} ] }, "title": "Parameters", "type": "array" } }, "required": [ "distribution", "parameters" ], "title": "ProbabilityFunction", "type": "object" } }, "additionalProperties": false, "required": [ "asset_state_param", "curves" ] }
- Config:
str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True
- Fields:
- field asset_state_param: Literal['wind_speed', 'flood_velocity', 'flood_depth', 'fire_boundary_dist', 'peak_ground_velocity', 'peak_ground_acceleration'] [Required]#
- field curves: list[FragilityCurve] [Required]#
- field name: str = 'DEFAULT_CURVES'#
- classmethod example() HazardFragilityCurves#
Return an example instance of the model.
- Raises:
NotImplementedError – Raised if the model does not implement this method.
- plot(file_path: Path | None = None, x_min: float = 0, x_max: float = 4, number_of_points: int = 100)#
Plot the fragility curves.
Probabaility Model#
- pydantic model erad.models.probability.BaseProbabilityModel#
Show JSON schema
{ "title": "BaseProbabilityModel", "type": "object", "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "survival_probability": { "default": 1.0, "description": "Asset survival probability", "maximum": 1.0, "minimum": 0.0, "title": "Survival Probability", "type": "number" } }, "additionalProperties": false }
- Config:
str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True
- Fields:
- field name: str = ''#
- field survival_probability: Annotated[float, FieldInfo(annotation=NoneType, required=False, default=1.0, description='Asset survival probability', metadata=[Ge(ge=0), Le(le=1)])] = 1.0#
Asset survival probability
- Constraints:
ge = 0
le = 1
Speed Model#
- pydantic model erad.models.probability.SpeedProbability#
Show JSON schema
{ "title": "SpeedProbability", "type": "object", "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "survival_probability": { "default": 1.0, "description": "Asset survival probability", "maximum": 1.0, "minimum": 0.0, "title": "Survival Probability", "type": "number" }, "speed": { "description": "Represents the speed of a scenario parameter experienced by the asset e.g speed of wind", "title": "Speed" } }, "additionalProperties": false, "required": [ "speed" ] }
- Config:
str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True
- Fields:
- field speed: Annotated[Speed, FieldInfo(annotation=NoneType, required=True, description='Represents the speed of a scenario parameter experienced by the asset e.g speed of wind')] [Required]#
Represents the speed of a scenario parameter experienced by the asset e.g speed of wind
- classmethod example() SpeedProbability#
Return an example instance of the model.
- Raises:
NotImplementedError – Raised if the model does not implement this method.
Temperature Model#
- pydantic model erad.models.probability.TemperatureProbability#
Show JSON schema
{ "title": "TemperatureProbability", "type": "object", "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "survival_probability": { "default": 1.0, "description": "Asset survival probability", "maximum": 1.0, "minimum": 0.0, "title": "Survival Probability", "type": "number" }, "temperature": { "description": "Temperature of the asset", "title": "Temperature" } }, "additionalProperties": false, "required": [ "temperature" ] }
- Config:
str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True
- Fields:
- field temperature: Annotated[Temperature, FieldInfo(annotation=NoneType, required=True, description='Temperature of the asset')] [Required]#
Temperature of the asset
- classmethod example() TemperatureProbability#
Return an example instance of the model.
- Raises:
NotImplementedError – Raised if the model does not implement this method.
Distance Model#
- pydantic model erad.models.probability.DistanceProbability#
Show JSON schema
{ "title": "DistanceProbability", "type": "object", "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "survival_probability": { "default": 1.0, "description": "Asset survival probability", "maximum": 1.0, "minimum": 0.0, "title": "Survival Probability", "type": "number" }, "distance": { "default": "-9999 meter", "description": "Distance of asset from the source / boundary of a disaster event", "title": "Distance" } }, "additionalProperties": false }
- Config:
str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True
- Fields:
distance (Annotated[infrasys.quantities.Distance, FieldInfo(annotation=NoneType, required=False, default=
- field distance: Distance, FieldInfo(annotation=NoneType, required=False, default=<Quantity(-9999, 'meter')>, description='Distance of asset from the source / boundary of a disaster event')] = <Quantity(-9999, 'meter')>#
Distance of asset from the source / boundary of a disaster event
- classmethod example() DistanceProbability#
Return an example instance of the model.
- Raises:
NotImplementedError – Raised if the model does not implement this method.
Acceleration Model#
- pydantic model erad.models.probability.AccelerationProbability#
Show JSON schema
{ "title": "AccelerationProbability", "type": "object", "properties": { "uuid": { "format": "uuid", "title": "Uuid", "type": "string" }, "name": { "default": "", "title": "Name", "type": "string" }, "survival_probability": { "default": 1.0, "description": "Asset survival probability", "maximum": 1.0, "minimum": 0.0, "title": "Survival Probability", "type": "number" }, "acceleration": { "default": "0 meter / second ** 2", "title": "Acceleration" } }, "additionalProperties": false }
- Config:
str_strip_whitespace: bool = True
validate_assignment: bool = True
validate_default: bool = True
extra: str = forbid
use_enum_values: bool = False
arbitrary_types_allowed: bool = True
populate_by_name: bool = True
- Fields:
- field acceleration: Acceleration = <Quantity(0, 'meter / second ** 2')>#
- field name: str = ''#
- classmethod example() AccelerationProbability#
Return an example instance of the model.
- Raises:
NotImplementedError – Raised if the model does not implement this method.