import logging
import os
from pywps import FORMATS, ComplexInput, ComplexOutput, Format, LiteralInput, LiteralOutput, Process
from pywps.app.Common import Metadata
from pywps.response.status import WPS_STATUS
from pywps.inout.literaltypes import AllowedValue
from pywps.validator.allowed_value import ALLOWEDVALUETYPE
from .utils import (default_outputs, model_experiment_ensemble, year_ranges, outputs_from_plot_names,
historic_projection_year_ranges, check_constraints)
from .. import runner, util
LOGGER = logging.getLogger("PYWPS")
[docs]class HeatwavesColdwaves(Process):
def __init__(self):
self.variables = ['tasmin']
self.frequency = 'day'
inputs = [
*model_experiment_ensemble(model='bcc-csm1-1',
experiment='rcp85',
ensemble='r1i1p1',
max_occurs=1,
required_variables=self.variables,
required_frequency=self.frequency,
exclude_historical=True),
*historic_projection_year_ranges(1971, 2000, 2060, 2080),
LiteralInput('quantile',
'Quantile',
abstract='Quantile defining the exceedance/non-exceedance threshold.',
data_type='float',
allowed_values=AllowedValue(allowed_type=ALLOWEDVALUETYPE.RANGE, minval=0.0, maxval=1.0),
default=0.8),
LiteralInput('min_duration',
'Minimum duration',
abstract='Minimum duration in days of a heatwave/coldwave event.',
data_type='integer',
allowed_values=AllowedValue(allowed_type=ALLOWEDVALUETYPE.RANGE, minval=1, maxval=366),
default=5),
LiteralInput('operator',
'Operator',
abstract='Exceedance/non-exceedance of historic threshold.',
data_type='string',
allowed_values=['exceedances', 'non-exceedances'],
default='non-exceedances'),
LiteralInput('season',
'Season',
abstract='Choose a season.',
data_type='string',
allowed_values=['summer', 'winter'],
default='winter'),
]
outputs = [
ComplexOutput('plot',
'Extreme spell duration tasmin plot',
abstract='Generated extreme spell duration tasmin plot.',
as_reference=True,
supported_formats=[Format('image/png')]),
ComplexOutput('data',
'Extreme spell duration tasmin data',
abstract='Extreme spell duration tasmin data.',
as_reference=True,
supported_formats=[Format('application/zip')]),
ComplexOutput('archive',
'Archive',
abstract='The complete output of the ESMValTool processing as an zip archive.',
as_reference=True,
supported_formats=[Format('application/zip')]),
*default_outputs(),
]
super(HeatwavesColdwaves, self).__init__(
self._handler,
identifier="heatwaves_coldwaves",
title="Heatwave and coldwave duration",
version=runner.VERSION,
abstract="""Metric showing the duration of heatwaves and coldwaves, to help understand potential changes in
energy demand. The estimated calculation time of this process is 4 minutes for the default
values supplied.""",
metadata=[
Metadata('ESMValTool', 'http://www.esmvaltool.org/'),
Metadata(
'Documentation',
'https://esmvaltool.readthedocs.io/en/v2.0a2/recipes/recipe_heatwaves_coldwaves.html',
role=util.WPS_ROLE_DOC),
],
inputs=inputs,
outputs=outputs,
status_supported=True,
store_supported=True)
def _handler(self, request, response):
response.update_status("starting ...", 0)
# build esgf search constraints
constraints = dict(model=request.inputs['model'][0].data,
ensemble=request.inputs['ensemble'][0].data,
experiment=request.inputs['experiment'][0].data,
start_year_historical=request.inputs['start_historical'][0].data,
end_year_historical=request.inputs['end_historical'][0].data,
start_year_projection=request.inputs['start_projection'][0].data,
end_year_projection=request.inputs['end_projection'][0].data)
op = request.inputs['operator'][0].data
if op == 'exceedances':
operator = "'>'"
elif op == 'non-exceedances':
operator = "'<'"
else:
raise Exception('Unknown operator for task: ' + op)
options = dict(
quantile=request.inputs['quantile'][0].data,
min_duration=request.inputs['min_duration'][0].data,
operator=operator,
season=request.inputs['season'][0].data,
start_historical='{}-01-01'.format(request.inputs['start_historical'][0].data),
end_historical='{}-12-31'.format(request.inputs['end_historical'][0].data),
start_projection='{}-01-01'.format(request.inputs['start_projection'][0].data),
end_projection='{}-12-31'.format(request.inputs['end_projection'][0].data),
)
# generate recipe
response.update_status("generate recipe ...", 10)
recipe_file, config_file = runner.generate_recipe(
workdir=self.workdir,
diag='heatwaves_coldwaves',
constraints=constraints,
options=options,
start_year=request.inputs['start_historical'][0].data,
end_year=request.inputs['end_projection'][0].data,
output_format='png',
)
# recipe output
response.outputs['recipe'].output_format = FORMATS.TEXT
response.outputs['recipe'].file = recipe_file
# run diag
response.update_status("running diagnostic (this could take a while)...", 20)
result = runner.run(recipe_file, config_file)
response.outputs['success'].data = result['success']
# log output
response.outputs['log'].output_format = FORMATS.TEXT
response.outputs['log'].file = result['logfile']
# debug log output
response.outputs['debug_log'].output_format = FORMATS.TEXT
response.outputs['debug_log'].file = result['debug_logfile']
if result['success']:
try:
self.get_outputs(result, constraints, response)
except Exception as e:
response.update_status("exception occured: " + str(e), 85)
LOGGER.exception('Getting output failed: ' + str(e))
else:
LOGGER.exception('esmvaltool failed!')
response.update_status("exception occured: " + result['exception'], 85)
response.update_status("creating archive of diagnostic result ...", 90)
response.outputs['archive'].output_format = Format('application/zip')
response.outputs['archive'].file = runner.compress_output(
os.path.join(self.workdir, 'output'),
os.path.join(self.workdir, 'heatwaves_coldwaves_result.zip'))
response.update_status("done.", 100)
return response
[docs] def get_outputs(self, result, constraints, response):
# result plot
response.update_status("collecting output ...", 80)
response.outputs['plot'].output_format = Format('application/png')
response.outputs['plot'].file = runner.get_output(result['plot_dir'],
path_filter=os.path.join('heatwaves_coldwaves', 'main'),
name_filter="*extreme_spell*",
output_format="png")
response.outputs['data'].output_format = FORMATS.NETCDF
response.outputs['data'].file = runner.get_output(result['work_dir'],
path_filter=os.path.join('heatwaves_coldwaves', 'main'),
name_filter="*extreme_spell*",
output_format="nc")