# -*- coding: utf-8 -*-
# vim: tabstop=4 shiftwidth=4 softtabstop=4
#
# Copyright (C) 2015-2026 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 Affero 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/>.
# 2015.06.26 13:21:50 CEST
"""
Utilities to build a report writer generating a .rst report for a calculation
"""
import os
import sys
import getpass
import logging
import numpy
import pandas
from openquake.baselib.general import encode, decode
from openquake.commonlib import logs
from openquake.calculators import views
from openquake.calculators import base # ugly
[docs]def indent(text):
return ' ' + '\n '.join(text.splitlines())
[docs]class ReportWriter(object):
"""
A particularly smart view over the datastore
"""
title = {
'params': 'Parameters',
'inputs': 'Input files',
'required_params_per_trt':
'Required parameters per tectonic region type',
'ruptures_events': 'Specific information for event based',
'job_info': 'Data transfer',
'biggest_ebr_gmf': 'Maximum memory allocated for the GMFs',
'avglosses_data_transfer': 'Estimated data transfer for the avglosses',
'exposure_info': 'Exposure model',
'slow_sources': 'Slowest sources',
'task:start_classical:0': 'Fastest task',
'task:start_classical:-1': 'Slowest task',
'task_info': 'Information about the tasks',
'weight_by_src': 'Computation times by source typology',
'performance': 'Slowest operations',
}
def __init__(self, dstore, fmt='rst'):
self.dstore = dstore
self.fmt = fmt
self.oq = oq = dstore['oqparam']
if fmt == 'md':
self.text = '# %s' % decode(oq.description)
else:
self.text = (decode(oq.description) + '\n' + '=' * len(oq.description))
try:
num_rlzs = dstore['full_lt'].get_num_paths()
except KeyError:
num_rlzs = '?'
versions = sorted(dstore['/'].attrs.items())
self.text += '\n\n' + views.text_table(versions, ext=self.fmt)
self.text += '\n\nnum_sites = %d, num_levels = %d, num_rlzs = %s' % (
len(dstore['sitecol']), oq.imtls.size if oq.imtls else 0, num_rlzs)
[docs] def add(self, name, obj=None):
"""Add the view named `name` to the report text"""
if obj:
if self.fmt == 'md':
text = '\n```\n' + str(obj) + '\n```'
else:
text = '\n::\n\n' + indent(str(obj))
else:
res = views.view(name, self.dstore)
if isinstance(res, (numpy.ndarray, pandas.DataFrame)):
text = views.text_table(res, ext=self.fmt)
else:
text = res
if text:
title = self.title[name]
if self.fmt == 'md':
self.text += '\n\n## %s\n\n%s' % (title, text.lstrip('\n'))
else:
line = '-' * len(title)
self.text += '\n'.join(['\n\n' + title, line, text])
[docs] def make_report(self, show_inputs=True):
"""Build the report and return a restructed text string"""
oq, ds = self.oq, self.dstore
if show_inputs:
for name in ('params', 'inputs'):
self.add(name)
if 'full_lt' in ds:
self.add('required_params_per_trt')
if 'rup_data' in ds:
self.add('ruptures_events')
if oq.calculation_mode in ('event_based_risk',):
self.add('avglosses_data_transfer')
if 'exposure' in oq.inputs:
self.add('exposure_info')
if 'source_info' in ds:
self.add('slow_sources')
self.add('weight_by_src')
if 'task_info' in ds:
self.add('task_info')
tasks = set(ds['task_info']['taskname'])
if 'start_classical' in tasks:
self.add('task:start_classical:0')
self.add('task:start_classical:-1')
self.add('job_info')
if 'performance_data' in ds:
self.add('performance')
return self.text
[docs] def save(self, fname):
"""Save the report"""
with open(fname, 'wb') as f:
f.write(encode(self.text))
[docs]def build_report(job_ini, output_dir=None):
"""
Write a `report.csv` file with information about the calculation
without running it
:param job_ini:
full pathname of the job.ini file
:param output_dir:
the directory where the report is written (default the input directory)
"""
with logs.init('job', job_ini, user_name=getpass.getuser()) as log:
oq = log.get_oqparam()
if 'source_model_logic_tree' in oq.inputs:
oq.calculation_mode = 'preclassical'
oq.ground_motion_fields = False
output_dir = output_dir or os.path.dirname(job_ini)
calc = base.calculators(oq, log.calc_id)
calc.save_params() # needed to save oqparam
# some taken is care so that the real calculation is not run:
# the goal is to extract information about the source management only
calc.pre_execute()
if oq.calculation_mode == 'preclassical':
csm = calc.execute()
calc.post_execute(csm)
logging.info('Making the .rst report')
rw = ReportWriter(calc.datastore)
rw.make_report()
report = (os.path.join(output_dir, 'report.rst') if output_dir
else calc.datastore.export_path('report.rst'))
try:
rw.save(report)
except IOError as exc: # permission error
sys.stderr.write(str(exc) + '\n')
return report