openquake.commands package

db command


Convert strings into literal Python objects

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

Run a database command

dbserver command

openquake.commands.dbserver.dbserver(cmd, dbhostport=None, loglevel='INFO', foreground=False)[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.run_job(job_ini, log_level='info', log_file=None, exports='', username='jenkins', **kw)[source]

Run a job using the specified config file and other options.

  • job_ini (str) – Path to calculation config (INI-style) files.
  • log_level (str) – ‘debug’, ‘info’, ‘warn’, ‘error’, or ‘critical’
  • log_file (str) – Path to log file.
  • exports – A comma-separated string of export types requested by the user.
  • username – Name of the user running the job
  • kw – Extra parameters like hazard_calculation_id and calculation_mode
openquake.commands.engine.smart_run(job_ini, oqparam, log_level, log_file, exports, reuse_hazard, **params)[source]

Run calculations by storing their hazard checksum and reusing previous calculations if requested.

export command

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

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

from_shapefile command

openquake.commands.from_shapefile.from_shapefile(output, input_shp_files, validate)[source]

Convert multiple ESRI Shapefile(s) into a single NRML source model file.

info command[source]

Walk the directory and builds pre-calculation reports for all the job.ini files found., report=False)[source]

Give information about the passed keyword or filename[source]

Parse the composite source model and prints information about its composition and the full logic tree[source]

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

plot_agg_curve command


Aggregate loss curves plotter.

plot command

class openquake.commands.plot.PolygonPlotter(ax)[source]

Bases: object

Add polygons to a given axis object

add(poly, **kw)[source]
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_disagg(extractors, what)[source]

$ oq plot ‘disagg?kind=Mag&imt=PGA&rlz=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_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_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.plot(what='examples', calc_id=-1, other_id=None, webapi=False, local=False)[source]

Generic plotter for local and remote calculations.

plot_sites command


Plot the sites

purge command

openquake.commands.purge.purge(calc_id, 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

reduce command

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 RST table.

  • pstatfile – path to a .pstat file
  • n – the maximum number of stats to retrieve, slowest=False, hc=None, param='', concurrent_tasks=None, exports='', loglevel='info', calc_id='nojob', pdb=None)[source]

Run a calculation bypassing the database layer, job_risk, calc_id, concurrent_tasks, pdb, loglevel, exports, params)[source]

Run both hazard and risk, one after the other

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

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

show_attrs command

openquake.commands.show_attrs.show_attrs(key, calc_id=-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.

to_shapefile command

openquake.commands.to_shapefile.to_shapefile(output, input_nrml_file, validate)[source]

Convert a NRML source model file to ESRI Shapefile(s).

For each type of source geometry defined in the NRML file (point, area, simple fault, complex fault, planar) a separate shapefile is created. Each shapefile is differentiated by a specific ending(‘_point’, ‘_area’, ‘_simple’, ‘_complex’, ‘_planar’).

NB: nonparametric sources are not supported.

upgrade_nrml command


Parse the vulnerability model in NRML 0.4 format.

Parameters:fname – path of the vulnerability file
Returns:a dictionary imt, taxonomy -> vulnerability function + vset
openquake.commands.upgrade_nrml.upgrade_file(path, multipoint)[source]

Upgrade to the latest NRML version

openquake.commands.upgrade_nrml.upgrade_nrml(directory, dry_run, multipoint)[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!

webui command

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

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