import logging
import os
from pywps import FORMATS, ComplexOutput, Format, LiteralInput, Process
from pywps.app.Common import Metadata
from ..director import wrap_director
from ..utils.average_utils import run_average_by_dim
from ..utils.input_utils import parse_wps_input
from ..utils.metalink_utils import build_metalink
from ..utils.response_utils import populate_response
LOGGER = logging.getLogger()
[docs]
class AverageByDimension(Process):
def __init__(self):
inputs = [
LiteralInput(
"collection",
"Collection",
abstract="A dataset identifier or list of comma separated identifiers. "
"Example: c3s-cmip5.output1.ICHEC.EC-EARTH.historical.day.atmos.day.r1i1p1.tas.latest",
data_type="string",
min_occurs=1,
max_occurs=1,
),
LiteralInput(
"dims",
"Dimensions",
abstract="Dimensions used for aggregation. Example: level",
allowed_values=[
"time",
"level",
"latitude",
"longitude",
"realization",
],
data_type="string",
min_occurs=1,
max_occurs=4,
),
LiteralInput(
"pre_checked",
"Pre-Checked",
data_type="boolean",
abstract="Use checked data only.",
default="0",
min_occurs=1,
max_occurs=1,
),
LiteralInput(
"apply_fixes",
"Apply Fixes",
data_type="boolean",
abstract="Apply fixes to datasets.",
default="1",
min_occurs=1,
max_occurs=1,
),
]
outputs = [
ComplexOutput(
"output",
"METALINK v4 output",
abstract="Metalink v4 document with references to NetCDF files.",
as_reference=True,
supported_formats=[FORMATS.META4],
),
ComplexOutput(
"prov",
"Provenance",
abstract="Provenance document using W3C standard.",
as_reference=True,
supported_formats=[FORMATS.JSON],
),
ComplexOutput(
"prov_plot",
"Provenance Diagram",
abstract="Provenance document as diagram.",
as_reference=True,
supported_formats=[
Format("image/png", extension=".png", encoding="base64")
],
),
]
super().__init__(
self._handler,
identifier="average",
title="Average by Dimensions",
abstract="Run averaging by dimensions on climate model data.",
metadata=[
Metadata("DAOPS", "https://github.com/roocs/daops"),
],
version="1.0",
inputs=inputs,
outputs=outputs,
store_supported=True,
status_supported=True,
)
def _handler(self, request, response):
# show me the environment used by the process in debug mode
LOGGER.debug(f"Environment used in average: {os.environ}")
# from clisops.exceptions import InvalidParameterValue, MissingParameterValue
collection = parse_wps_input(
request.inputs, "collection", as_sequence=True, must_exist=True
)
inputs = {
"collection": collection,
"output_dir": self.workdir,
"apply_fixes": parse_wps_input(request.inputs, "apply_fixes", default=True),
"pre_checked": parse_wps_input(
request.inputs, "pre_checked", default=False
),
"dims": parse_wps_input(
request.inputs, "dims", as_sequence=True, default=None
),
}
# Let the director manage the processing or redirection to original files
director = wrap_director(collection, inputs, run_average_by_dim)
ml4 = build_metalink(
"average-dim-result",
"Averaging by dimension result as NetCDF files.",
self.workdir,
director.output_uris,
)
populate_response(response, "average", self.workdir, inputs, collection, ml4)
return response
