openquake.calculators package

base module

class openquake.calculators.base.BaseCalculator(oqparam, calc_id=None)[source]

Bases: object

Abstract base class for all calculators.

Parameters
  • oqparam – OqParam object

  • monitor – monitor object

  • calc_id – numeric calculation ID

accept_precalc = []
before_export()[source]

Set the attributes nbytes

check_precalc(precalc_mode)[source]

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

Parameters

precalc_mode – calculation_mode of the previous calculation

core_task()[source]

Core routine running on the workers.

abstract execute()[source]

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

export(exports=None)[source]

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)[source]
Returns

a new Monitor instance

abstract post_execute(result)[source]

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

abstract pre_execute()[source]

Initialization phase.

precalc = None
run(pre_execute=True, concurrent_tasks=None, close=True, **kw)[source]

Run the calculation and return the exported outputs.

save_params(**kw)[source]

Update the current calculation parameters and save engine_version

class openquake.calculators.base.HazardCalculator(oqparam, calc_id=None)[source]

Bases: openquake.calculators.base.BaseCalculator

Base class for hazard calculators based on source models

property E
Returns

the number of stored events

property N
Returns

the total number of sites

property R
Returns

the number of realizations

block_splitter(sources, weight=operator.attrgetter('weight'), key=<function HazardCalculator.<lambda>>)[source]
Parameters
  • sources – a list of sources

  • weight – a weight function (default .weight)

  • key – None or ‘src_group_id’

Returns

an iterator over blocks of sources

check_floating_spinning()[source]
check_overflow()[source]

Overridden in event based

init()[source]

To be overridden to initialize the datasets needed by the calculation

load_crmodel()[source]

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

load_insurance_data(ins_types, ins_files)[source]

Read the insurance files and populate the policy_dict

post_process()[source]

For compatibility with the engine

pre_execute()[source]

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

read_exposure(haz_sitecol=None)[source]

Read the exposure, the risk models and update the attributes .sitecol, .assetcol

read_inputs()[source]

Read risk data and sources if any

save_cache(**kw)[source]

A shortcut method to store data in the hdf5 cache file, if any

save_crmodel()[source]

Save the risk models in the datastore

save_multi_peril()[source]

Defined in MultiRiskCalculator

property src_filter
Returns

a SourceFilter/UcerfFilter

store_rlz_info(eff_ruptures=None)[source]

Save info about the composite source model inside the csm_info dataset

store_source_info(calc_times)[source]

Save (weight, num_sites, calc_time) inside the source_info dataset

exception openquake.calculators.base.InvalidCalculationID[source]

Bases: Exception

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

class openquake.calculators.base.RiskCalculator(oqparam, calc_id=None)[source]

Bases: openquake.calculators.base.HazardCalculator

Base class for all risk calculators. A risk calculator must set the attributes .crmodel, .sitecol, .assetcol, .riskinputs in the pre_execute phase.

build_riskinputs(kind)[source]
Parameters

kind – kind of hazard getter, can be ‘poe’ or ‘gmf’

Returns

a list of RiskInputs objects, sorted by IMT.

combine(acc, res)[source]
execute()[source]

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

get_getter(kind, sid)[source]
Parameters
  • kind – ‘poe’ or ‘gmf’

  • sid – a site ID

Returns

a PmapGetter or GmfDataGetter

read_shakemap(haz_sitecol, assetcol)[source]

Enabled only if there is a shakemap_id parameter in the job.ini. Download, unzip, parse USGS shakemap files and build a corresponding set of GMFs which are then filtered with the hazard site collection and stored in the datastore.

openquake.calculators.base.build_hmaps(hcurves_by_kind, slice_, imtls, poes, monitor)[source]

Build hazard maps from a slice of hazard curves. :returns: a pair ({kind: hmaps}, slice)

openquake.calculators.base.build_weights(realizations, imt_dt)[source]
Returns

an array with the realization weights of shape R

openquake.calculators.base.check_time_event(oqparam, occupancy_periods)[source]

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

openquake.calculators.base.fix_ones(pmap)[source]

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.base.get_idxs(data, eid2idx)[source]

Convert from event IDs to event indices.

Parameters
  • data – an array with a field eid

  • eid2idx – a dictionary eid -> idx

Returns

the array of event indices

openquake.calculators.base.import_gmfs(dstore, fname, sids)[source]

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, imts, events=())[source]
Parameters
openquake.calculators.base.set_array(longarray, shortarray)[source]
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.

getters module

class openquake.calculators.getters.GmfDataGetter(dstore, sids, num_rlzs)[source]

Bases: collections.abc.Mapping

A dictionary-like object {sid: dictionary by realization index}

get_hazard(gsim=None)[source]
Parameters

gsim – ignored

Returns

an dict rlzi -> datadict

init()[source]
class openquake.calculators.getters.GmfGetter(rupgetter, srcfilter, oqparam)[source]

Bases: object

An hazard getter with methods .get_gmfdata and .get_hazard returning ground motion values.

compute_gmfs_curves(monitor)[source]
Returns

a dict with keys gmfdata, indices, hcurves

gen_gmfs()[source]

Compute the GMFs for the given realization and yields arrays of the dtype (sid, eid, imti, gmv), one for rupture

get_gmfdata()[source]
Returns

an array of the dtype (sid, eid, imti, gmv)

get_hazard_by_sid(data=None)[source]
Parameters

data – if given, an iterator of records of dtype gmf_dt

Returns

sid -> records

property imtls
property imts
init()[source]

Initialize the computers. Should be called on the workers

property sids
class openquake.calculators.getters.PmapGetter(dstore, weights, sids=None, poes=())[source]

Bases: object

Read hazard curves from the datastore for all realizations or for a specific realization.

Parameters
  • dstore – a DataStore instance or file system path to it

  • sids – the subset of sites to consider (if None, all sites)

  • rlzs_assoc – a RlzsAssoc instance (if None, infers it)

get(rlzi, grp=None)[source]
Parameters
  • rlzi – a realization index

  • grp – None (all groups) or a string of the form “grp-XX”

Returns

the hazard curves for the given realization

get_hazard(gsim=None)[source]
Parameters

gsim – ignored

Returns

R probability curves for the given site

get_mean(grp=None)[source]

Compute the mean curve as a ProbabilityMap

Parameters

grp – if not None must be a string of the form “grp-XX”; in that case returns the mean considering only the contribution for group XX

get_pcurve(s, r, g)[source]
Parameters
  • s – site ID

  • r – realization ID

  • g – group ID

Returns

a probability curves with shape L (or None, if missing)

get_pcurves(sid)[source]
Returns

a list of R probability curves with shape L

property imts
init()[source]

Read the poes and set the .data attribute with the hazard curves

items(kind='')[source]

Extract probability maps from the datastore, possibly generating on the fly the ones corresponding to the individual realizations. Yields pairs (tag, pmap).

Parameters

kind – the kind of PoEs to extract; if not given, returns the realization if there is only one or the statistics otherwise.

class openquake.calculators.getters.RuptureGetter(filename, rup_indices, grp_id, trt, samples, rlzs_by_gsim, first_event=0)[source]

Bases: object

Iterable over ruptures.

Parameters
  • filename – path to an HDF5 file with a dataset names ruptures

  • rup_indices – a list of rupture indices of the same group

E2R(array, rlzi)[source]
Parameters
  • array – an array of shape (E, …)

  • rlzi – an array of E realization indices

Returns

an aggregated array of shape (R, …)

get_eid_rlz()[source]
Returns

a composite array with the associations eid->rlz

get_rupdict()[source]
Returns

a dictionary with the parameters of the rupture

get_ruptures(srcfilter=<openquake.hazardlib.calc.filters.SourceFilter object>)[source]
Returns

a list of EBRuptures filtered by bounding box

property num_events
property num_rlzs
property num_ruptures
property rup_array
set_weights(src_filter, num_taxonomies_by_site)[source]
Returns

the weights of the ruptures in the getter

split(maxweight)[source]
Yields

RuptureGetters with weight <= maxweight

openquake.calculators.getters.gen_rupture_getters(dstore, slc=slice(None, None, None), concurrent_tasks=1, hdf5cache=None)[source]
Yields

RuptureGetters

openquake.calculators.getters.get_maxloss_rupture(dstore, loss_type)[source]
Parameters
  • dstore – a DataStore instance

  • loss_type – a loss type string

Returns

EBRupture instance corresponding to the maximum loss for the given loss type

openquake.calculators.getters.group_by_rlz(data, eid2rlz)[source]
Parameters
  • data – a composite array of D elements with a field eid

  • eid2rlz – an array of E >= D elements or a dictionary

Returns

a dictionary rlzi -> data for each realization

openquake.calculators.getters.sig_eps_dt(imts)[source]
Returns

a composite data type for the sig_eps output

classical module

class openquake.calculators.classical.ClassicalCalculator(oqparam, calc_id=None)[source]

Bases: openquake.calculators.base.HazardCalculator

Classical PSHA calculator

acc0()[source]

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

accept_precalc = ['classical']
agg_dicts(acc, dic)[source]

Aggregate dictionaries of hazard curves by updating the accumulator.

Parameters
  • acc – accumulator dictionary

  • dic – dict with keys pmap, calc_times, rup_data

calc_stats(parent)[source]
core_task(srcfilter, gsims, params, monitor)

Split the given sources, filter the subsources and the compute the PoEs. Yield back subtasks if the split sources contain more than maxweight ruptures.

execute()[source]

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

post_execute(pmap_by_grp_id)[source]

Collect the hazard curves by realization and export them.

Parameters

pmap_by_grp_id – a dictionary grp_id -> hazard curves

save_hazard(acc, pmap_by_kind)[source]

Works by side effect by saving hcurves and hmaps on the datastore

Parameters
  • acc – ignored

  • pmap_by_kind – a dictionary of ProbabilityMaps

kind can be (‘hcurves’, ‘mean’), (‘hmaps’, ‘mean’), …

submit_sources(smap)[source]

Send the sources split in tasks

class openquake.calculators.classical.PreCalculator(oqparam, calc_id=None)[source]

Bases: openquake.calculators.classical.ClassicalCalculator

Calculator to filter the sources and compute the number of effective ruptures

core_task(srcfilter, gsims, params, monitor)

Prefilter the sources

openquake.calculators.classical.build_hazard(pgetter, N, hstats, individual_curves, max_sites_disagg, monitor)[source]
Parameters
  • pgetter – an openquake.commonlib.getters.PmapGetter

  • N – the total number of sites

  • hstats – a list of pairs (statname, statfunc)

  • individual_curves – if True, also build the individual curves

  • max_sites_disagg – if there are less sites than this, store rup info

  • 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.classical_split_filter(srcs, srcfilter, gsims, params, monitor)[source]

Split the given sources, filter the subsources and the compute the PoEs. Yield back subtasks if the split sources contain more than maxweight ruptures.

openquake.calculators.classical.get_extreme_poe(array, imtls)[source]
Parameters
  • array – array of shape (L, G) with L=num_levels, G=num_gsims

  • imtls – DictArray imt -> levels

Returns

the maximum PoE corresponding to the maximum level for IMTs and GSIMs

openquake.calculators.classical.get_src_ids(sources)[source]
Returns

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

openquake.calculators.classical.preclassical(srcs, srcfilter, gsims, params, monitor)[source]

Prefilter the sources

classical_bcr module

class openquake.calculators.classical_bcr.ClassicalBCRCalculator(oqparam, calc_id=None)[source]

Bases: openquake.calculators.classical_risk.ClassicalRiskCalculator

Classical BCR Risk calculator

accept_precalc = ['classical']
core_task(crmodel, param, monitor)

Compute and return the average losses for each asset.

Parameters
post_execute(result)[source]

Saving loss curves in the datastore.

Parameters

result – aggregated result of the task classical_risk

pre_execute()[source]

Associate the assets to the sites and build the riskinputs.

openquake.calculators.classical_bcr.classical_bcr(riskinputs, crmodel, param, monitor)[source]

Compute and return the average losses for each asset.

Parameters

classical_damage module

class openquake.calculators.classical_damage.ClassicalDamageCalculator(oqparam, calc_id=None)[source]

Bases: openquake.calculators.classical_risk.ClassicalRiskCalculator

Scenario damage calculator

accept_precalc = ['classical']
core_task(crmodel, param, monitor)

Core function for a classical damage computation.

Parameters
Returns

a nested dictionary lt_idx, rlz_idx -> asset_idx -> <damage array>

post_execute(result)[source]

Export the result in CSV format.

Parameters

result – a dictionary (l, r) -> asset_ordinal -> fractions per damage state

openquake.calculators.classical_damage.classical_damage(riskinputs, crmodel, param, monitor)[source]

Core function for a classical damage computation.

Parameters
Returns

a nested dictionary lt_idx, rlz_idx -> asset_idx -> <damage array>

classical_risk module

class openquake.calculators.classical_risk.ClassicalRiskCalculator(oqparam, calc_id=None)[source]

Bases: openquake.calculators.base.RiskCalculator

Classical Risk calculator

accept_precalc = ['classical']
core_task(crmodel, param, monitor)

Compute and return the average losses for each asset.

Parameters
post_execute(result)[source]

Saving loss curves in the datastore.

Parameters

result – aggregated result of the task classical_risk

pre_execute()[source]

Associate the assets to the sites and build the riskinputs.

precalc = 'classical'
openquake.calculators.classical_risk.classical_risk(riskinputs, crmodel, param, monitor)[source]

Compute and return the average losses for each asset.

Parameters

disaggregation module

Disaggregation calculator core functionality

class openquake.calculators.disaggregation.DisaggregationCalculator(oqparam, calc_id=None)[source]

Bases: openquake.calculators.base.HazardCalculator

Classical PSHA disaggregation calculator

accept_precalc = ['classical', 'disaggregation']
agg_result(acc, result)[source]

Collect the results coming from compute_disagg into self.results.

Parameters
  • acc – dictionary sid -> trti -> 7D array

  • result – dictionary with the result coming from a task

build_disagg_by_src()[source]
Parameters
  • dstore – a datastore

  • iml2s – N arrays of IMLs with shape (M, P)

check_poes_disagg(curves, rlzs)[source]

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

execute()[source]

Performs the disaggregation

full_disaggregation()[source]

Run the disaggregation phase.

get_curve(sid, rlz_by_sid)[source]

Get the hazard curve for the given site ID.

init()[source]

To be overridden to initialize the datasets needed by the calculation

post_execute(results)[source]

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

Parameters

results – a dictionary sid -> trti -> disagg matrix

precalc = 'classical'
save_bin_edges()[source]

Save disagg-bins

save_disagg_result(results, **attrs)[source]

Save the computed PMFs in the datastore

Parameters

results – an 8D-matrix of shape (T, .., M, P)

openquake.calculators.disaggregation.agg_probs(*probs)[source]

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

openquake.calculators.disaggregation.compute_disagg(dstore, slc, cmaker, iml2s, trti, bin_edges, monitor)[source]
Parameters
  • dstore – a openquake.baselib.datastore.DataStore instance

  • slc – a slice of ruptures

  • cmaker – a openquake.hazardlib.gsim.base.ContextMaker instance

  • iml2s – a list of N arrays of shape (M, P)

  • trti (dict) – tectonic region type index

  • bin_egdes – a quintet (mag_edges, dist_edges, lon_edges, lat_edges, eps_edges)

  • monitor – monitor of the currently running job

Returns

a dictionary sid -> 7D-array

event_based module

class openquake.calculators.event_based.EventBasedCalculator(oqparam, calc_id=None)[source]

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.

acc0()[source]

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

accept_precalc = ['event_based', 'event_based_risk', 'ucerf_hazard']
agg_dicts(acc, result)[source]
Parameters
  • acc – accumulator dictionary

  • result – an AccumDict with events, ruptures, gmfs and hcurves

build_events_from_sources()[source]

Prefilter the composite source model and store the source_info

build_ruptures(srcfilter, param, monitor=<Monitor [ubuntu]>)
Parameters
  • sources – a sequence of sources of the same group

  • srcfilter – SourceFilter instance used also for bounding box post filtering

  • param – a dictionary of additional parameters including ses_per_logic_tree_path

  • monitor – monitor instance

Yields

dictionaries with keys rup_array, calc_times

check_overflow()[source]

Raise a ValueError if the number of sites is larger than 65,536 or the number of IMTs is larger than 256 or the number of ruptures is larger than 4,294,967,296. The limits are due to the numpy dtype used to store the GMFs (gmv_dt). They could be relaxed in the future.

core_task(srcfilter, param, monitor)

Compute GMFs and optionally hazard curves

property csm_info
Returns

a cached CompositionInfo object

property eid2idx
Returns

a dict eid -> index in the events table

execute()[source]

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

gen_rupture_getters()[source]
Returns

a list of RuptureGetters

init()[source]

To be overridden to initialize the datasets needed by the calculation

init_logic_tree(csm_info)[source]
is_stochastic = True
post_execute(result)[source]

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

save_events(rup_array)[source]
Parameters

rup_array – an array of ruptures with fields grp_id

Returns

a list of RuptureGetters

set_param(**kw)[source]
openquake.calculators.event_based.compute_gmfs(rupgetter, srcfilter, param, monitor)[source]

Compute GMFs and optionally hazard curves

openquake.calculators.event_based.get_mean_curves(dstore)[source]

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

openquake.calculators.event_based.update_nbytes(dstore, key, array)[source]

event_based_risk module

class openquake.calculators.event_based_risk.EbrCalculator(oqparam, calc_id=None)[source]

Bases: openquake.calculators.base.RiskCalculator

Event based PSHA calculator generating the total losses by taxonomy

accept_precalc = ['event_based', 'event_based_risk', 'ucerf_hazard', 'ebrisk']
build_datasets(builder)[source]
combine(dummy, res)[source]
Parameters
  • dummy – unused parameter

  • res – a result dictionary

core_task(crmodel, param, monitor)
Parameters
Returns

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

is_stochastic = True
post_execute(result)[source]

Save risk data and build the aggregate loss curves

postproc()[source]

Build aggregate loss curves in process

pre_execute()[source]

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

precalc = 'event_based'
save_losses(dic)[source]

Save the event loss tables incrementally.

Parameters

dic – dictionary with agglosses, avglosses

openquake.calculators.event_based_risk.build_loss_tables(dstore)[source]

Compute the total losses by rupture and losses by rlzi.

openquake.calculators.event_based_risk.event_based_risk(riskinputs, crmodel, param, monitor)[source]
Parameters
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)[source]

Bases: object

A particularly smart view over the datastore

add(name, obj=None)[source]

Add the view named name to the report text

make_report()[source]

Build the report and return a restructed text string

save(fname)[source]

Save the report

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

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.indent(text)[source]

scenario module

class openquake.calculators.scenario.ScenarioCalculator(oqparam, calc_id=None)[source]

Bases: openquake.calculators.base.HazardCalculator

Scenario hazard calculator

execute()[source]

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

init()[source]

To be overridden to initialize the datasets needed by the calculation

is_stochastic = True
post_execute(gmfa)[source]

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

pre_execute()[source]

Read the site collection and initialize GmfComputer and seeds

scenario_damage module

class openquake.calculators.scenario_damage.ScenarioDamageCalculator(oqparam, calc_id=None)[source]

Bases: openquake.calculators.base.RiskCalculator

Scenario damage calculator

accept_precalc = ['scenario']
core_task(crmodel, param, monitor)

Core function for a damage computation.

Parameters
Returns

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

’d_event’: damage array of shape R, L, E, D, ‘c_asset’: [(l, r, a, mean-stddev), …], ‘c_event’: damage array of shape 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)[source]

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

pre_execute()[source]

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

precalc = 'scenario'
openquake.calculators.scenario_damage.scenario_damage(riskinputs, crmodel, param, monitor)[source]

Core function for a damage computation.

Parameters
Returns

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

’d_event’: damage array of shape R, L, E, D, ‘c_asset’: [(l, r, a, mean-stddev), …], ‘c_event’: damage array of shape 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, calc_id=None)[source]

Bases: openquake.calculators.base.RiskCalculator

Run a scenario risk calculation

accept_precalc = ['scenario']
core_task(crmodel, param, monitor)

Core function for a scenario computation.

Parameters
Returns

a dictionary { ‘agg’: array of shape (E, L, R, 2), ‘avg’: list of tuples (lt_idx, rlz_idx, asset_ordinal, 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)[source]

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

pre_execute()[source]

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

precalc = 'scenario'
openquake.calculators.scenario_risk.scenario_risk(riskinputs, crmodel, param, monitor)[source]

Core function for a scenario computation.

Parameters
Returns

a dictionary { ‘agg’: array of shape (E, L, R, 2), ‘avg’: list of tuples (lt_idx, rlz_idx, asset_ordinal, 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, calc_id=None)[source]

Bases: openquake.calculators.classical.ClassicalCalculator

UCERF classical calculator.

accept_precalc = ['ucerf_classical']
execute()[source]

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

pre_execute()[source]

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

ucerf_event_based module

class openquake.calculators.ucerf_event_based.UCERFHazardCalculator(oqparam, calc_id=None)[source]

Bases: openquake.calculators.event_based.EventBasedCalculator

Event based PSHA calculator generating the ruptures and GMFs together

accept_precalc = ['ucerf_hazard']
build_ruptures(src_filter, param, monitor)
Parameters
  • sources – a list with a single UCERF source

  • param – extra parameters

  • monitor – a Monitor instance

Returns

an AccumDict grp_id -> EBRuptures

pre_execute()[source]

parse the logic tree and source model input

openquake.calculators.ucerf_event_based.build_ruptures(sources, src_filter, param, monitor)[source]
Parameters
  • sources – a list with a single UCERF source

  • param – extra parameters

  • monitor – a Monitor instance

Returns

an AccumDict grp_id -> EBRuptures

openquake.calculators.ucerf_event_based.generate_event_set(ucerf, background_sids, src_filter, ses_idx, seed)[source]

Generates the event set corresponding to a particular branch

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')[source]

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

class openquake.calculators.views.Source(source_id, code, num_ruptures, checksum)

Bases: tuple

property checksum

Alias for field number 3

property code

Alias for field number 1

property num_ruptures

Alias for field number 2

property source_id

Alias for field number 0

class openquake.calculators.views.String[source]

Bases: str

openquake.calculators.views.avglosses_data_transfer(token, dstore)[source]

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

openquake.calculators.views.ebr_data_transfer(token, dstore)[source]

Display the data transferred in an event based risk calculation

openquake.calculators.views.form(value)[source]

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.30000'
>>> form(-1.2)
'-1.2'
openquake.calculators.views.performance_view(dstore, add_calc_id=True)[source]

Returns the performance view as a numpy array.

openquake.calculators.views.portfolio_loss(dstore)[source]
openquake.calculators.views.rst_table(data, header=None, fmt=None)[source]

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)[source]

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)[source]

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)[source]

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_act_ruptures_by_src(token, dstore)[source]

Display the actual number of ruptures by source in event based calculations

openquake.calculators.views.view_assets_by_site(token, dstore)[source]

Display statistical information about the distribution of the assets

openquake.calculators.views.view_contents(token, dstore)[source]

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

openquake.calculators.views.view_csm_info(token, dstore)[source]
openquake.calculators.views.view_dupl_sources(token, dstore)[source]

Show the sources with the same ID and the truly duplicated sources

openquake.calculators.views.view_dupl_sources_time(token, dstore)[source]

Display the time spent computing duplicated sources

openquake.calculators.views.view_elt(token, dstore)[source]

Display the event loss table averaged by event

openquake.calculators.views.view_exposure_info(token, dstore)[source]

Display info about the exposure model

openquake.calculators.views.view_extreme_groups(token, dstore)[source]

Show the source groups contributing the most to the highest IML

openquake.calculators.views.view_fullreport(token, dstore)[source]

Display an .rst report about the computation

openquake.calculators.views.view_global_gmfs(token, dstore)[source]

Display GMFs averaged on everything for debugging purposes

openquake.calculators.views.view_global_hcurves(token, dstore)[source]

Display the global 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_global_hmaps(token, dstore)[source]

Display the global 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_global_poes(token, dstore)[source]

Display global probabilities averaged on all sites and all GMPEs

openquake.calculators.views.view_gmvs(token, dstore)[source]

Show the GMVs on a given site ID

openquake.calculators.views.view_gmvs_to_hazard(token, dstore)[source]

Show the number of GMFs over the highest IML

openquake.calculators.views.view_hmap(token, dstore)[source]

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)[source]
openquake.calculators.views.view_job_info(token, dstore)[source]

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

openquake.calculators.views.view_mean_disagg(token, dstore)[source]

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

openquake.calculators.views.view_num_units(token, dstore)[source]

Display the number of units by taxonomy

openquake.calculators.views.view_params(token, dstore)[source]
openquake.calculators.views.view_performance(token, dstore)[source]

Display performance information

openquake.calculators.views.view_pmap(token, dstore)[source]

Display the mean ProbabilityMap associated to a given source group name

openquake.calculators.views.view_portfolio_loss(token, dstore)[source]

The mean and stddev loss for the full portfolio for each loss type, extracted from the event loss table, averaged over the realizations

openquake.calculators.views.view_portfolio_losses(token, dstore)[source]

The losses 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)[source]

Display the parameters needed by each tectonic region type

openquake.calculators.views.view_ruptures_events(token, dstore)[source]
openquake.calculators.views.view_ruptures_per_trt(token, dstore)[source]
openquake.calculators.views.view_short_source_info(token, dstore, maxrows=20)[source]
openquake.calculators.views.view_slow_sources(token, dstore, maxrows=20)[source]

Returns the slowest sources

openquake.calculators.views.view_task_durations(token, dstore)[source]

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

$ oq show task_durations:classical
openquake.calculators.views.view_task_hazard(token, dstore)[source]

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

$ oq show task:classical:0  # the fastest task
$ oq show task:classical:-1  # the slowest task
openquake.calculators.views.view_task_info(token, dstore)[source]

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_task_risk(token, dstore)[source]

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

$ oq show task_risk:0  # the fastest task
$ oq show task_risk:-1  # the slowest task
openquake.calculators.views.view_times_by_source_class(token, dstore)[source]

Returns the calculation times depending on the source typology

openquake.calculators.views.view_totlosses(token, dstore)[source]

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.

extract module

class openquake.calculators.extract.Extract[source]

Bases: dict

A callable dictionary of functions with a single instance called extract. Then extract(dstore, fullkey) dispatches to the function determined by the first part of fullkey (a slash-separated string) by passing as argument the second part of fullkey.

For instance extract(dstore, ‘sitecol’).

add(key, cache=False)[source]
class openquake.calculators.extract.Extractor(calc_id)[source]

Bases: object

A class to extract data from a calculation.

Parameters

calc_id – a calculation ID

NB: instantiating the Extractor opens the datastore.

close()[source]

Close the datastore

get(what)[source]
Parameters

what – what to extract

Returns

an ArrayWrapper instance

exception openquake.calculators.extract.WebAPIError[source]

Bases: RuntimeError

Wrapper for an error on a WebAPI server

class openquake.calculators.extract.WebExtractor(calc_id, server=None, username=None, password=None)[source]

Bases: openquake.calculators.extract.Extractor

A class to extract data from the WebAPI.

Parameters
  • calc_id – a calculation ID

  • server – hostname of the webapi server (can be ‘’)

  • username – login username (can be ‘’)

  • password – login password (can be ‘’)

NB: instantiating the WebExtractor opens a session.

close()[source]

Close the session

dump(fname)[source]

Dump the remote datastore on a local path.

get(what)[source]
Parameters

what – what to extract

Returns

an ArrayWrapper instance

openquake.calculators.extract.barray(iterlines)[source]

Array of bytes

openquake.calculators.extract.build_damage_array(data, damage_dt)[source]
Parameters
  • data – an array of shape (A, L, 1, D) or (A, L, 2, D)

  • damage_dt – a damage composite data type loss_type -> states

Returns

a composite array of length N and dtype damage_dt

openquake.calculators.extract.build_damage_dt(dstore, mean_std=True)[source]
Parameters
  • dstore – a datastore instance

  • mean_std – a flag (default True)

Returns

a composite dtype loss_type -> (mean_ds1, stdv_ds1, …) or loss_type -> (ds1, ds2, …) depending on the flag mean_std

openquake.calculators.extract.cast(loss_array, loss_dt)[source]
openquake.calculators.extract.crm_attrs(dstore, what)[source]
Returns

the attributes of the risk model, i.e. limit_states, loss_types, min_iml and covs, needed by the risk exporters.

openquake.calculators.extract.disagg_key(imt, sid, poe_id)[source]
openquake.calculators.extract.extract_(dstore, dspath)[source]

Extracts an HDF5 path object from the datastore, for instance extract(dstore, ‘sitecol’).

openquake.calculators.extract.extract_agg_damages(dstore, what)[source]

Aggregate damages of the given loss type and tags. Use it as /extract/agg_damages/structural?taxonomy=RC&zipcode=20126

Returns

array of shape (R, D), being R the number of realizations and D the number of damage states, or an array of length 0 if there is no data for the given tags

openquake.calculators.extract.extract_agg_losses(dstore, what)[source]

Aggregate losses of the given loss type and tags. Use it as /extract/agg_losses/structural?taxonomy=RC&zipcode=20126 /extract/agg_losses/structural?taxonomy=RC&zipcode=*

Returns

an array of shape (T, R) if one of the tag names has a * value an array of shape (R,), being R the number of realizations an array of length 0 if there is no data for the given tags

openquake.calculators.extract.extract_aggregate(dstore, what)[source]

/extract/aggregate/avg_losses? kind=mean&loss_type=structural&tag=taxonomy&tag=occupancy

openquake.calculators.extract.extract_asset_risk(dstore, what)[source]

Extract an array of assets + risk fields, optionally filtered by tag. Use it as /extract/asset_risk?taxonomy=RC&taxonomy=MSBC&occupancy=RES

openquake.calculators.extract.extract_asset_tags(dstore, tagname)[source]

Extract an array of asset tags for the given tagname. Use it as /extract/asset_tags or /extract/asset_tags/taxonomy

openquake.calculators.extract.extract_assets(dstore, what)[source]

Extract an array of assets, optionally filtered by tag. Use it as /extract/assets?taxonomy=RC&taxonomy=MSBC&occupancy=RES

openquake.calculators.extract.extract_disagg(dstore, what)[source]

Extract a disaggregation output Example: http://127.0.0.1:8800/v1/calc/30/extract/ disagg?kind=Mag_Dist&imt=PGA&poe_id=0&site_id=1

openquake.calculators.extract.extract_disagg_layer(dstore, what)[source]

Extract a disaggregation output containing all sites Example: http://127.0.0.1:8800/v1/calc/30/extract/ disagg_layer?kind=Mag_Dist&imt=PGA&poe_id=0

openquake.calculators.extract.extract_dmg_by_asset_npz(dstore, what)[source]
openquake.calculators.extract.extract_event_info(dstore, eidx)[source]

Extract information about the given event index. Example: http://127.0.0.1:8800/v1/calc/30/extract/event_info/0

openquake.calculators.extract.extract_exposure_metadata(dstore, what)[source]

Extract the loss categories and the tags of the exposure. Use it as /extract/exposure_metadata

openquake.calculators.extract.extract_gmf_scenario_npz(dstore, what)[source]
openquake.calculators.extract.extract_hcurves(dstore, what)[source]

Extracts hazard curves. Use it as /extract/hcurves?kind=mean or /extract/hcurves?kind=rlz-0, /extract/hcurves?kind=stats, /extract/hcurves?kind=rlzs etc

openquake.calculators.extract.extract_hmaps(dstore, what)[source]

Extracts hazard maps. Use it as /extract/hmaps?imt=PGA

openquake.calculators.extract.extract_losses_by_asset(dstore, what)[source]
openquake.calculators.extract.extract_losses_by_event(dstore, what)[source]
openquake.calculators.extract.extract_mean_std_curves(dstore, what)[source]

Yield imls/IMT and poes/IMT containg mean and stddev for all sites

openquake.calculators.extract.extract_mfd(dstore, what)[source]

Display num_ruptures by magnitude for event based calculations. Example: http://127.0.0.1:8800/v1/calc/30/extract/event_based_mfd?kind=mean

openquake.calculators.extract.extract_realizations(dstore, dummy)[source]

Extract an array of realizations. Use it as /extract/realizations

openquake.calculators.extract.extract_rupture(dstore, serial)[source]

Extract information about the given event index. Example: http://127.0.0.1:8800/v1/calc/30/extract/rupture/1066

openquake.calculators.extract.extract_source_geom(dstore, srcidxs)[source]

Extract the geometry of a given sources Example: http://127.0.0.1:8800/v1/calc/30/extract/source_geom/1,2,3

openquake.calculators.extract.extract_src_loss_table(dstore, loss_type)[source]

Extract the source loss table for a give loss type, ordered in decreasing order. Example: http://127.0.0.1:8800/v1/calc/30/extract/src_loss_table/structural

openquake.calculators.extract.extract_task_info(dstore, what)[source]

Extracts the task distribution. Use it as /extract/task_info?kind=classical

openquake.calculators.extract.extract_uhs(dstore, what)[source]

Extracts uniform hazard spectra. Use it as /extract/uhs?kind=mean or /extract/uhs?kind=rlz-0, etc

openquake.calculators.extract.get_info(dstore)[source]
Returns

{‘stats’: dic, ‘loss_types’: dic, ‘num_rlzs’: R}

openquake.calculators.extract.get_loss_type_tags(what)[source]
openquake.calculators.extract.get_mesh(sitecol, complete=True)[source]
Returns

a lon-lat or lon-lat-depth array depending if the site collection is at sea level or not

openquake.calculators.extract.get_ruptures_within(dstore, bbox)[source]

Extract the ruptures within the given bounding box, a string minlon,minlat,maxlon,maxlat. Example: http://127.0.0.1:8800/v1/calc/30/extract/ruptures_with/8,44,10,46

openquake.calculators.extract.hazard_items(dic, mesh, *extras, **kw)[source]
Parameters
  • dic – dictionary of arrays of the same shape

  • mesh – a mesh array with lon, lat fields of the same length

  • extras – optional triples (field, dtype, values)

  • kw – dictionary of parameters (like investigation_time)

Returns

a list of pairs (key, value) suitable for storage in .npz format

openquake.calculators.extract.lit_eval(string)[source]

ast.literal_eval the string if possible, otherwise returns it unchanged

openquake.calculators.extract.parse(query_string, info={})[source]
Returns

a normalized query_dict as in the following examples:

>>> parse('kind=stats', {'stats': {'mean': 0, 'max': 1}})
{'kind': ['mean', 'max'], 'k': [0, 1], 'rlzs': False}
>>> parse('kind=rlzs', {'stats': {}, 'num_rlzs': 3})
{'kind': ['rlz-000', 'rlz-001', 'rlz-002'], 'k': [0, 1, 2], 'rlzs': True}
>>> parse('kind=mean', {'stats': {'mean': 0, 'max': 1}})
{'kind': ['mean'], 'k': [0], 'rlzs': False}
>>> parse('kind=rlz-3&imt=PGA&site_id=0', {'stats': {}})
{'kind': ['rlz-3'], 'imt': ['PGA'], 'site_id': [0], 'k': [3], 'rlzs': True}
openquake.calculators.extract.sanitize(query_string)[source]

Replace /, ?, & characters with underscores and ‘=’ with ‘-‘