openquake.engine package

Subpackages

• openquake.engine.export package
  • openquake.engine.export.core module
  • Module contents
• openquake.engine.tools package
  • openquake.engine.tools.correct_complex_sources module
  • openquake.engine.tools.make_html_report module
  • openquake.engine.tools.viewlog module
  • Module contents
• openquake.engine.utils package
  • Module contents

Submodules

openquake.engine.engine module

Engine: A collection of fundamental functions for initializing and running calculations.

exception openquake.engine.engine.MasterKilled

Bases: KeyboardInterrupt

Exception raised when a job is killed manually

openquake.engine.engine.check_obsolete_version(calculation_mode='WebUI')

Check if there is a newer version of the engine.

Parameters:calculation_mode –

• the calculation mode when called from the engine
• an empty string when called from the WebUI

Returns:

• a message if the running version of the engine is obsolete
• the empty string if the engine is updated
• None if the check could not be performed (i.e. github is down)

openquake.engine.engine.expose_outputs(dstore)

Build a correspondence between the outputs in the datastore and the ones in the database.

Parameters:dstore – datastore

openquake.engine.engine.inhibitSigInt(signum, _stack)

openquake.engine.engine.job_from_file(cfg_file, username, hazard_calculation_id=None)

Create a full job profile from a job config file.

Parameters:

• cfg_file (str) – Path to a job.ini file.
• username (str) – The user who will own this job profile and all results
• datadir (str) – Data directory of the user
• hazard_calculation_id – ID of a previous calculation or None

Returns:

a pair (job_id, oqparam)

openquake.engine.engine.raiseMasterKilled(signum, _stack)

When a SIGTERM is received, raise the MasterKilled exception with an appropriate error message.

Parameters:

• signum (int) – the number of the received signal
• _stack – the current frame object, ignored

openquake.engine.engine.run_calc(job_id, oqparam, log_level, log_file, exports, hazard_calculation_id=None, **kw)

Run a calculation.

Parameters:

• job_id – ID of the current job
• oqparam – openquake.commonlib.oqvalidation.OqParam instance
• log_level (str) – The desired logging level. Valid choices are ‘debug’, ‘info’, ‘progress’, ‘warn’, ‘error’, and ‘critical’.
• log_file (str) – Complete path (including file name) to file where logs will be written. If None, logging will just be printed to standard output.
• exports – A comma-separated string of export types.

openquake.engine.engine.version_triple(tag)

returns: a triple of integers from a version tag

openquake.engine.engine.zip(job_ini, archive_zip, oq=None, log=<function info>)

Zip the given job.ini file into the given archive, together with all related files.

Module contents

OpenQuake is an open-source platform for the calculation of hazard and risk impact. It is a project of the Global Earthquake Model, and may be extended by other organizations to address additional classes of peril.

For more information, please see the website at http://www.globalquakemodel.org This software may be downloaded at http://github.com/gem/openquake

The continuous integration server is at

https://ci.openquake.org

Up-to-date sphinx documentation is at

http://docs.openquake.org

This software is licensed under the AGPL license, for more details please see the LICENSE file.

Copyright (C) 2010-2018 GEM Foundation

OpenQuake is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

OpenQuake is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with OpenQuake. If not, see <http://www.gnu.org/licenses/>.