Merge remote-tracking branch 'upstream/master' into collapse-cli

improver/calibration/dataframe_utilities.py

@@ -226,6 +226,41 @@ def _fill_missing_entries(df, combi_cols, static_cols, site_id_col):
     return df
 
 
+def _ensure_consistent_static_cols(
+    forecast_df: DataFrame, static_cols: List[str], site_id_col: str
+) -> DataFrame:
+    """Ensure that the columns expected to have the same value for a given site,
+    actually have the same values. These "static" columns could change if,
+    for example, the altitude of a site is corrected.
+
+    Args:
+        forecast_df: Forecast DataFrame.
+        static_cols: List of columns that are expected to be "static".
+        site_id_col: The name of the column containing the site ID.
+
+    Returns:
+        Forecast DataFrame with the same value for a given site for the static columns
+        provided.
+    """
+    # Check if any of the assumed static columns are actually not static when
+    # the DataFrame is grouped by the site_id_col.
+    if (forecast_df.groupby(site_id_col)[static_cols].nunique().nunique() > 1).any():
+
+        for static_col in static_cols:
+            # For each static column, find the last value from the list of unique
+            # values for each site. The last value corresponds to the most recent value
+            # present when using pd.unique.
+            temp_df = forecast_df.groupby(site_id_col)[static_col].apply(
+                lambda x: pd.unique(x)[-1]
+            )
+            # Drop the static column and then merge. The merge will recreate the static
+            # column using a constant value for each site.
+            forecast_df = forecast_df.drop(columns=static_col)
+            forecast_df = forecast_df.merge(temp_df, on=site_id_col)
+
+    return forecast_df
+
+
 def _define_time_coord(
     adate: pd.Timestamp, time_bounds: Optional[Sequence[pd.Timestamp]] = None,
 ) -> DimCoord:
@@ -513,10 +548,15 @@ def _prepare_dataframes(
         # Add station_id as a static column, if it is only present in the
         # forecast DataFrame.
         static_cols.append("station_id")
+
     forecast_df = _fill_missing_entries(
         forecast_df, combi_cols, static_cols, site_id_col
     )
 
+    forecast_df = _ensure_consistent_static_cols(
+        forecast_df, ["altitude", "latitude", "longitude"], site_id_col
+    )
+
     combi_cols = [site_id_col, "time"]
     static_cols = ["latitude", "longitude", "altitude", "diagnostic"]
     if include_station_id:

improver/cli/max_in_height.py

@@ -0,0 +1,69 @@
+#!/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.
+"""Script to calculate the maximum over the height coordinate"""
+
+from improver import cli
+
+
+@cli.clizefy
+@cli.with_output
+def process(
+    cube: cli.inputcube,
+    *,
+    lower_height_bound: float = None,
+    upper_height_bound: float = None,
+):
+    """Calculate the maximum value over the height coordinate of a cube. If height bounds are
+    specified then the maximum value between these height levels is calculated.
+
+    Args:
+        cube (iris.cube.Cube):
+            A cube with a height coordinate.
+        lower_height_bound (float):
+            The lower bound for the height coordinate. This is either a float or None if no lower
+            bound is desired. Any specified bounds should have the same units as the height
+            coordinate of cube.
+        upper_height_bound (float):
+            The upper bound for the height coordinate. This is either a float or None if no upper
+            bound is desired. Any specified bounds should have the same units as the height
+            coordinate of cube.
+    Returns:
+        A cube of the maximum value over the height coordinate or maximum value between the provided
+        height bounds."""
+
+    from improver.utilities.cube_manipulation import maximum_in_height
+
+    return maximum_in_height(
+        cube,
+        lower_height_bound=lower_height_bound,
+        upper_height_bound=upper_height_bound,
+    )

improver/cli/wet_bulb_freezing_level.py

@@ -0,0 +1,66 @@
+#!/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 extract wet-bulb freezing level from wet-bulb temperature on height levels"""
+
+from improver import cli
+
+
+@cli.clizefy
+@cli.with_output
+def process(wet_bulb_temperature: cli.inputcube):
+    """Module to generate wet-bulb freezing level.
+
+    The height level at which the wet-bulb temperature first drops below 273.15K
+    (0 degrees Celsius) is extracted from the wet-bulb temperature cube starting from
+    the ground and ascending through height levels.
+
+    In grid squares where the temperature never goes below 273.15K the highest
+    height level on the cube is returned. In grid squares where the temperature
+    starts below 273.15K the lowest height on the cube is returned.
+
+    Args:
+        wet_bulb_temperature (iris.cube.Cube):
+            Cube of wet-bulb air temperatures over multiple height levels.
+
+    Returns:
+        iris.cube.Cube:
+            Cube of wet-bulb freezing level.
+
+    """
+    from improver.utilities.cube_extraction import ExtractLevel
+
+    wet_bulb_freezing_level = ExtractLevel(
+        positive_correlation=False, value_of_level=273.15
+    )(wet_bulb_temperature)
+    wet_bulb_freezing_level.rename("wet_bulb_freezing_level")
+
+    return wet_bulb_freezing_level

improver/psychrometric_calculations/hail_size.py

@@ -48,7 +48,7 @@
     saturated_humidity,
 )
 from improver.utilities.cube_checker import assert_spatial_coords_match
-from improver.utilities.cube_extraction import ExtractPressureLevel
+from improver.utilities.cube_extraction import ExtractLevel
 from improver.utilities.cube_manipulation import enforce_coordinate_ordering
 
 
@@ -525,18 +525,16 @@ def process(
             wet_bulb_zero_height_asl,
             orography,
         )
-        extract_pressure = ExtractPressureLevel(
-            value_of_pressure_level=268.15, positive_correlation=True
+        extract_pressure = ExtractLevel(
+            value_of_level=268.15, positive_correlation=True
         )
         pressure_at_268 = extract_pressure(temperature_on_pressure)
 
         temperature_at_268 = next(temperature_on_pressure.slices_over(["pressure"]))
         temperature_at_268.rename("temperature_of_atmosphere_at_268.15K")
         temperature_at_268.remove_coord("pressure")
         temperature = np.full_like(
-            temperature_at_268.data,
-            extract_pressure.value_of_pressure_level,
-            dtype=np.float32,
+            temperature_at_268.data, extract_pressure.value_of_level, dtype=np.float32,
         )
         temperature = np.ma.masked_where(np.ma.getmask(pressure_at_268), temperature)
         temperature_at_268.data = temperature