openquake.commands package

db command


Convert strings into literal Python objects

openquake.commands.db.main(cmd, args=())[source]

Run a database command

dbserver command

openquake.commands.dbserver.main(cmd, dbhostport=None, foreground=False, *, loglevel='INFO')[source]

start/stop/restart the database server, or return its status

engine command

openquake.commands.engine.del_calculation(job_id, confirmed=False)[source]

Delete a calculation and all associated outputs.

openquake.commands.engine.get_job_id(job_id, username=None)[source]
openquake.commands.engine.main(no_distribute=False, yes=False, upgrade_db=False, db_version=False, what_if_I_upgrade=False, list_hazard_calculations=False, list_risk_calculations=False, delete_uncompleted_calculations=False, multi=False, reuse_input=False, *, log_file=None, make_html_report=None, run=None, delete_calculation: Optional[int] = None, hazard_calculation_id: Optional[int] = None, list_outputs: Optional[int] = None, show_log=None, export_output=None, export_outputs=None, param='', config_file=None, exports='', log_level='info')[source]

Run a calculation using the traditional command line API

export command

openquake.commands.export.main(datastore_key, calc_id: int = - 1, *, exports='csv', export_dir='.')[source]

Export an output from the datastore. To see the available datastore keys, use the command oq info exports.

info command[source]

Walk the directory and builds pre-calculation reports for all the job.ini files found.[source]

True if the name of the function starts with an uppercase character, report=False)[source]

Give information about the passed keyword or filename[source]

Extract information about source models. Returns a table with TRTs as rows and source classes as columns.

plot command

openquake.commands.plot.main(what, calc_id: int = - 1, others: int = [], webapi=False, local=False)[source]

Generic plotter for local and remote calculations.

openquake.commands.plot.make_figure_agg_curves(extractors, what)[source]

$ oq plot “agg_curves?kind=mean&loss_type=structural” -1

openquake.commands.plot.make_figure_avg_gmf(extractors, what)[source]

$ oq plot “avg_gmf?imt=PGA”

openquake.commands.plot.make_figure_csq_curves(extractors, what)[source]

$ oq plot “csq_curves?agg_id=0&loss_type=structural&consequence=losses” -1

openquake.commands.plot.make_figure_disagg(extractors, what)[source]

$ oq plot “disagg?kind=Mag&imt=PGA&poe_id=0”

openquake.commands.plot.make_figure_dist_by_mag(extractors, what)[source]

$ oq plot “dist_by_mag?”

openquake.commands.plot.make_figure_effect(extractors, what)[source]

$ oq plot “effect?”

openquake.commands.plot.make_figure_effect_by_mag(extractors, what)[source]

$ oq plot “effect_by_mag?”

openquake.commands.plot.make_figure_gridded_sources(extractors, what)[source]

$ oq plot “gridded_sources?task_no=0”

openquake.commands.plot.make_figure_hcurves(extractors, what)[source]

$ oq plot “hcurves?kind=mean&imt=PGA&site_id=0”

openquake.commands.plot.make_figure_hmaps(extractors, what)[source]

$ oq plot “hmaps?kind=mean&imt=PGA”

openquake.commands.plot.make_figure_memory(extractors, what)[source]

$ oq plot “memory?”

openquake.commands.plot.make_figure_rups_by_mag_dist(extractors, what)[source]

$ oq plot “rups_by_mag_dist?”

openquake.commands.plot.make_figure_rupture_info(extractors, what)[source]

$ oq plot “rupture_info?min_mag=6”

openquake.commands.plot.make_figure_source_data(extractors, what)[source]

$ oq plot “source_data?taskno=XX”

openquake.commands.plot.make_figure_sources(extractors, what)[source]

$ oq plot “sources?limit=100” $ oq plot “sources?source_id=1&source_id=2” $ oq plot “sources?code=A&code=N”

openquake.commands.plot.make_figure_task_info(extractors, what)[source]

$ oq plot “task_info?kind=classical”

openquake.commands.plot.make_figure_tot_curves(extractors, what)[source]

$ oq plot “tot_curves?loss_type=structural&kind=rlz-000&absolute=1”

openquake.commands.plot.make_figure_uhs(extractors, what)[source]

$ oq plot “uhs?kind=mean&site_id=0”

openquake.commands.plot.make_figure_uhs_cluster(extractors, what)[source]

$ oq plot “uhs_cluster?k=12”

openquake.commands.plot.make_figure_vs30(extractors, what)[source]

$ oq plot “vs30?”


Plot a WKT string describing a polygon

openquake.commands.plot.stacked_bar(ax, x, ys, width)[source]

purge command

openquake.commands.purge.main(calc_id: int, force=False)[source]

Remove the given calculation. If you want to remove all calculations, use oq reset.


Remove all calculations of the given user

openquake.commands.purge.purge_one(calc_id, user, force)[source]

Remove one calculation ID from the database and remove its datastore

sample command

openquake.commands.sample.main(fname, reduction_factor: <openquake.hazardlib.valid.FloatRange object at 0x7f57718e1460>)[source]

Produce a submodel from fname by sampling the nodes randomly. Supports source models, site models and exposure models. As a special case, it is also able to reduce .csv files by sampling the lines. This is a debugging utility to reduce large computations to small ones.

openquake.commands.sample.reduce_source_model(fname, reduction_factor)[source]
openquake.commands.sample.save_bak(fname, node, num_nodes, total)[source]

reset command


Remove all the datastores and the database of the current user

run command

class, tottime, percall, cumtime, percall2, path)

Bases: tuple


Alias for field number 3


Alias for field number 0


Alias for field number 5


Alias for field number 2


Alias for field number 4


Alias for field number 1, n)[source]

Return profiling information as an ORG table.

  • pstatfile – path to a .pstat file

  • n – the maximum number of stats to retrieve, pdb=False, reuse_input=False, *, slowest: typing.Optional[int] = None, hc: typing.Optional[int] = None, param='', concurrent_tasks: typing.Optional[int] = None, exports: <openquake.hazardlib.valid.Choices object at 0x7f5786b792b0> = '', loglevel='info')[source]

Run a calculation

show command'contents', calc_id: = - 1, extra=())[source]

Show the content of a datastore (by default the last one).[source][source]

show_attrs command

openquake.commands.show_attrs.main(key, calc_id: int = - 1)[source]

Show the attributes of a HDF5 dataset in the datastore.

tidy command


Reformat a NRML file in a canonical form. That also means reducing the precision of the floats to a standard value. If the file is invalid, a clear error message is shown.

to_hdf5 command

openquake.commands.to_hdf5.convert_npz_hdf5(input_file, output_file)[source]
openquake.commands.to_hdf5.convert_xml_hdf5(input_file, output_file)[source]

Convert .xml and .npz files to .hdf5 files.

upgrade_nrml command


Parse the vulnerability model in NRML 0.4 format.


fname – path of the vulnerability file


a dictionary imt, taxonomy -> vulnerability function + vset

openquake.commands.upgrade_nrml.main(directory, dry_run=False, multipoint=False)[source]

Upgrade all the NRML files contained in the given directory to the latest NRML version. Works by walking all subdirectories. WARNING: there is no downgrade!

openquake.commands.upgrade_nrml.upgrade_file(path, multipoint)[source]

Upgrade to the latest NRML version

webui command

openquake.commands.webui.main(cmd, hostport='', skip_browser: bool = False)[source]

start the webui server in foreground or perform other operation on the django application

openquake.commands.webui.rundjango(subcmd, hostport=None, skip_browser=False)[source]