fdhpy package

fdhpy: Fault displacement models implemented in Python.

class fdhpy.ChiouEtAl2025(**kwargs)

Bases: FaultDisplacementModel

Chiou et al. (2025) fault displacement model. Applicable to sum-of-principal surface fault displacement on strike-slip faults.

Parameters:

• style (str, optional) – Style of faulting (case-insensitive). Default is “strike-slip”.

• magnitude (float) – Earthquake moment magnitude. Recommended range is (6, 8.3).

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• xl_step (float, optional) – Step size increment for slip profile calculations. Default is 0.05.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• metric (str, optional) – Definition of displacement (case-insensitive). Valid options are “sum-of-principal”. Default is “sum-of-principal”.

• version (str, optional) – Name of the model formulation (case-insensitive). Valid options are “model7”, “model8.1”, “model8.2”, or “model8.3”. Default is “model7”.

• displ_array (np.ndarray) – Displacement test value(s) in meters. Default array is provided.

Notes

See model help at the module level:

from fdhpy import ChiouEtAl2025
print(ChiouEtAl2025.__doc__)

See model help in command line:

$ fd-cea25 --help

property cdf: numpy.ndarray | None

Calculate the probability that the displacement is less than or equal to a specific value.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• displ_array (ArrayLike, optional) – Test values of displacement in meters. Default array is provided.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Cumulative probability.

Return type:

numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property displ_avg: float | None

Calculate average displacement in meters.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean. Not available in all models (i.e., not all models provide aleatory variability on the average displacement).

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property displ_max: float | None

Calculate maximum displacement in meters. Not available in all models

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean. Not available in all models (i.e., not all models provide aleatory variability on the maximum displacement).

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property displ_profile: Tuple[numpy.ndarray, numpy.ndarray] | None

Calculate the displacement profile at ‘xl_step’ increments.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• xl_step (float, optional) – Step size increment for slip profile calculations. Default is 0.05.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

A tuple containing:

• xl_arraynumpy.ndarray

  Normalized location x/L along the rupture length.

• displacementnumpy.ndarray

  Displacement in meters.

Return type:

tuple of numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property displ_site: float | numpy.ndarray | None

Calculate deterministic scenario displacement in meters.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property prob_exceed: numpy.ndarray | None

Calculate the probability that the displacement exceeds a specific value.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• displ_array (ArrayLike, optional) – Test values of displacement in meters. Default array is provided.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Exceedance probability.

Return type:

numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property stat_params_info: Dict[str, Dict[str, float] | scipy.stats._distn_infrastructure.rv_continuous]

Dictionary of statistical parameters (“params”), probability distribution (“prob_distribution”), and its arguments (“prob_distribution_kwargs”) for the instance.

class fdhpy.KuehnEtAl2024(**kwargs)

Bases: FaultDisplacementModel

Kuehn et al. (2024) fault displacement model. Applicable to aggregate surface fault displacement.

Parameters:

• style (str) – Style of faulting (case-insensitive).

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• xl_step (float, optional) – Step size increment for slip profile calculations. Default is 0.05.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• metric (str, optional) – Definition of displacement (case-insensitive). Valid options are “aggregate”. Default is “aggregate”.

• version (str, optional) – Name of the model formulation (case-insensitive). Valid options are “median_coeffs”, “mean_coeffs”, or “full_coeffs”, which refer to using point estimates of model coefficients (i.e., “median” or “mean” coefficients, which will exclude within-model epistemic uncertainty) or the “full” set (n=1000) of model coefficients, which will include within-model epistemic uncertainty. Default is “median_coeffs”.

• displ_array (np.ndarray, optional) – Displacement test value(s) in meters. Default array is provided.

• folded (bool, optional) – If True, calculate results for the folded location. If False (or –unfolded in CLI), use unfolded (i.e., asymmetric) model. Default True.

Notes

• This model predicts asymmetric displacement profiles that are right-skewed (i.e., the peak displacement is left of the midpoint). The default implementation uses the folded profile (folded=True) because the direction of skew is not known a priori.

• This model provides epistemic uncertainty on the model predictions by providing a set of 1000 correlated coefficients (per style of faulting) if version=”full_coeffs” is used. This results in 1000 “answers” for each calculation. Alternatively, version=”median_coeffs” or version=”mean_coeffs” may be used for point estimates of the coefficients to get 1 “answer” for each calculation.

• Model uncertainty is also provided with standard deviations of the predicted mean and total standard deviation (in transformed units). These are referred to as “sd_med” and “sd_sigma_T” respectively in Kuehn et al. (2024) and depend on style, magnitude, and x/L. These can be accessed in an existing instance with instance.sd_med and instance.sd_sigma_T. See Kuehn et al. (2024) for recommendations on estimating within-model epistemic uncertainty using these uncertainties.

See model help at the module level:

from fdhpy import KuehnEtAl2024
print(KuehnEtAl2024.__doc__)

See model help in command line:

$ fd-kea24 --help

property cdf: numpy.ndarray | None

Calculate the probability that the displacement is less than or equal to a specific value.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• displ_array (ArrayLike, optional) – Test values of displacement in meters. Default array is provided.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Cumulative probability.

Return type:

numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property displ_avg: float | None

Calculate average displacement in meters.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean. Not available in all models (i.e., not all models provide aleatory variability on the average displacement).

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property displ_max: float | None

Calculate maximum displacement in meters. Not available in all models

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean. Not available in all models (i.e., not all models provide aleatory variability on the maximum displacement).

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property displ_profile: Tuple[numpy.ndarray, numpy.ndarray] | None

Calculate the displacement profile at ‘xl_step’ increments.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• xl_step (float, optional) – Step size increment for slip profile calculations. Default is 0.05.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

A tuple containing:

• xl_arraynumpy.ndarray

  Normalized location x/L along the rupture length.

• displacementnumpy.ndarray

  Displacement in meters.

Return type:

tuple of numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property displ_site: float | numpy.ndarray | None

Calculate deterministic scenario displacement in meters.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property prob_exceed: numpy.ndarray | None

Calculate the probability that the displacement exceeds a specific value.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• displ_array (ArrayLike, optional) – Test values of displacement in meters. Default array is provided.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Exceedance probability.

Return type:

numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property sd_med: float | None

Standard deviation of the predicted median in transformed units.

property sd_sigma_T: float | None

Standard deviation of the predicted standard deviation in transformed units.

property stat_params_info: Dict[str, Dict[str, Dict[str, float | numpy.ndarray]] | scipy.stats._distn_infrastructure.rv_continuous]

Dictionary of statistical parameters (“params”), probability distribution (“prob_distribution”), and its arguments (“prob_distribution_kwargs”) for the instance.

Notes

• Key “lambda” is the Box-Cox transformation parameter.

• Keys “u1” and “u2” correspond to “xl” and “1-xl”, respectively.

class fdhpy.LavrentiadisAbrahamson2023(**kwargs)

Bases: FaultDisplacementModel

Lavrentiadis & Abrahamson (2023) fault displacement model. Applicable to aggregate and sum-of-principal surface fault displacement.

Parameters:

• style (str) – Style of faulting (case-insensitive).

• magnitude (float) – Earthquake moment magnitude. Recommended range is (5, 8.5).

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• xl_step (float, optional) – Step size increment for slip profile calculations. Default is 0.05.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• metric (str) – Definition of displacement (case-insensitive). Valid options are “sum-of-principal” and “aggregate”.

• version (str, optional) – Name of the model formulation (case-insensitive). Valid options are “full rupture” or “individual segment”. The “full rupture” corresponds to the “simplified FDM without segmentation” in Lavrentiadis & Abrahamson (2023). Default is “full rupture”.

• displ_array (np.ndarray, optional) – Displacement test value(s) in meters. Default array is provided.

• include_prob_zero (bool, optional) – If True (or –exclude_prob_zero in CLI), include the probability of zero displacements. Default True. Not used in calculations for average displacement or maximum displacement.

Notes

• See Lavrentiadis & Abrahamson (2023) for discussion on the probability of zero displacements, P(Gap) and P(D_P=0|no gap), which are enabled with the include_prob_zero flag.

• The probability of being in a gap without any principal or distributed ruptures, i.e. P(Gap), can be accessed in an existing instance with instance.p_gap.

• The probability of zero principal displacement given rupture has occurred at the site, i.e. P(D_P=0|no gap), can be accessed in an existing instance with instance.p_zero_slip.

• Model uncertainty is provided with the standard deviation of the predicted mean (in transformed units). This is referred to as “sigma_mu_agg” in Lavrentiadis & Abrahamson (2023) and is magnitude- and style-dependent. It can be accessed in an existing instance with instance.sigma_mu_agg. See Lavrentiadis & Abrahamson (2023) for recommendations on estimating within-model epistemic uncertainty using this uncertainty.

See model help at the module level:

from fdhpy import LavrentiadisAbrahamson2023
print(LavrentiadisAbrahamson2023.__doc__)

See model help in command line:

$ fd-la23 --help

property cdf: numpy.ndarray | None

Calculate the probability that the displacement is less than or equal to a specific value.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• displ_array (ArrayLike, optional) – Test values of displacement in meters. Default array is provided.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Cumulative probability.

Return type:

numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property displ_avg: float | None

Calculate average displacement in meters.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean. Not available in all models (i.e., not all models provide aleatory variability on the average displacement).

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property displ_max: float | None

Calculate maximum displacement in meters. Not available in all models

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean. Not available in all models (i.e., not all models provide aleatory variability on the maximum displacement).

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property displ_profile: Tuple[numpy.ndarray, numpy.ndarray] | None

Calculate the displacement profile at ‘xl_step’ increments.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• xl_step (float, optional) – Step size increment for slip profile calculations. Default is 0.05.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

A tuple containing:

• xl_arraynumpy.ndarray

  Normalized location x/L along the rupture length.

• displacementnumpy.ndarray

  Displacement in meters.

Return type:

tuple of numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property displ_site: float | numpy.ndarray | None

Calculate deterministic scenario displacement in meters.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property p_gap: float | None

Probability of being in a gap without any principal or distributed ruptures; Equation 25 in Lavrentiadis & Abrahamson (2023).

property p_zero_slip: float | None

Probability of zero principal displacement given rupture has occurred at the site; Equation 32 in Lavrentiadis & Abrahamson (2023).

property prob_exceed: numpy.ndarray | None

Calculate the probability that the displacement exceeds a specific value.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• displ_array (ArrayLike, optional) – Test values of displacement in meters. Default array is provided.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Exceedance probability.

Return type:

numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property sigma_mu_agg: float | None

Standard deviation of the predicted median aggregate displacement in transformed units.

property stat_params_info: Dict[str, Dict[str, float] | scipy.stats._distn_infrastructure.rv_continuous]

Dictionary of statistical parameters (“params”), probability distribution (“prob_distribution”), and its arguments (“prob_distribution_kwargs”) for the instance.

class fdhpy.MossEtAl2024(**kwargs)

Bases: FaultDisplacementModel

Moss et al. (2024) fault displacement model. Applicable to principal surface fault displacement on reverse faults.

This is a normalized model (i.e., uses the D/AD or D/MD form). The reference displacement models (AD or MD) from Moss et al. (2024) for the “complete” designation are used. All calculations include total aleatory variability; in other words, the statistical distributions for D/AD and AD (or D/MD and MD) are convolved.

Parameters:

• style (str, optional) – Style of faulting (case-insensitive). Default is “reverse”.

• magnitude (float) – Earthquake moment magnitude. Recommended range is (4.7, 8).

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• xl_step (float, optional) – Step size increment for slip profile calculations. Default is 0.05.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• metric (str, optional) – Definition of displacement (case-insensitive). Valid options are “principal”. Default is “principal”.

• version (str) – Name of the model formulation (case-insensitive). Valid options are “d/ad” or “d/md”.

• displ_array (np.ndarray, optional) – Displacement test value(s) in meters. Default array is provided.

• use_girs (bool, optional) – If True (or –use_girs in CLI), use statistical distribution parameters (alpha and beta) from the regression model on Figures 4.3 & 4.4 in the Moss et al. (2022) technical report at https://doi.org/10.34948/N3F595. If False, use piecewise linear interpolation to obtain statistical distribution parameters (alpha and beta) from Table 2 in the Earthquake Spectra paper at https://doi.org/10.1177/87552930241288560. Default is False.

• complete (bool, optional) – If True, use Moss et al. (2024) reference displacement models (AD or MD) with the “complete” designation. If False (or –incomplete in CLI), use Moss et al. (2024) reference displacement models with the “all” designation. Default is True.

Notes

• The statistical distribution parameters (alpha and beta) can be computed from Table 2 in the Earthquake Spectra paper (default) or from the regression model in the GIRS technical report. See use_girs parameter above for more information.

• The reference displacement (AD or MD) can be based on the Moss et al. (2024) “complete” subset or “all” data. See complete parameter above for more information.

See model help at the module level:

from fdhpy import MossEtAl2024
print(MossEtAl2024.__doc__)

See model help in command line:

$ fd-mea24 --help

property cdf: numpy.ndarray | None

Calculate the probability that the displacement is less than or equal to a specific value.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• displ_array (ArrayLike, optional) – Test values of displacement in meters. Default array is provided.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Cumulative probability.

Return type:

numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property displ_avg: float | None

Calculate average displacement in meters.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean. Not available in all models (i.e., not all models provide aleatory variability on the average displacement).

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property displ_max: float | None

Calculate maximum displacement in meters. Not available in all models

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean. Not available in all models (i.e., not all models provide aleatory variability on the maximum displacement).

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property displ_profile: Tuple[numpy.ndarray, numpy.ndarray] | None

Calculate the displacement profile at ‘xl_step’ increments.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• xl_step (float, optional) – Step size increment for slip profile calculations. Default is 0.05.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

A tuple containing:

• xl_arraynumpy.ndarray

  Normalized location x/L along the rupture length.

• displacementnumpy.ndarray

  Displacement in meters.

Return type:

tuple of numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property displ_site: float | numpy.ndarray | None

Calculate deterministic scenario displacement in meters.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property prob_exceed: numpy.ndarray | None

Calculate the probability that the displacement exceeds a specific value.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• displ_array (ArrayLike, optional) – Test values of displacement in meters. Default array is provided.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Exceedance probability.

Return type:

numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property stat_params_info: Dict[str, Dict[str, float | None] | scipy.stats._distn_infrastructure.rv_continuous | Dict[str, float]]

Dictionary of statistical parameters (“params”), probability distribution (“prob_distribution”), and its arguments (“prob_distribution_kwargs”) for the instance.

class fdhpy.MossRoss2011(**kwargs)

Bases: FaultDisplacementModel

Moss and Ross (2011) fault displacement model. Applicable to principal surface fault displacement on reverse faults.

This is a normalized model (i.e., uses the D/AD or D/MD form). The reference displacement models (AD or MD) from Moss and Ross (2011) are used. All calculations include total aleatory variability; in other words, the statistical distributions for D/AD and AD (or D/MD and MD) are convolved.

Parameters:

• style (str, optional) – Style of faulting (case-insensitive). Default is “reverse”.

• magnitude (float) – Earthquake moment magnitude. Recommended range is (5.5, 8).

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• xl_step (float, optional) – Step size increment for slip profile calculations. Default is 0.05.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• metric (str, optional) – Definition of displacement (case-insensitive). Valid options are “principal”. Default is “principal”.

• version (str) – Name of the model formulation (case-insensitive). Valid options are “d/ad” or “d/md”.

• displ_array (np.ndarray, optional) – Displacement test value(s) in meters. Default array is provided.

Notes

See model help at the module level:

from fdhpy import MossRoss2011
print(MossRoss2011.__doc__)

See model help in command line:

$ fd-mr11 --help

property cdf: numpy.ndarray | None

Calculate the probability that the displacement is less than or equal to a specific value.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• displ_array (ArrayLike, optional) – Test values of displacement in meters. Default array is provided.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Cumulative probability.

Return type:

numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property displ_avg: float | None

Calculate average displacement in meters.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean. Not available in all models (i.e., not all models provide aleatory variability on the average displacement).

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property displ_max: float | None

Calculate maximum displacement in meters. Not available in all models

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean. Not available in all models (i.e., not all models provide aleatory variability on the maximum displacement).

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property displ_profile: Tuple[numpy.ndarray, numpy.ndarray] | None

Calculate the displacement profile at ‘xl_step’ increments.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• xl_step (float, optional) – Step size increment for slip profile calculations. Default is 0.05.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

A tuple containing:

• xl_arraynumpy.ndarray

  Normalized location x/L along the rupture length.

• displacementnumpy.ndarray

  Displacement in meters.

Return type:

tuple of numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property displ_site: float | numpy.ndarray | None

Calculate deterministic scenario displacement in meters.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property prob_exceed: numpy.ndarray | None

Calculate the probability that the displacement exceeds a specific value.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• displ_array (ArrayLike, optional) – Test values of displacement in meters. Default array is provided.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Exceedance probability.

Return type:

numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property stat_params_info: Dict[str, Dict[str, float | None] | scipy.stats._distn_infrastructure.rv_continuous | Dict[str, float]]

Dictionary of statistical parameters (“params”), probability distribution (“prob_distribution”), and its arguments (“prob_distribution_kwargs”) for the instance.

class fdhpy.PetersenEtAl2011(**kwargs)

Bases: FaultDisplacementModel

Petersen et al. (2011) fault displacement model. Applicable to principal surface fault displacement on strike-slip faults.

Parameters:

• style (str, optional) – Style of faulting (case-insensitive). Default is “strike-slip”.

• magnitude (float) – Earthquake moment magnitude. Recommended range is (6, 8).

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• xl_step (float, optional) – Step size increment for slip profile calculations. Default is 0.05.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• metric (str, optional) – Definition of displacement (case-insensitive). Valid options are “principal”. Default is “principal”.

• version (str, optional) – Name of the model formulation for the given metric (case-insensitive). Valid options are “elliptical” or “quadratic”. Default is “elliptical”.

• displ_array (np.ndarray, optional) – Displacement test value(s) in meters. Default array is provided.

Notes

• Distributed displacement models are not implemented yet.

• The ln(D) versions of the principal displacement models are used; i.e., the ln(D/AD) models are not implemented.

• Only the elliptical and quadratic shapes are implemented; the bilinear shape is not implemented.

See model help at the module level:

from fdhpy import PetersenEtAl2011
print(PetersenEtAl2011.__doc__)

See model help in command line:

$ fd-pea11 --help

property cdf: numpy.ndarray | None

Calculate the probability that the displacement is less than or equal to a specific value.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• displ_array (ArrayLike, optional) – Test values of displacement in meters. Default array is provided.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Cumulative probability.

Return type:

numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property displ_avg: float | None

Calculate average displacement in meters.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean. Not available in all models (i.e., not all models provide aleatory variability on the average displacement).

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property displ_max: float | None

Calculate maximum displacement in meters. Not available in all models

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean. Not available in all models (i.e., not all models provide aleatory variability on the maximum displacement).

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property displ_profile: Tuple[numpy.ndarray, numpy.ndarray] | None

Calculate the displacement profile at ‘xl_step’ increments.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• xl_step (float, optional) – Step size increment for slip profile calculations. Default is 0.05.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

A tuple containing:

• xl_arraynumpy.ndarray

  Normalized location x/L along the rupture length.

• displacementnumpy.ndarray

  Displacement in meters.

Return type:

tuple of numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property displ_site: float | numpy.ndarray | None

Calculate deterministic scenario displacement in meters.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property prob_exceed: numpy.ndarray | None

Calculate the probability that the displacement exceeds a specific value.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• displ_array (ArrayLike, optional) – Test values of displacement in meters. Default array is provided.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Exceedance probability.

Return type:

numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property stat_params_info: Dict[str, Dict[str, float] | scipy.stats._distn_infrastructure.rv_continuous]

Dictionary of statistical parameters (“params”), probability distribution (“prob_distribution”), and its arguments (“prob_distribution_kwargs”) for the instance.

class fdhpy.YoungsEtAl2003(**kwargs)

Bases: FaultDisplacementModel

Youngs et al. (2003) fault displacement model. Applicable to principal surface fault displacement on normal faults.

This is a normalized model (i.e., uses the D/AD or D/MD form). The reference displacement models (AD or MD) from Wells and Coppersmith (1994) for “All” styles are used. All calculations include total aleatory variability; in other words, the statistical distributions for D/AD and AD (or D/MD and MD) are convolved.

Parameters:

• style (str, optional) – Style of faulting (case-insensitive). Default is “normal”.

• magnitude (float) – Earthquake moment magnitude. Recommended range is (5.5, 8).

• xl (float, optional) – Normalized location x/L along the rupture length, range [0, 1.0].

• xl_step (float, optional) – Step size increment for slip profile calculations. Default is 0.05.

• percentile (float, optional) – Aleatory quantile of interest. Use -1 for mean.

• metric (str, optional) – Definition of displacement (case-insensitive). Valid options are “principal”. Default is “principal”.

• version (str) – Name of the model formulation for the given metric (case-insensitive). Valid options are “d/ad” or “d/md”.

• displ_array (np.ndarray, optional) – Displacement test value(s) in meters. Default array is provided.

Notes

• Distributed displacement models are not implemented yet.

See model help at the module level:

from fdhpy import YoungsEtAl2003
print(YoungsEtAl2003.__doc__)

See model help in command line:

$ fd-yea03 --help

property cdf: numpy.ndarray | None

Calculate the probability that the displacement is less than or equal to a specific value.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• displ_array (ArrayLike, optional) – Test values of displacement in meters. Default array is provided.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Cumulative probability.

Return type:

numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property displ_avg: float | None

Calculate average displacement in meters.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean. Not available in all models (i.e., not all models provide aleatory variability on the average displacement).

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property displ_max: float | None

Calculate maximum displacement in meters. Not available in all models

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean. Not available in all models (i.e., not all models provide aleatory variability on the maximum displacement).

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property displ_profile: Tuple[numpy.ndarray, numpy.ndarray] | None

Calculate the displacement profile at ‘xl_step’ increments.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• xl_step (float, optional) – Step size increment for slip profile calculations. Default is 0.05.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

A tuple containing:

• xl_arraynumpy.ndarray

  Normalized location x/L along the rupture length.

• displacementnumpy.ndarray

  Displacement in meters.

Return type:

tuple of numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property displ_site: float | numpy.ndarray | None

Calculate deterministic scenario displacement in meters.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• percentile (float) – Aleatory quantile of interest. Use -1 for mean.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Displacement in meters.

Return type:

float

Notes

Parameters shown are typical; details vary with specific model.

property prob_exceed: numpy.ndarray | None

Calculate the probability that the displacement exceeds a specific value.

Parameters:

• style (str) – Style of faulting (case-insensitive). Common options are ‘strike-slip’, ‘reverse’, or ‘normal’.

• magnitude (float) – Earthquake moment magnitude.

• xl (float) – Normalized location x/L along the rupture length, range [0, 1.0].

• displ_array (ArrayLike, optional) – Test values of displacement in meters. Default array is provided.

• metric (str) – Definition of displacement (case-insensitive), e.g. ‘principal’. Varies by model. See model help for specifics.

• version (str) – Name of the model formulation for the given metric (case-insensitive), e.g. ‘D/AD’ or ‘median_coeffs’. Varies by model. See model help for specifics.

Returns:

Exceedance probability.

Return type:

numpy.ndarray

Notes

Parameters shown are typical; details vary with specific model.

property stat_params_info: Dict[str, Dict[str, float | None] | scipy.stats._distn_infrastructure.rv_continuous | Dict[str, float]]

Dictionary of statistical parameters (“params”), probability distribution (“prob_distribution”), and its arguments (“prob_distribution_kwargs”) for the instance.