openquake.server package

Subpackages

• openquake.server.db package
  • openquake.server.db.actions module
    • List
    • add_tag_to_job()
    • calc_info()
    • check_outdated()
    • create_job()
    • create_outputs()
    • create_tag()
    • db_version()
    • del_calc()
    • delete_tag()
    • delete_uncompleted_calculations()
    • engine_version()
    • find()
    • finish()
    • get_calc_ids()
    • get_calcs()
    • get_checksum_from_job()
    • get_executing_jobs()
    • get_job()
    • get_job_from_checksum()
    • get_job_id_from_checksum()
    • get_job_stats()
    • get_jobs()
    • get_jobs_by_date()
    • get_log()
    • get_log_size()
    • get_log_slice()
    • get_longest_jobs()
    • get_output()
    • get_outputs()
    • get_preferred_job_for_tag()
    • get_result()
    • get_results()
    • get_running_jobs()
    • get_traceback()
    • get_uncompleted_jobs()
    • get_weight()
    • has_job_table()
    • import_job()
    • keep()
    • list_calculations()
    • list_outputs()
    • list_tags()
    • log()
    • remove_tag_from_job()
    • reset_is_running()
    • set_preferred_job_for_tag()
    • set_status()
    • share_job()
    • unset_preferred_job_for_tag()
    • update_job()
    • update_job_checksum()
    • update_parent_child()
    • upgrade_db()
    • what_if_I_upgrade()
  • openquake.server.db.upgrade_manager module
    • DuplicatedVersion
    • UpgradeManager
      • UpgradeManager.ENGINE_URL
      • UpgradeManager.UPGRADES
      • UpgradeManager.check_versions()
      • UpgradeManager.extract_upgrade_scripts()
      • UpgradeManager.get_db_versions()
      • UpgradeManager.init()
      • UpgradeManager.install_versioning()
      • UpgradeManager.instance()
      • UpgradeManager.parse_script_name()
      • UpgradeManager.read_scripts()
      • UpgradeManager.upgrade()
    • VersionTooSmall
    • VersioningNotInstalled
    • WrappedConnection
      • WrappedConnection.run()
    • apply_sql_script()
    • check_script()
    • db_version()
    • upgrade_db()
    • what_if_I_upgrade()
  • Module contents
• openquake.server.v1 package
  • openquake.server.v1.calc_urls module
  • Module contents

Submodules

openquake.server.manage module

openquake.server.middleware module

class openquake.server.middleware.LoginRequiredMiddleware(get_response)

Bases: object

Middleware that requires a user to be authenticated to view any page other than LOGIN_URL. Exemptions to this requirement can be specified in settings via a list of regular expressions in LOGIN_EXEMPT_URLS.

Requires authentication middleware and template context processors to be loaded. You’ll get an error if they aren’t.

class openquake.server.middleware.PrintHeadersMiddleware(get_response)

Bases: object

openquake.server.settings module

openquake.server.urls module

openquake.server.utils module

openquake.server.utils.check_webserver_running(url='http://localhost:8800', max_retries=30, warn=True)

Returns True if a given URL is responding within a given timeout.

openquake.server.utils.get_acl_on(request)

Returns True if ACL should be honorated, returns otherwise False.

openquake.server.utils.get_username(request)

Returns the users from request if authentication is enabled, otherwise returns the default user (from settings, or as reported by the OS).

openquake.server.utils.get_valid_users(request)

” Returns a list of users based on groups membership. Returns a list made of a single user when it is not member of any group.

openquake.server.utils.is_superuser(request)

Without authentication (settings.LOCKDOW is false) every user is considered a superuser, otherwise look at the attribute request.user.is_superuser.

openquake.server.utils.oq_server_context_processor(request)

A custom context processor which allows injection of additional context variables.

openquake.server.utils.user_has_permission(request, owner, job_status)

Returns True if user coming from the request has the permission to view a job-related resource, returns False otherwise.

openquake.server.views module

openquake.server.views.add_tag_to_job(user_level, calc_id, tag_name)

openquake.server.views.aelo_callback(job_id, job_owner_email, outputs_uri, inputs, exc=None, warnings=None, email_file_path=None)

openquake.server.views.aelo_changelog(request, **kwargs)

openquake.server.views.aelo_run(request, *args, **kwargs)

openquake.server.views.aelo_site_classes(request, *args, **kwargs)

openquake.server.views.aelo_validate(request)

openquake.server.views.ajax_login(request, *args, **kwargs)

openquake.server.views.ajax_logout(request, *args, **kwargs)

openquake.server.views.build_impact_resources(request, calc_id, dstore)

Describe impact resources and their presentation URLs.

openquake.server.views.calc(request, *args, **kwargs)

openquake.server.views.calc_abort(request, *args, **kwargs)

openquake.server.views.calc_add_tag(request, *args, **kwargs)

openquake.server.views.calc_count(request, *args, **kwargs)

openquake.server.views.calc_create_tag(request, *args, **kwargs)

openquake.server.views.calc_datastore(request, *args, **kwargs)

openquake.server.views.calc_delete_tag(request, *args, **kwargs)

openquake.server.views.calc_get_preferred_job_for_tag(request, *args, **kwargs)

openquake.server.views.calc_impact_resources(request, *args, **kwargs)

openquake.server.views.calc_list(request, *args, **kwargs)

openquake.server.views.calc_list_tags(request, *args, **kwargs)

openquake.server.views.calc_log(request, *args, **kwargs)

openquake.server.views.calc_log_size(request, *args, **kwargs)

openquake.server.views.calc_remove(request, *args, **kwargs)

openquake.server.views.calc_remove_tag(request, *args, **kwargs)

openquake.server.views.calc_result(request, *args, **kwargs)

openquake.server.views.calc_results(request, *args, **kwargs)

openquake.server.views.calc_run(request, *args, **kwargs)

openquake.server.views.calc_run_ini(request, *args, **kwargs)

openquake.server.views.calc_run_scenario_from_ses(request, *args, **kwargs)

openquake.server.views.calc_set_preferred_job_for_tag(request, *args, **kwargs)

openquake.server.views.calc_share(request, *args, **kwargs)

openquake.server.views.calc_traceback(request, *args, **kwargs)

openquake.server.views.calc_unset_preferred_job_for_tag(request, *args, **kwargs)

openquake.server.views.calc_unshare(request, *args, **kwargs)

openquake.server.views.calc_zip(request, *args, **kwargs)

openquake.server.views.can_extract(request, resource)

openquake.server.views.check_callback(request, *args, **kwargs)

openquake.server.views.check_db_response(resp)

openquake.server.views.create_impact_job(request, params, email_file_path)

openquake.server.views.create_tag(user_level, tag_name)

openquake.server.views.cross_domain_ajax(func)

openquake.server.views.delete_tag(user_level, tag_name)

openquake.server.views.determine_precision(weights)

Determine the minimum decimal places needed to represent the weights accurately

openquake.server.views.download_aggrisk(request, *args, **kwargs)

openquake.server.views.download_png(request, *args, **kwargs)

openquake.server.views.exposure_by_lse(request, *args, **kwargs)

openquake.server.views.exposure_by_mmi(request, *args, **kwargs)

openquake.server.views.extract(request, *args, **kwargs)

openquake.server.views.extract_html_table(request, *args, **kwargs)

openquake.server.views.extract_report_from_datastore(dstore, iso3, file_format)

openquake.server.views.format_oqparam(oqparam)

openquake.server.views.format_time_delta(td)

openquake.server.views.get_aelo_notes_and_warnings(ds)

openquake.server.views.get_allowed_outputs(oes, request)

openquake.server.views.get_authentication_status(request, *args, **kwargs)

openquake.server.views.get_available_gsims(request, *args, **kwargs)

openquake.server.views.get_disp_val(val)

openquake.server.views.get_engine_latest_version(request, *args, **kwargs)

openquake.server.views.get_engine_version(request, *args, **kwargs)

openquake.server.views.get_impact_form_defaults(request, *args, **kwargs)

openquake.server.views.get_impact_rupture_data(post, user, rupture_path)

Validate a rupture and build the data needed by the IMPACT UI.

openquake.server.views.get_impact_warnings(ds)

openquake.server.views.get_ini_defaults(request, *args, **kwargs)

openquake.server.views.get_preferred_job_for_tag(tag_name)

openquake.server.views.get_site_class_display_name(ds)

openquake.server.views.get_user_level(request)

openquake.server.views.group_keys_by_value(d)

Groups keys from the input dictionary by their shared values. If a value is shared by multiple keys, those keys are grouped into a tuple. Otherwise, the key is kept as-is.

Parameters:

d – a dictionary with hashable keys and values

Returns:

a dictionary where keys are either individual keys or tuples of keys that shared the same value, and values are the original values

Example:

>>> group_keys_by_value({0: 'a', 1: 'b', 2: 'a'})
{(0, 2): 'a', 1: 'b'}

openquake.server.views.impact_callback(job_id, params, job_owner_email, outputs_uri, exc=None, warnings=None, email_file_path=None)

openquake.server.views.impact_get_nodal_planes_and_info(request, *args, **kwargs)

openquake.server.views.impact_get_rupture_data(request, *args, **kwargs)

openquake.server.views.impact_get_shakemap_versions(request, *args, **kwargs)

openquake.server.views.impact_get_stations_from_usgs(request, *args, **kwargs)

openquake.server.views.impact_report(request, *args, **kwargs)

openquake.server.views.impact_results(request, *args, **kwargs)

openquake.server.views.impact_run(request, *args, **kwargs)

openquake.server.views.impact_run_with_shakemap(request, *args, **kwargs)

openquake.server.views.infer_site_class(asce_version, vs30)

openquake.server.views.is_model_preliminary(ds)

openquake.server.views.jobs_from_inis(request, *args, **kwargs)

openquake.server.views.license(request, **kwargs)

openquake.server.views.list_tags()

openquake.server.views.log_to_json(log)

Convert a log record into a list of strings

openquake.server.views.model_provenance(request, *args, **kwargs)

openquake.server.views.on_same_fs(request, *args, **kwargs)

openquake.server.views.remove_tag_from_job(user_level, calc_id, tag_name)

openquake.server.views.save_pik(job, dirname)

Save a LogContext object in pickled format; returns the path to it

openquake.server.views.set_preferred_job_for_tag(user_level, calc_id, tag_name)

openquake.server.views.share_job(request, calc_id, share)

openquake.server.views.stream_response(fname, content_type, exportname='')

Stream a file stored in a temporary directory via Django

openquake.server.views.submit_job(request_files, ini, username, hc_id, notify_to=None)

Create a job object from the given files and run it in a new process.

Returns:

a job ID

openquake.server.views.unset_preferred_job_for_tag(user_level, tag_name)

openquake.server.views.validate_ini(request, *args, **kwargs)

openquake.server.views.validate_nrml(request, *args, **kwargs)

openquake.server.views.validate_zip(request, *args, **kwargs)

openquake.server.views.web_engine(request, **kwargs)

openquake.server.views.web_engine_get_outputs(request, *args, **kwargs)

openquake.server.views.web_engine_get_outputs_aelo(request, *args, **kwargs)

openquake.server.views.web_engine_get_outputs_impact(request, *args, **kwargs)

openquake.server.internal_api module

Internal API of the WebUI, served by Django under the /v0 and /v1 paths of the server.

The functions without the v0_/v1_ prefix implement the endpoints: they are called in-process by openquake.server.views and they raise ApiError on failure. The decorated functions are the HTTP views, which check the internal API key and turn the outcome into a response.

exception openquake.server.internal_api.ApiError(status, detail=None, content=None)

Bases: Exception

Error returned to the caller with the given HTTP status.

response()

Return the JSON response describing the error.

class openquake.server.internal_api.ExportResponse(fname, **kwargs)

Bases: FileResponse

Stream an exported file and remove its directory once closed.

close()

openquake.server.internal_api.aelo_run(form)

Run an AELO calculation from the given form.

openquake.server.internal_api.aelo_site_classes()

Return the AELO site-class definitions.

openquake.server.internal_api.calc_abort(calc_id)

Abort a running calculation.

openquake.server.internal_api.calc_info(calc_id)

Return the information about a calculation.

openquake.server.internal_api.calc_list_count(params, valid_users, acl_on)

Count the calculations matching the filters of the list view.

openquake.server.internal_api.calc_log(calc_id, start, stop)

Return a slice of the log of a calculation.

openquake.server.internal_api.calc_log_size(calc_id)

Return the number of log lines of a calculation.

openquake.server.internal_api.calc_remove(calc_id, username)

Remove a calculation on behalf of its owner.

openquake.server.internal_api.calc_result(result_id, export_type=None)

Export a result in the requested format, as a downloadable file.

openquake.server.internal_api.calc_run(form)

Submit a calculation, using the archive in the form if present.

openquake.server.internal_api.calc_traceback(calc_id)

Return the traceback of a calculation.

openquake.server.internal_api.db_action(action, payload)

Execute an allowlisted database action.

openquake.server.internal_api.get_impact_resource_data(dstore)

Return available IMPACT resources without presentation URLs.

openquake.server.internal_api.get_uploaded_file_path(files, filename)

Copy an uploaded file to a temporary path and return its location.

openquake.server.internal_api.has_api_key(request)

Return whether the request carries the internal API key.

openquake.server.internal_api.impact_form_defaults()

Return the default values for the IMPACT form.

openquake.server.internal_api.impact_get_rupture_data(form)

Build the rupture data of an IMPACT job from the given form.

openquake.server.internal_api.impact_run(form)

Run an IMPACT calculation from the given form.

openquake.server.internal_api.internal_view(*methods, auth=True)

Turn a function of the request into a Django view accepting only the given HTTP methods. The view is exempt from CSRF checks, since the callers are programs, and it requires the internal API key unless auth is false.

openquake.server.internal_api.json_response(data, status=200)

Return a JSON response, converting dates and numpy scalars.

openquake.server.internal_api.make_form(*sources)

Merge plain fields (dictionaries or QueryDicts) and uploaded files into a single MultiValueDict, the form accepted by the internal functions.

openquake.server.internal_api.model_provenance(calc_id)

Return the model provenance of a calculation.

openquake.server.internal_api.run(func, *args, **kwargs)

Call an internal API function and return its response. The errors raised as ApiError or as dbapi.NotFound become JSON error responses, while a returned HTTP response is passed unchanged.

openquake.server.internal_api.run_scenario_calc_from_ses_rupture(rup_id, form)

Run a PAPERS scenario calculation for an SES rupture.

openquake.server.internal_api.v0_aelo_run(request)

Run an AELO calculation for an authenticated Django caller.

openquake.server.internal_api.v0_calc_abort(request, calc_id)

Abort a running calculation for an authenticated caller.

openquake.server.internal_api.v0_calc_log(request, calc_id, start, stop)

Return a calculation log slice.

openquake.server.internal_api.v0_calc_log_size(request, calc_id)

Return the number of log lines for a calculation.

openquake.server.internal_api.v0_calc_remove(request, calc_id)

Remove a calculation for an authenticated caller.

openquake.server.internal_api.v0_calc_result(request, result_id)

Export a calculation result in the requested format.

openquake.server.internal_api.v0_calc_run(request)

Submit a calculation for an authenticated Django caller.

openquake.server.internal_api.v0_calc_traceback(request, calc_id)

Return the traceback for a calculation.

openquake.server.internal_api.v0_db_action(request, action)

Execute an allowlisted database action.

openquake.server.internal_api.v0_impact_get_rupture_data(request)

Build IMPACT rupture data for an authenticated Django caller.

openquake.server.internal_api.v0_impact_run(request)

Run IMPACT for an authenticated Django caller.

openquake.server.internal_api.v0_model_provenance(request, calc_id)

Return the model provenance of a calculation.

openquake.server.internal_api.v0_run_scenario(request, rup_id)

Run a papers scenario calculation for an authenticated caller.

openquake.server.internal_api.v0_validate_ini(request)

Validate an uploaded INI file.

openquake.server.internal_api.v0_validate_zip(request)

Validate an uploaded calculation archive.

openquake.server.internal_api.v0_worker(request, action)

Run an authenticated worker-control action.

openquake.server.internal_api.v1_aelo_site_classes(request)

Return the AELO site-class definitions.

openquake.server.internal_api.v1_calc_info(request, calc_id)

Return the information about a calculation.

openquake.server.internal_api.v1_calc_list_count(request)

Count the calculations matching the filters of the list view.

openquake.server.internal_api.v1_impact_form_defaults(request)

Return the default values for the IMPACT form.

openquake.server.internal_api.validate_job(job_file)

Validate a calculation input and return its JSON-compatible result.

openquake.server.internal_api.validate_upload(form, field, missing_message)

Validate the calculation file stored under the given field.

openquake.server.internal_api.worker_action(action, payload)

Run an authenticated worker-control action.

Module contents