openquake.hmtk.seismicity.max_magnitude package

Submodules

openquake.hmtk.seismicity.max_magnitude.base module

Module :mod:’openquake.hmtk.seismicity.max_magnitude.base’ defines and abstract base class for instrumental estimators of maximum magnitude :class: openquake.hmtk.seismicity.max_magnitude.base

class openquake.hmtk.seismicity.max_magnitude.base.BaseMaximumMagnitude

Bases: object

Abstract base class for implementation of the maximum magnitude estimation based on instrumental/historical seismicity

abstract get_mmax(catalogue, config)

Analyses the catalogue to infer the maximum magnitude from a statistical process

Parameters:

• catalogue – Earthquake catalogue as instance of the :class: ‘openquake.hmtk.seismicity.catalogue.Catalogue’

• config (dict) – Configuration parameters of the algorithm

Returns:

• Maximum magnitude (float)

• Maximum magnitude uncertainty (float)

openquake.hmtk.seismicity.max_magnitude.cumulative_moment_release module

Module :class: openquake.hmtk.seismicity.max_magnitude.cumulative_moment.CumulativeMoment implements cumulative moment estimator of maximum magnitude from instrumental seismicity

class openquake.hmtk.seismicity.max_magnitude.cumulative_moment_release.CumulativeMoment

Bases: BaseMaximumMagnitude

Class to implement the bootstrapped cumulative moment estimator of maximum magnitude. Adapted by G. Weatherill from the Cumulative Strain Energy approach originally suggested by Makropoulos & Burton (1983)

check_config(config)

Checks the configuration file for the number of bootstraps. Returns 1 if not found or invalid (i.e. < 0)

cumulative_moment(year, mag)

Calculation of Mmax using aCumulative Moment approach, adapted from the cumulative strain energy method of Makropoulos & Burton (1983)

Parameters:

• year (numpy.ndarray) – Year of Earthquake

• mag (numpy.ndarray) – Magnitude of Earthquake

• iplot (Boolean) – Include cumulative moment plot

Return mmax:

Returns Maximum Magnitude

Rtype mmax:

Float

get_mmax(catalogue, config)

Calculates Maximum magnitude and its uncertainty

Parameters:

• catalogue – Instance of openquake.hmtk.seismicity.catalogue.Catalogue class Earthquake calatalogue data as dictionary containing - * ‘year’ - Year of event * ‘magnitude’ - Magnitude of event * ‘sigmaMagnitude’ - Uncertainty on magnitude (optional)

• config (dict) – Configuration file for algorithm, containing thw following - * ‘number_bootstraps’ - Number of bootstraps for uncertainty

• seed (int) – Seed for random number generator (must be positive)

Returns:

• Maximum magnitude (float)

• Uncertainty on maximum magnituse (float)

openquake.hmtk.seismicity.max_magnitude.kijko_nonparametric_gaussian module

Module openquake.hmtk.seismicity.max_magnitude.kijko_nonparametric_gaussian implements the Non-Parametric Gaussian estimator of maximum magnitude proposed by Kijko (2004)

class openquake.hmtk.seismicity.max_magnitude.kijko_nonparametric_gaussian.KijkoNonParametricGaussian

Bases: BaseMaximumMagnitude

Class to implement non-parametric Gaussian methodology of Kijko (2004)

get_mmax(catalogue, config)

Calculates maximum magnitude

Parameters:

• catalogue – Instance of :class: openquake.hmtk.seismicity.catalogue.Catalogue

• config (dict) – Configuration parameters - including: * ‘number_earthquakes’: Number of largest magnitudes to consider * ‘number_samples’ [optional]: Number of samples for integral {default=51} * ‘maximum_iterations’ [optional]: Maximum number of iterations {default=100} * ‘tolerance’ [optional]: Magnitude difference threshold for iterstor stability {default=0.05}

Returns:

Maximum magnitude and its uncertainty

h_smooth(mag)

Function to calculate smoothing coefficient (h) for Gaussian Kernel estimation - based on Silverman (1986) formula

Parameters:

mag (numpy.ndarray) – Magnitude vector

Returns:

Smoothing coefficient (h) (float)

openquake.hmtk.seismicity.max_magnitude.kijko_nonparametric_gaussian.check_config(config)

Check config file inputs and overwrite bad values with the defaults

openquake.hmtk.seismicity.max_magnitude.kijko_sellevol_bayes module

Module openquake.hmtk.seismicity.max_magnitude.kijko_sellevol_bayes implements the Kijko & Sellevol (1989) method for estimating maximum magnitude from observed seismicity with uncertain b-value

class openquake.hmtk.seismicity.max_magnitude.kijko_sellevol_bayes.KijkoSellevolBayes

Bases: BaseMaximumMagnitude

Class to implement Kijko & Sellevol Bayesian estimator of Mmax, with uncertain b-value

get_mmax(catalogue, config)

Calculate maximum magnitude

Returns:

mmax Maximum magnitude and mmax_sig corresponding uncertainty

Return type:

Float

openquake.hmtk.seismicity.max_magnitude.kijko_sellevol_bayes.check_config(config, data)

Check config file inputs

Parameters:

config (dict) – Configuration settings for the function

openquake.hmtk.seismicity.max_magnitude.kijko_sellevol_fixed_b module

Module openquake.hmtk.seismicity.max_magnitude.kijko_sellevol defines the Kijko & Sellevol algorithm for maximum magnitude

class openquake.hmtk.seismicity.max_magnitude.kijko_sellevol_fixed_b.KijkoSellevolFixedb

Bases: BaseMaximumMagnitude

Implements Kijko and Sellevol estimator for maximim magnitude assuming a fixed b-value. Coded from description in Kijko (2004):

Kijko, A. (2004), …, Pure & Applied Geophysics,

get_mmax(catalogue, config)

Calculates Maximum magnitude

Parameters:

• catalogue – Earthquake catalogue as instance of :class: openquake.hmtk.seismicity.catalogue.Catalogue

• config (dict) – Configuration file for algorithm, contains the attributes: * ‘b-value’: b-value (positive float) * ‘input_mmin’: Minimum magnitude for integral (if less than minimum observed magnitude, will be overwritten by minimum observed magnitude) * ‘tolerance’: Tolerance of stabilising of iterator * ‘maximum_interations’: Maximum number of iterations

Returns:

mmax Maximum magnitude and mmax_sig corresponding uncertainty

openquake.hmtk.seismicity.max_magnitude.kijko_sellevol_fixed_b.check_config(config, data)

Checks that the config file contains all required parameters

Parameters:

config (dict) – Configuration file

Returns:

Configuration file with all correct parameters

Module contents