openquake.calculators package

Subpackages

• openquake.calculators.export package
  • Submodules
  • openquake.calculators.export.hazard module
  • openquake.calculators.export.risk module
  • Module contents

base module

exception openquake.calculators.base.AssetSiteAssociationError

Bases: Exception

Raised when there are no hazard sites close enough to any asset

class openquake.calculators.base.BaseCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: object

Abstract base class for all calculators.

Parameters:

• oqparam – OqParam object
• monitor – monitor object
• calc_id – numeric calculation ID

before_export()

Set the attributes nbytes

core_task(*args)

Core routine running on the workers.

execute()

Execution phase. Usually will run in parallel the core function and return a dictionary with the results.

export(exports=None)

Export all the outputs in the datastore in the given export formats. Individual outputs are not exported if there are multiple realizations.

from_engine = False

is_stochastic = False

monitor(operation, **kw)

Returns:a new Monitor instance

performance

post_execute(result)

Post-processing phase of the aggregated output. It must be overridden with the export code. It will return a dictionary of output files.

pre_calculator = None

pre_execute()

Initialization phase.

run(pre_execute=True, concurrent_tasks=None, close=True, **kw)

Run the calculation and return the exported outputs.

save_params(**kw)

Update the current calculation parameters and save engine_version

set_log_format()

Set the format of the root logger

sitecol

class openquake.calculators.base.HazardCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.base.BaseCalculator

Base class for hazard calculators based on source models

assoc_assets(haz_sitecol)

Associate the exposure assets to the hazard sites and redefine the .sitecol and .assetcol attributes.

assoc_assets_sites(sitecol)

Parameters:sitecol – a sequence of sites Returns:a pair (filtered sites, asset collection)

The new site collection is different from the original one if some assets were discarded or if there were missing assets for some sites.

can_read_parent()

Returns:the parent datastore if it is present and can be read from the workers, None otherwise

compute_previous()

count_assets()

Count how many assets are taken into consideration by the calculator

count_eff_ruptures(result_dict, src_group_id)

Returns the number of ruptures in the src_group (after filtering) or 0 if the src_group has been filtered away.

Parameters:

• result_dict – a dictionary with keys (grp_id, gsim)
• src_group_id – the source group ID

get_min_iml(oq)

grp_by_src = False

init()

To be overridden to initialize the datasets needed by the calculation

load_riskmodel()

Read the risk model and set the attribute .riskmodel. The riskmodel can be empty for hazard calculations. Save the loss ratios (if any) in the datastore.

post_process()

For compatibility with the engine

pre_execute()

Check if there is a pre_calculator or a previous calculation ID. If yes, read the inputs by invoking the precalculator or by retrieving the previous calculation; if not, read the inputs directly.

precalc = None

read_exposure()

Read the exposure, the riskmodel and update the attributes .exposure, .sitecol, .assets_by_site

read_inputs()

Read risk data and sources if any

read_previous(precalc_id)

Read the previous calculation datastore by checking the consistency of the calculation_mode, then read the risk data.

read_risk_data()

Read the exposure (if any), the risk model (if any) and then the site collection, possibly extracted from the exposure.

store_source_info(infos, acc)

exception openquake.calculators.base.InvalidCalculationID

Bases: Exception

Raised when running a post-calculation on top of an incompatible pre-calculation

class openquake.calculators.base.RiskCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.base.HazardCalculator

Base class for all risk calculators. A risk calculator must set the attributes .riskmodel, .sitecol, .assets_by_site, .exposure .riskinputs in the pre_execute phase.

build_riskinputs(kind, eps=None, num_events=0)

Parameters:

• kind – kind of hazard getter, can be ‘poe’ or ‘gmf’
• eps – a matrix of epsilons (or None)
• num_events – how many events there are

Returns:

a list of RiskInputs objects, sorted by IMT.

combine(acc, res)

execute()

Parallelize on the riskinputs and returns a dictionary of results. Require a .core_task to be defined with signature (riskinputs, riskmodel, rlzs_assoc, monitor).

make_eps(num_ruptures)

Parameters:num_ruptures – the size of the epsilon array for each asset

class openquake.calculators.base.Site(sid, lon, lat)

Bases: tuple

lat

Alias for field number 2

lon

Alias for field number 1

sid

Alias for field number 0

openquake.calculators.base.check_precalc_consistency(calc_mode, precalc_mode)

Defensive programming against users providing an incorrect pre-calculation ID (with --hazard-calculation-id)

Parameters:

• calc_mode – calculation_mode of the current calculation
• precalc_mode – calculation_mode of the previous calculation

openquake.calculators.base.check_time_event(oqparam, occupancy_periods)

Check the time_event parameter in the datastore, by comparing with the periods found in the exposure.

openquake.calculators.base.get_gmfs(calculator)

Parameters:calculator – a scenario_risk/damage or event_based_risk calculator Returns:a pair (eids, R) where R is the number of realizations

openquake.calculators.base.get_gmv_data(sids, gmfs)

Convert an array of shape (R, N, E, I) into an array of type gmv_data_dt

openquake.calculators.base.import_gmfs(dstore, fname, sids)

Import in the datastore a ground motion field CSV file.

Parameters:

• dstore – the datastore
• fname – the CSV file
• sids – the site IDs (complete)

Returns:

event_ids, num_rlzs

openquake.calculators.base.save_gmf_data(dstore, sitecol, gmfs)

Parameters:

• dstore – a openquake.baselib.datastore.DataStore instance
• sitecol – a openquake.hazardlib.site.SiteCollection instance
• gmfs – an array of shape (R, N, E, I)

openquake.calculators.base.set_array(longarray, shortarray)

Parameters:

• longarray – a numpy array of floats of length L >= l
• shortarray – a numpy array of floats of length l

Fill longarray with the values of shortarray, starting from the left. If shortarry is shorter than longarray, then the remaining elements on the right are filled with numpy.nan values.

classical module

class openquake.calculators.classical.ClassicalCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.classical.PSHACalculator

Classical PSHA calculator

core_task(pgetter, hstats, monitor)

Parameters:

• pgetter – an openquake.commonlib.getters.PmapGetter
• hstats – a list of pairs (statname, statfunc)
• monitor – instance of Monitor

Returns:

a dictionary kind -> ProbabilityMap

The “kind” is a string of the form ‘rlz-XXX’ or ‘mean’ of ‘quantile-XXX’ used to specify the kind of output.

execute()

Build statistical hazard curves from the stored PoEs

gen_args()

Yields:pgetter, hstats, monitor

post_execute(acc)

Save the number of bytes per each dataset

pre_calculator = 'psha'

save_hcurves(acc, pmap_by_kind)

Works by side effect by saving hcurves and statistics on the datastore; the accumulator stores the number of bytes saved.

Parameters:

• acc – dictionary kind -> nbytes
• pmap_by_kind – a dictionary of ProbabilityMaps

class openquake.calculators.classical.PSHACalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.base.HazardCalculator

Classical PSHA calculator

agg_dicts(acc, pmap_by_grp)

Aggregate dictionaries of hazard curves by updating the accumulator.

Parameters:

• acc – accumulator dictionary
• pmap_by_grp – dictionary grp_id -> ProbabilityMap

core_task(group, src_filter, gsims, param, monitor=<Monitor dummy>)

Compute the hazard curves for a set of sources belonging to the same tectonic region type for all the GSIMs associated to that TRT. The arguments are the same as in calc_hazard_curves(), except for gsims, which is a list of GSIM instances.

Returns:a dictionary {grp_id: pmap} with attributes .grp_ids, .calc_times, .eff_ruptures

execute()

Run in parallel core_task(sources, sitecol, monitor), by parallelizing on the sources according to their weight and tectonic region type.

gen_args(monitor)

Used in the case of large source model logic trees.

Parameters:monitor – a openquake.baselib.performance.Monitor Yields:(sources, sites, gsims, monitor) tuples

post_execute(pmap_by_grp_id)

Collect the hazard curves by realization and export them.

Parameters:pmap_by_grp_id – a dictionary grp_id -> hazard curves

zerodict()

Initial accumulator, a dict grp_id -> ProbabilityMap(L, G)

openquake.calculators.classical.build_hcurves_and_stats(pgetter, hstats, monitor)

Parameters:

• pgetter – an openquake.commonlib.getters.PmapGetter
• hstats – a list of pairs (statname, statfunc)
• monitor – instance of Monitor

Returns:

a dictionary kind -> ProbabilityMap

The “kind” is a string of the form ‘rlz-XXX’ or ‘mean’ of ‘quantile-XXX’ used to specify the kind of output.

openquake.calculators.classical.fix_ones(pmap)

Physically, an extremely small intensity measure level can have an extremely large probability of exceedence, however that probability cannot be exactly 1 unless the level is exactly 0. Numerically, the PoE can be 1 and this give issues when calculating the damage (there is a log(0) in openquake.risklib.scientific.annual_frequency_of_exceedence). Here we solve the issue by replacing the unphysical probabilities 1 with .9999999999999999 (the float64 closest to 1).

openquake.calculators.classical.get_src_ids(sources)

Returns:a string with the source IDs of the given sources, stripping the extension after the colon, if any

openquake.calculators.classical.saving_sources_by_task(iterargs, dstore)

Yield the iterargs again by populating ‘task_info/source_data’

classical_bcr module

class openquake.calculators.classical_bcr.ClassicalBCRCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.classical_risk.ClassicalRiskCalculator

Classical BCR Risk calculator

core_task(riskinput, riskmodel, param, monitor)

Compute and return the average losses for each asset.

Parameters:

• riskinput – a openquake.risklib.riskinput.RiskInput object
• riskmodel – a openquake.risklib.riskinput.CompositeRiskModel instance
• param – dictionary of extra parameters
• monitor – openquake.baselib.performance.Monitor instance

post_execute(result)

openquake.calculators.classical_bcr.classical_bcr(riskinput, riskmodel, param, monitor)

Compute and return the average losses for each asset.

Parameters:

• riskinput – a openquake.risklib.riskinput.RiskInput object
• riskmodel – a openquake.risklib.riskinput.CompositeRiskModel instance
• param – dictionary of extra parameters
• monitor – openquake.baselib.performance.Monitor instance

classical_damage module

class openquake.calculators.classical_damage.ClassicalDamageCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.classical_risk.ClassicalRiskCalculator

Scenario damage calculator

core_task(riskinput, riskmodel, param, monitor)

Core function for a classical damage computation.

Parameters:

• riskinput – a openquake.risklib.riskinput.RiskInput object
• riskmodel – a openquake.risklib.riskinput.CompositeRiskModel instance
• param – dictionary of extra parameters
• monitor – openquake.baselib.performance.Monitor instance

Returns:

a nested dictionary rlz_idx -> asset -> <damage array>

post_execute(result)

Export the result in CSV format.

Parameters:result – a dictionary asset -> fractions per damage state

openquake.calculators.classical_damage.classical_damage(riskinput, riskmodel, param, monitor)

Core function for a classical damage computation.

Parameters:

• riskinput – a openquake.risklib.riskinput.RiskInput object
• riskmodel – a openquake.risklib.riskinput.CompositeRiskModel instance
• param – dictionary of extra parameters
• monitor – openquake.baselib.performance.Monitor instance

Returns:

a nested dictionary rlz_idx -> asset -> <damage array>

classical_risk module

class openquake.calculators.classical_risk.ClassicalRiskCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.base.RiskCalculator

Classical Risk calculator

core_task(riskinput, riskmodel, param, monitor)

Compute and return the average losses for each asset.

Parameters:

• riskinput – a openquake.risklib.riskinput.RiskInput object
• riskmodel – a openquake.risklib.riskinput.CompositeRiskModel instance
• param – dictionary of extra parameters
• monitor – openquake.baselib.performance.Monitor instance

post_execute(result)

Saving loss curves in the datastore.

Parameters:result – aggregated result of the task classical_risk

pre_calculator = 'classical'

pre_execute()

Associate the assets to the sites and build the riskinputs.

openquake.calculators.classical_risk.classical_risk(riskinput, riskmodel, param, monitor)

Compute and return the average losses for each asset.

Parameters:

• riskinput – a openquake.risklib.riskinput.RiskInput object
• riskmodel – a openquake.risklib.riskinput.CompositeRiskModel instance
• param – dictionary of extra parameters
• monitor – openquake.baselib.performance.Monitor instance

disaggregation module

Disaggregation calculator core functionality

class openquake.calculators.disaggregation.DisaggregationCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.base.HazardCalculator

Classical PSHA disaggregation calculator

POE_TOO_BIG = "You are trying to disaggregate for poe=%s.\nHowever the source model #%d, '%s',\nproduces at most probabilities of %.7f for rlz=#%d, IMT=%s.\nThe disaggregation PoE is too big or your model is wrong,\nproducing too small PoEs."

agg_result(acc, result)

Collect the results coming from compute_disagg into self.results, a dictionary with key (sid, rlzi, poe, imt, trti) and values which are probability arrays.

Parameters:

• acc – dictionary k -> dic accumulating the results
• result – dictionary with the result coming from a task

check_poes_disagg(curves)

Raise an error if the given poes_disagg are too small compared to the hazard curves.

execute()

Performs the disaggregation

full_disaggregation(curves)

Run the disaggregation phase.

Parameters:curves – a list of hazard curves, one per site

The curves can be all None if iml_disagg is set in the job.ini

get_curves(sid)

Get all the relevant hazard curves for the given site ordinal. Returns a dictionary rlz_id -> curve_by_imt.

post_execute(results)

Save all the results of the disaggregation. NB: the number of results to save is #sites * #rlzs * #disagg_poes * #IMTs.

Parameters:results – a dictionary of probability arrays

save_bin_edges()

Save disagg-bins

save_disagg_result(site_id, matrices, rlz_id, investigation_time, imt_str, poe)

Save a computed disaggregation matrix to hzrdr.disagg_result (see DisaggResult).

Parameters:

• site_id – id of the current site
• bin_edges – The 5-uple mag, dist, lon, lat, eps
• matrices – A dictionary (sid, rlz_id, poe, imt, iml) -> trti -> matrix
• rlz_id – ordinal of the realization to which the results belong.
• investigation_time (float) – Investigation time (years) for the calculation.
• imt_str – Intensity measure type string (PGA, SA, etc.)
• poe (float) – Disaggregation probability of exceedance value for this result.

openquake.calculators.disaggregation.agg_probs(*probs)

Aggregate probabilities withe the usual formula 1 - (1 - P1) … (1 - Pn)

openquake.calculators.disaggregation.compute_disagg(src_filter, sources, cmaker, iml4, trti, bin_edges, oqparam, monitor)

Parameters:

• src_filter – a openquake.hazardlib.calc.filter.SourceFilter instance
• sources – list of hazardlib source objects
• cmaker – a openquake.hazardlib.gsim.base.ContextMaker instance
• iml4 – an array of intensities of shape (N, R, M, P)
• trti (dict) – tectonic region type index
• bin_egdes – a dictionary site_id -> edges
• oqparam – the parameters in the job.ini file
• monitor – monitor of the currently running job

Returns:

a dictionary of probability arrays, with composite key (sid, rlzi, poe, imt, iml, trti).

event_based module

class openquake.calculators.event_based.EventBasedCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.base.HazardCalculator

Event based PSHA calculator generating the ground motion fields and the hazard curves from the ruptures, depending on the configuration parameters.

combine_pmaps_and_save_gmfs(acc, results)

Combine the hazard curves (if any) and save the gmfs (if any) sequentially; notice that the gmfs may come from different tasks in any order.

Parameters:

• acc – an accumulator for the hazard curves
• results – dictionaries rlzi, imt -> [gmf_array, curves_by_imt]

Returns:

a new accumulator

core_task(getters, oq, monitor)

Parameters:

• getters – a list of GmfGetter instances
• oq – an OqParam instance
• monitor – a Monitor instance

Returns:

a list of dictionaries with keys gmfcoll and hcurves

execute()

Run in parallel core_task(sources, sitecol, monitor), by parallelizing on the ruptures according to their weight and tectonic region type.

gen_args()

Yields:the arguments for compute_gmfs_and_curves

is_stochastic = True

post_execute(result)

Parameters:result – a dictionary (src_group_id, gsim) -> haz_curves or an empty dictionary if hazard_curves_from_gmfs is false

pre_calculator = 'event_based_rupture'

save_gmf_bytes()

Save the attribute nbytes in the gmf_data datasets

class openquake.calculators.event_based.EventBasedRuptureCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.base.HazardCalculator

Event based PSHA calculator generating the ruptures only

agg_dicts(acc, ruptures_by_grp_id)

Accumulate dictionaries of ruptures and populate the events dataset in the datastore.

Parameters:

• acc – accumulator dictionary
• ruptures_by_grp_id – a nested dictionary grp_id -> ruptures

core_task(sources, src_filter, gsims, param, monitor)

Parameters:

• sources – List of commonlib.source.Source tuples
• src_filter – a source site filter
• gsims – a list of GSIMs for the current tectonic region model
• param – a dictionary of additional parameters
• monitor – monitor instance

Returns:

a dictionary src_group_id -> [Rupture instances]

execute()

gen_args(csm, monitor)

Used in the case of large source model logic trees.

Parameters:

• monitor – a openquake.baselib.performance.Monitor
• csm – a reduced CompositeSourceModel

Yields:

(sources, sites, gsims, monitor) tuples

init()

Set the random seed passed to the SourceManager and the minimum_intensity dictionary.

is_stochastic = True

post_execute(result)

Save the SES collection

save_ruptures(ruptures_by_grp_id)

Extend the ‘events’ dataset with the events from the given ruptures; also, save the ruptures if the flag save_ruptures is on.

Parameters:ruptures_by_grp_id – a dictionary grp_id -> list of EBRuptures

zerodict()

Initial accumulator, a dictionary (grp_id, gsim) -> curves

openquake.calculators.event_based.compute_gmfs_and_curves(getters, oq, monitor)

Parameters:

• getters – a list of GmfGetter instances
• oq – an OqParam instance
• monitor – a Monitor instance

Returns:

a list of dictionaries with keys gmfcoll and hcurves

openquake.calculators.event_based.compute_ruptures(sources, src_filter, gsims, param, monitor)

Parameters:

• sources – List of commonlib.source.Source tuples
• src_filter – a source site filter
• gsims – a list of GSIMs for the current tectonic region model
• param – a dictionary of additional parameters
• monitor – monitor instance

Returns:

a dictionary src_group_id -> [Rupture instances]

openquake.calculators.event_based.get_events(ebruptures)

Extract an array of dtype stored_event_dt from a list of EBRuptures

openquake.calculators.event_based.get_mean_curves(dstore)

Extract the mean hazard curves from the datastore, as a composite array of length nsites.

openquake.calculators.event_based.sample_ruptures(src, num_ses, num_samples, seed)

Sample the ruptures contained in the given source.

Parameters:

• src – a hazardlib source object
• num_ses – the number of Stochastic Event Sets to generate
• num_samples – how many samples for the given source
• seed – master seed from the job.ini file

Returns:

a dictionary of dictionaries rupture -> {ses_id: num_occurrences}

openquake.calculators.event_based.save_gmdata(calc, n_rlzs)

Save a composite array gmdata in the datastore.

Parameters:

• calc – a calculator with a dictionary .gmdata {rlz: data}
• n_rlzs – the total number of realizations

openquake.calculators.event_based.set_counts(dstore, dsetname)

Parameters:dstore – a DataStore instance Dsetname:name of dataset with a field grp_id Returns:a dictionary grp_id > counts

openquake.calculators.event_based.set_eids(ebruptures)

Set event IDs on the given list of ebruptures.

Parameters:ebruptures – a non-empty list of ruptures with the same grp_id Returns:the total number of events set

openquake.calculators.event_based.set_random_years(dstore, name, investigation_time)

Set on the events dataset year labels sensitive to the SES ordinal and the investigation time.

openquake.calculators.event_based.update_nbytes(dstore, key, array)

event_based_risk module

class openquake.calculators.event_based_risk.EbrPostCalculator(calc)

Bases: openquake.calculators.base.RiskCalculator

execute()

post_execute()

pre_execute()

save_curves_maps(acc, res)

Save the loss curves and maps (if any).

Returns:the total number of stored bytes.

class openquake.calculators.event_based_risk.EbriskCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.base.RiskCalculator

Event based PSHA calculator generating the total losses by taxonomy

combine(dummy, res)

Parameters:

• dummy – unused parameter
• res – a result dictionary

core_task(riskinput, riskmodel, param, monitor)

Parameters:

• riskinput – a openquake.risklib.riskinput.RiskInput object
• riskmodel – a openquake.risklib.riskinput.CompositeRiskModel instance
• param – a dictionary of parameters
• monitor – openquake.baselib.performance.Monitor instance

Returns:

a dictionary of numpy arrays of shape (L, R)

epsilon_getter()

Returns:a callable (start, stop) producing a slice of epsilons

execute()

Run the calculator and aggregate the results

gen_args()

Yield the arguments required by build_ruptures, i.e. the source models, the asset collection, the riskmodel and others.

is_stochastic = True

post_execute(result)

Save risk data and possibly execute the EbrPostCalculator

postproc()

Build aggregate loss curves and run EbrPostCalculator

pre_calculator = 'event_based_rupture'

pre_execute()

save_losses(dic, offset=0)

Save the event loss tables incrementally.

Parameters:

• dic – dictionary with agglosses, assratios, avglosses, lrs_idx
• offset – realization offset

save_results(allres, num_rlzs)

Parameters:

• allres – an iterable of result iterators
• num_rlzs – the total number of realizations

Returns:

the total number of events

start_tasks(sm_id, sitecol, assetcol, riskmodel, imtls, trunc_level, correl_model, min_iml, monitor)

Parameters:

• sm_id – source model ordinal
• sitecol – a SiteCollection instance
• assetcol – an AssetCollection instance
• riskmodel – a RiskModel instance
• imtls – Intensity Measure Types and Levels
• trunc_level – truncation level
• correl_model – correlation model
• min_iml – vector of minimum intensities, one per IMT
• monitor – a Monitor instance

Returns:

an IterResult instance

openquake.calculators.event_based_risk.build_curves_maps(avalues, builder, lrgetter, stats, clp, monitor)

Build loss curves and optionally maps if conditional_loss_poes are set.

openquake.calculators.event_based_risk.build_rup_loss_table(dstore)

Save the total losses by rupture.

openquake.calculators.event_based_risk.event_based_risk(riskinput, riskmodel, param, monitor)

Parameters:

• riskinput – a openquake.risklib.riskinput.RiskInput object
• riskmodel – a openquake.risklib.riskinput.CompositeRiskModel instance
• param – a dictionary of parameters
• monitor – openquake.baselib.performance.Monitor instance

Returns:

a dictionary of numpy arrays of shape (L, R)

reportwriter module

Utilities to build a report writer generating a .rst report for a calculation

class openquake.calculators.reportwriter.ReportWriter(dstore)

Bases: object

A particularly smart view over the datastore

add(name, obj=None)

Add the view named name to the report text

make_report()

Build the report and return a restructed text string

save(fname)

Save the report

title = {'params': 'Parameters', 'short_source_info': 'Slowest sources', 'job_info': 'Informational data', 'inputs': 'Input files', 'ruptures_per_trt': 'Number of ruptures per tectonic region type', 'exposure_info': 'Exposure model', 'task:0': 'Fastest task', 'performance': 'Slowest operations', 'times_by_source_class': 'Computation times by source typology', 'avglosses_data_transfer': 'Estimated data transfer for the avglosses', 'biggest_ebr_gmf': 'Maximum memory allocated for the GMFs', 'dupl_sources': 'Duplicated sources', 'ruptures_events': 'Specific information for event based', 'task_info': 'Information about the tasks', 'csm_info': 'Composite source model', 'task:-1': 'Slowest task', 'rlzs_assoc': 'Realizations per (TRT, GSIM)', 'required_params_per_trt': 'Required parameters per tectonic region type'}

openquake.calculators.reportwriter.build_report(job_ini, output_dir=None)

Write a report.csv file with information about the calculation without running it

Parameters:

• job_ini – full pathname of the job.ini file
• output_dir – the directory where the report is written (default the input directory)

openquake.calculators.reportwriter.count_ruptures(sources, srcfilter, gsims, param, monitor)

Count the number of ruptures contained in the given sources by applying a raw source filtering on the integration distance. Return a dictionary src_group_id -> {}. All sources must belong to the same tectonic region type.

openquake.calculators.reportwriter.indent(text)

scenario module

class openquake.calculators.scenario.ScenarioCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.base.HazardCalculator

Scenario hazard calculator

execute()

Compute the GMFs and return a dictionary gsim -> array(N, E, I)

init()

is_stochastic = True

post_execute(dummy)

pre_execute()

Read the site collection and initialize GmfComputer and seeds

scenario_damage module

class openquake.calculators.scenario_damage.ScenarioDamageCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.base.RiskCalculator

Scenario damage calculator

core_task(riskinput, riskmodel, param, monitor)

Core function for a damage computation.

Parameters:

• riskinput – a openquake.risklib.riskinput.RiskInput object
• riskmodel – a openquake.risklib.riskinput.CompositeRiskModel instance
• monitor – openquake.baselib.performance.Monitor instance
• param – dictionary of extra parameters

Returns:

a dictionary {‘d_asset’: [(l, r, a, mean-stddev), …],

’d_tag’: damage array of shape T, R, L, E, D, ‘c_asset’: [(l, r, a, mean-stddev), …], ‘c_tag’: damage array of shape T, R, L, E}

d_asset and d_tag are related to the damage distributions whereas c_asset and c_tag are the consequence distributions. If there is no consequence model c_asset is an empty list and c_tag is a zero-valued array.

is_stochastic = True

post_execute(result)

Compute stats for the aggregated distributions and save the results on the datastore.

pre_calculator = 'scenario'

pre_execute()

openquake.calculators.scenario_damage.dist_by_asset(data, multi_stat_dt)

Parameters:

• data – array of shape (N, R, L, 2, …)
• multi_stat_dt – numpy dtype for statistical outputs

Returns:

array of shape (N, R) with records of type multi_stat_dt

openquake.calculators.scenario_damage.scenario_damage(riskinput, riskmodel, param, monitor)

Core function for a damage computation.

Parameters:

• riskinput – a openquake.risklib.riskinput.RiskInput object
• riskmodel – a openquake.risklib.riskinput.CompositeRiskModel instance
• monitor – openquake.baselib.performance.Monitor instance
• param – dictionary of extra parameters

Returns:

a dictionary {‘d_asset’: [(l, r, a, mean-stddev), …],

’d_tag’: damage array of shape T, R, L, E, D, ‘c_asset’: [(l, r, a, mean-stddev), …], ‘c_tag’: damage array of shape T, R, L, E}

d_asset and d_tag are related to the damage distributions whereas c_asset and c_tag are the consequence distributions. If there is no consequence model c_asset is an empty list and c_tag is a zero-valued array.

scenario_risk module

class openquake.calculators.scenario_risk.ScenarioRiskCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.base.RiskCalculator

Run a scenario risk calculation

core_task(riskinput, riskmodel, param, monitor)

Core function for a scenario computation.

Parameters:

• riskinput – a of openquake.risklib.riskinput.RiskInput object
• riskmodel – a openquake.risklib.riskinput.CompositeRiskModel instance
• param – dictionary of extra parameters
• monitor – openquake.baselib.performance.Monitor instance

Returns:

a dictionary { ‘agg’: array of shape (E, L, R, 2), ‘avg’: list of tuples (lt_idx, rlz_idx, asset_idx, statistics) } where E is the number of simulated events, L the number of loss types, R the number of realizations and statistics is an array of shape (n, R, 4), with n the number of assets in the current riskinput object

is_stochastic = True

post_execute(result)

Compute stats for the aggregated distributions and save the results on the datastore.

pre_calculator = 'scenario'

pre_execute()

Compute the GMFs, build the epsilons, the riskinputs, and a dictionary with the unit of measure, used in the export phase.

openquake.calculators.scenario_risk.scenario_risk(riskinput, riskmodel, param, monitor)

Core function for a scenario computation.

Parameters:

• riskinput – a of openquake.risklib.riskinput.RiskInput object
• riskmodel – a openquake.risklib.riskinput.CompositeRiskModel instance
• param – dictionary of extra parameters
• monitor – openquake.baselib.performance.Monitor instance

Returns:

a dictionary { ‘agg’: array of shape (E, L, R, 2), ‘avg’: list of tuples (lt_idx, rlz_idx, asset_idx, statistics) } where E is the number of simulated events, L the number of loss types, R the number of realizations and statistics is an array of shape (n, R, 4), with n the number of assets in the current riskinput object

ucerf_event_classical module

class openquake.calculators.ucerf_classical.UCERFClassicalCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.classical.ClassicalCalculator

pre_calculator = 'ucerf_psha'

class openquake.calculators.ucerf_classical.UcerfPSHACalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.classical.PSHACalculator

UCERF classical calculator.

core_task(rupset_idx, ucerf_source, src_filter, gsims, monitor)

Parameters:

• rupset_idx – indices of the rupture sets
• ucerf_source – an object taking the place of a source for UCERF
• src_filter – a source filter returning the sites affected by the source
• gsims – a list of GSIMs
• monitor – a monitor instance

Returns:

a ProbabilityMap

execute()

Run in parallel core_task(sources, sitecol, monitor), by parallelizing on the sources according to their weight and tectonic region type.

is_stochastic = False

pre_execute()

parse the logic tree and source model input

openquake.calculators.ucerf_classical.convert_UCERFSource(self, node)

Converts the Ucerf Source node into an SES Control object

openquake.calculators.ucerf_classical.ucerf_classical(rupset_idx, ucerf_source, src_filter, gsims, monitor)

Parameters:

• rupset_idx – indices of the rupture sets
• ucerf_source – an object taking the place of a source for UCERF
• src_filter – a source filter returning the sites affected by the source
• gsims – a list of GSIMs
• monitor – a monitor instance

Returns:

a ProbabilityMap

ucerf_event_based module

class openquake.calculators.ucerf_event_based.ImperfectPlanarSurface(mesh_spacing, strike, dip, top_left, top_right, bottom_right, bottom_left)

Bases: openquake.hazardlib.geo.surface.planar.PlanarSurface

The planar surface class sets a narrow tolerance for the rectangular plane to be distorted in cartesian space. Ruptures with aspect ratios << 1.0, and with a dip of less than 90 degrees, cannot be generated in a manner that is consistent with the definitions - and thus cannot be instantiated. This subclass modifies the original planar surface class such that the tolerance checks are over-ridden. We find that distance errors with respect to a simple fault surface with a mesh spacing of 0.001 km are only on the order of < 0.15 % for Rrup (< 2 % for Rjb, < 3.0E-5 % for Rx)

IMPERFECT_RECTANGLE_TOLERANCE = inf

class openquake.calculators.ucerf_event_based.List

Bases: list

Trivial container returned by compute_losses

class openquake.calculators.ucerf_event_based.UCERFHazardCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.event_based.EventBasedCalculator

Runs a standard event based calculation starting from UCERF ruptures

pre_calculator = 'ucerf_rupture'

class openquake.calculators.ucerf_event_based.UCERFRiskCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.event_based_risk.EbriskCalculator

Event based risk calculator for UCERF, parallelizing on the source models

execute()

gen_args()

Yield the arguments required by build_ruptures, i.e. the source models, the asset collection, the riskmodel and others.

pre_execute()

parse the logic tree and source model input

class openquake.calculators.ucerf_event_based.UCERFRuptureCalculator(oqparam, monitor=<Monitor dummy>, calc_id=None)

Bases: openquake.calculators.event_based.EventBasedRuptureCalculator

Event based PSHA calculator generating the ruptures only

core_task(sources, src_filter, gsims, param, monitor)

Parameters:

• sources – a list with a single UCERF source
• src_filter – a SourceFilter instance
• gsims – a list of GSIMs
• param – extra parameters
• monitor – a Monitor instance

Returns:

an AccumDict grp_id -> EBRuptures

gen_args(csm, monitor)

Generate a task for each branch

pre_execute()

parse the logic tree and source model input

class openquake.calculators.ucerf_event_based.UCERFSource(source_file, id, investigation_time, start_date, min_mag, npd=<openquake.hazardlib.pmf.PMF object>, hdd=<openquake.hazardlib.pmf.PMF object>, aspect=1.5, upper_seismogenic_depth=0.0, lower_seismogenic_depth=15.0, msr=<WC1994>, mesh_spacing=1.0, trt='Active Shallow Crust', integration_distance=1000)

Bases: object

Parameters:

• source_file – Path to an existing HDF5 file containing the UCERF model
• id (str) – Valid branch of UCERF
• investigation_time (float) – Investigation time of event set (years)
• start_date – Starting date of the investigation (None for time independent)
• min_mag (float) – Minimim magnitude for consideration of background sources
• npd – Nodal plane distribution as instance of :class: openquake.hazardlib.pmf.PMF
• hdd – Hypocentral depth distribution as instance of :class: openquake.hazardlib.pmf.PMF
• aspect (float) – Aspect ratio
• upper_seismoge nic_depth (float) – Upper seismogenic depth (km)
• lower_seismogenic_depth (float) – Lower seismogenic depth (km)
• msr – Magnitude scaling relation
• mesh_spacing (float) – Spacing (km) of fault mesh
• trt (str) – Tectonic region type
• integration_distance (float) – Maximum distance from rupture to site for consideration

count_ruptures()

The length of the rupture array if the branch_id is set, else 0

filter_sites_by_distance_to_source(integration_distance, sites)

gen_trace_planes(ridx)

Yields:trace and rupture planes for the given rupture index

generate_event_set(background_sids, src_filter, seed)

Generates the event set corresponding to a particular branch

get_background_sids(src_filter)

We can apply the filtering of the background sites as a pre-processing step - this is done here rather than in the sampling of the ruptures themselves

get_background_sources(src_filter)

Turn the background model of a given branch into a set of point sources

Parameters:src_filter – SourceFilter instance

get_centroids(ridx)

Returns:array of centroids for the given rupture index

get_min_max_mag()

Called when updating the SourceGroup

get_ridx(iloc)

List of rupture indices for the given iloc

get_rupture_sites(ridx, src_filter, mag)

Determines if a rupture is likely to be inside the integration distance by considering the set of fault plane centroids and returns the affected sites if any.

Parameters:

• ridx – List of indices composing the rupture sections
• src_filter – SourceFilter instance
• mag – Magnitude of the rupture for consideration

Returns:

The sites affected by the rupture (or None)

get_ucerf_rupture(iloc, src_filter)

Parameters:

• iloc – Location of the rupture plane in the hdf5 file
• src_filter – Sites for consideration and maximum distance

iter_ruptures()

Yield ruptures for the current set of indices (.rupset_idx)

new(grp_id, branch_id)

Parameters:

• grp_id – ordinal of the source group
• branch_name – name of the UCERF branch
• branch_id – string associated to the branch

Returns:

a new UCERFSource associated to the branch_id

tectonic_region_type = 'Active Shallow Crust'

weight

Weight of the source, equal to the number of ruptures contained

openquake.calculators.ucerf_event_based.build_idx_set(branch_id, start_date)

Builds a dictionary of keys based on the branch code

openquake.calculators.ucerf_event_based.compute_losses(ssm, src_filter, param, riskmodel, imts, trunc_level, correl_model, min_iml, monitor)

Compute the losses for a single source model. Returns the ruptures as an attribute .ruptures_by_grp of the list of losses.

Parameters:

• ssm – CompositeSourceModel containing a single source model
• sitecol – a SiteCollection instance
• param – a dictionary of parameters
• riskmodel – a RiskModel instance
• imts – a list of Intensity Measure Types
• trunc_level – truncation level
• correl_model – correlation model
• min_iml – vector of minimum intensities, one per IMT
• monitor – a Monitor instance

Returns:

a List containing the losses by taxonomy and some attributes

openquake.calculators.ucerf_event_based.compute_ruptures(sources, src_filter, gsims, param, monitor)

Parameters:

• sources – a list with a single UCERF source
• src_filter – a SourceFilter instance
• gsims – a list of GSIMs
• param – extra parameters
• monitor – a Monitor instance

Returns:

an AccumDict grp_id -> EBRuptures

openquake.calculators.ucerf_event_based.generate_background_ruptures(tom, locations, occurrence, mag, npd, hdd, upper_seismogenic_depth, lower_seismogenic_depth, msr=<WC1994>, aspect=1.5, trt='Active Shallow Crust')

Parameters:

• tom – Temporal occurrence model as instance of :class: openquake.hazardlib.tom.TOM
• locations (numpy.ndarray) – Array of locations [Longitude, Latitude] of the point sources
• occurrence (numpy.ndarray) – Annual rates of occurrence
• mag (float) – Magnitude
• npd – Nodal plane distribution as instance of :class: openquake.hazardlib.pmf.PMF
• hdd – Hypocentral depth distribution as instance of :class: openquake.hazardlib.pmf.PMF
• upper_seismogenic_depth (float) – Upper seismogenic depth (km)
• lower_seismogenic_depth (float) – Lower seismogenic depth (km)
• msr – Magnitude scaling relation
• aspect (float) – Aspect ratio
• trt (str) – Tectonic region type

Returns:

List of ruptures

openquake.calculators.ucerf_event_based.get_composite_source_model(oq)

Parameters:oq – openquake.commonlib.oqvalidation.OqParam instance Returns:a class:`openquake.commonlib.source.CompositeSourceModel

openquake.calculators.ucerf_event_based.get_rupture_dimensions(mag, nodal_plane, msr, rupture_aspect_ratio, upper_seismogenic_depth, lower_seismogenic_depth)

Calculate and return the rupture length and width for given magnitude mag and nodal plane.

Parameters:nodal_plane – Instance of openquake.hazardlib.geo.nodalplane.NodalPlane. Returns:Tuple of two items: rupture length in width in km.

The rupture area is calculated using method get_median_area() of source’s magnitude-scaling relationship. In any case the returned dimensions multiplication is equal to that value. Than the area is decomposed to length and width with respect to source’s rupture aspect ratio.

If calculated rupture width being inclined by nodal plane’s dip angle would not fit in between upper and lower seismogenic depth, the rupture width is shrunken to a maximum possible and rupture length is extended to preserve the same area.

openquake.calculators.ucerf_event_based.get_rupture_surface(mag, nodal_plane, hypocenter, msr, rupture_aspect_ratio, upper_seismogenic_depth, lower_seismogenic_depth, mesh_spacing=1.0)

Create and return rupture surface object with given properties.

Parameters:

• mag – Magnitude value, used to calculate rupture dimensions, see _get_rupture_dimensions().
• nodal_plane – Instance of openquake.hazardlib.geo.nodalplane.NodalPlane describing the rupture orientation.
• hypocenter – Point representing rupture’s hypocenter.

Returns:

Instance of PlanarSurface.

openquake.calculators.ucerf_event_based.sample_background_model(hdf5, branch_key, tom, seed, filter_idx, min_mag, npd, hdd, upper_seismogenic_depth, lower_seismogenic_depth, msr=<WC1994>, aspect=1.5, trt='Active Shallow Crust')

Generates a rupture set from a sample of the background model

Parameters:

• branch_key – Key to indicate the branch for selecting the background model
• tom – Temporal occurrence model as instance of :class: openquake.hazardlib.tom.TOM
• seed – Random seed to use in the call to tom.sample_number_of_occurrences
• filter_idx – Sites for consideration (can be None!)
• min_mag (float) – Minimim magnitude for consideration of background sources
• npd – Nodal plane distribution as instance of :class: openquake.hazardlib.pmf.PMF
• hdd – Hypocentral depth distribution as instance of :class: openquake.hazardlib.pmf.PMF
• aspect (float) – Aspect ratio
• upper_seismogenic_depth (float) – Upper seismogenic depth (km)
• lower_seismogenic_depth (float) – Lower seismogenic depth (km)
• msr – Magnitude scaling relation
• integration_distance (float) – Maximum distance from rupture to site for consideration

views module

openquake.calculators.views.avglosses_data_transfer(token, dstore)

Determine the amount of average losses transferred from the workers to the controller node in a risk calculation.

openquake.calculators.views.build_links(items)

openquake.calculators.views.classify_gsim_lt(gsim_lt)

Returns:“trivial”, “simple” or “complex”

openquake.calculators.views.ebr_data_transfer(token, dstore)

Display the data transferred in an event based risk calculation

openquake.calculators.views.form(value)

Format numbers in a nice way.

>>> form(0)
'0'
>>> form(0.0)
'0.0'
>>> form(0.0001)
'1.000E-04'
>>> form(1003.4)
'1,003'
>>> form(103.4)
'103'
>>> form(9.3)
'9.300'
>>> form(-1.2)
'-1.2'

openquake.calculators.views.performance_view(dstore)

Returns the performance view as a numpy array.

openquake.calculators.views.rst_table(data, header=None, fmt=None)

Build a .rst table from a matrix.

>>> tbl = [['a', 1], ['b', 2]]
>>> print(rst_table(tbl, header=['Name', 'Value']))
==== =====
Name Value
==== =====
a    1    
b    2    
==== =====

openquake.calculators.views.stats(name, array, *extras)

Returns statistics from an array of numbers.

Parameters:name – a descriptive string Returns:(name, mean, std, min, max, len)

openquake.calculators.views.sum_table(records)

Used to compute summaries. The records are assumed to have numeric fields, except the first field which is ignored, since it typically contains a label. Here is an example:

>>> sum_table([('a', 1), ('b', 2)])
['total', 3]

openquake.calculators.views.sum_tbl(tbl, kfield, vfields)

Aggregate a composite array and compute the totals on a given key.

>>> dt = numpy.dtype([('name', (bytes, 10)), ('value', int)])
>>> tbl = numpy.array([('a', 1), ('a', 2), ('b', 3)], dt)
>>> sum_tbl(tbl, 'name', ['value'])['value']
array([3, 3])

openquake.calculators.views.view_assets_by_site(token, dstore)

Display statistical information about the distribution of the assets

openquake.calculators.views.view_contents(token, dstore)

Returns the size of the contents of the datastore and its total size

openquake.calculators.views.view_csm_info(token, dstore)

openquake.calculators.views.view_dupl_sources(token, dstore)

Display the duplicated sources from source_info

openquake.calculators.views.view_elt(token, dstore)

Display the event loss table averaged by event

openquake.calculators.views.view_exposure_info(token, dstore)

Display info about the exposure model

openquake.calculators.views.view_flat_hcurves(token, dstore)

Display the flat hazard curves for the calculation. They are used for debugging purposes when comparing the results of two calculations. They are the mean over the sites of the mean hazard curves.

openquake.calculators.views.view_flat_hmaps(token, dstore)

Display the flat hazard maps for the calculation. They are used for debugging purposes when comparing the results of two calculations. They are the mean over the sites of the mean hazard maps.

openquake.calculators.views.view_fullreport(token, dstore)

Display an .rst report about the computation

openquake.calculators.views.view_global_poes(token, dstore)

Display global probabilities averaged on all sites and all GMPEs

openquake.calculators.views.view_hmap(token, dstore)

Display the highest 20 points of the mean hazard map. Called as $ oq show hmap:0.1 # 10% PoE

openquake.calculators.views.view_inputs(token, dstore)

openquake.calculators.views.view_job_info(token, dstore)

Determine the amount of data transferred from the controller node to the workers and back in a classical calculation.

openquake.calculators.views.view_mean_avg_losses(token, dstore)

openquake.calculators.views.view_mean_disagg(token, dstore)

Display mean quantities for the disaggregation. Useful for checking differences between two calculations.

openquake.calculators.views.view_num_units(token, dstore)

Display the number of units by taxonomy

openquake.calculators.views.view_params(token, dstore)

openquake.calculators.views.view_performance(token, dstore)

Display performance information

openquake.calculators.views.view_pmap(token, dstore)

Display the mean ProbabilityMap associated to a given source group name

openquake.calculators.views.view_portfolio_loss(token, dstore)

The loss for the full portfolio, for each realization and loss type, extracted from the event loss table.

openquake.calculators.views.view_required_params_per_trt(token, dstore)

Display the parameters needed by each tectonic region type

openquake.calculators.views.view_ruptures_events(token, dstore)

openquake.calculators.views.view_ruptures_per_trt(token, dstore)

openquake.calculators.views.view_short_source_info(token, dstore, maxrows=20)

openquake.calculators.views.view_slow_sources(token, dstore, maxrows=20)

Returns the slowest sources

openquake.calculators.views.view_task(token, dstore)

Display info about a given task. Here are a few examples of usage:

$ oq show task:0  # the fastest task
$ oq show task:-1  # the slowest task

openquake.calculators.views.view_task_durations(token, dstore)

Display the raw task durations. Here is an example of usage:

$ oq show task_durations:classical

openquake.calculators.views.view_task_info(token, dstore)

Display statistical information about the tasks performance. It is possible to get full information about a specific task with a command like this one, for a classical calculation:

$ oq show task_info:classical

openquake.calculators.views.view_times_by_source_class(token, dstore)

Returns the calculation times depending on the source typology

openquake.calculators.views.view_totlosses(token, dstore)

This is a debugging view. You can use it to check that the total losses, i.e. the losses obtained by summing the average losses on all assets are indeed equal to the aggregate losses. This is a sanity check for the correctness of the implementation.