#!/usr/bin/env python
# -*- coding: utf-8 -*-
# -----------------------------------------------------------------------------
# (C) British Crown copyright. The Met Office.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# * Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
"""CLI to generate wet bulb temperatures from air temperature, relative
humidity, and pressure data. """
from improver import cli
[docs]@cli.clizefy
@cli.with_output
def process(
*cubes: cli.inputcube, convergence_condition=0.05, model_id_attr: str = None
):
"""Module to generate wet-bulb temperatures.
Call the calculate_wet_bulb_temperature function to calculate wet-bulb
temperatures. This process function splits input cubes over vertical levels
to mitigate memory issues when trying to operate on multi-level data.
Args:
cubes (iris.cube.CubeList or list or iris.cube.Cube):
containing:
temperature (iris.cube.Cube):
Cube of air temperatures, where these may be on multiple
height levels.
relative_humidity (iris.cube.Cube):
Cube of relative humidities, where these may be on multiple
height levels.
pressure (iris.cube.Cube):
Cube of air pressure, where these may be on multiple height
levels.
convergence_condition (float):
The precision in Kelvin to which the Newton iterator must converge
before returning wet-bulb temperatures.
model_id_attr (str):
Name of the attribute used to identify the source model for blending.
Returns:
iris.cube.Cube:
Cube of wet-bulb temperature (K).
"""
from improver.psychrometric_calculations.wet_bulb_temperature import (
WetBulbTemperature,
)
return WetBulbTemperature(
precision=convergence_condition, model_id_attr=model_id_attr
)(cubes)