Merge pull request #673 from cal-adapt/tests/new-core-convert-units

Tests/new core convert units

Author: neilSchroeder

climakitae/core/constants.py

@@ -69,6 +69,24 @@
 
 CALISO_AREA_THRESHOLD = 100
 
+# Valid unit conversion options
+UNIT_OPTIONS = {
+    "K": ["K", "degC", "degF"],
+    "degF": ["K", "degC", "degF"],
+    "degC": ["K", "degC", "degF"],
+    "hPa": ["Pa", "hPa", "mb", "inHg"],
+    "Pa": ["Pa", "hPa", "mb", "inHg"],
+    "m/s": ["m/s", "mph", "knots"],
+    "m s-1": ["m s-1", "mph", "knots"],
+    "[0 to 100]": ["[0 to 100]", "fraction"],
+    "mm": ["mm", "inches"],
+    "mm/d": ["mm/d", "inches/d"],
+    "mm/h": ["mm/h", "inches/h"],
+    "kg/kg": ["kg/kg", "g/kg"],
+    "kg kg-1": ["kg kg-1", "g kg-1"],
+    "kg m-2 s-1": ["kg m-2 s-1", "mm", "inches"],
+    "g/kg": ["g/kg", "kg/kg"],
+}
 # Start and end years for LOCA and WRF data
 LOCA_START_YEAR = 1950
 LOCA_END_YEAR = 2100

climakitae/new_core/param_validation/__init__.py

@@ -1,6 +1,7 @@
 """Import param validation classes ensuring they are registered."""
 
 from .concat_param_validator import validate_concat_param
+from .convert_units_param_validator import validate_convert_units_param
 from .clip_param_validator import validate_clip_param
 from .data_param_validator import DataValidator
 from .filter_unadjusted_models_param_validator import (

climakitae/new_core/param_validation/convert_units_param_validator.py

@@ -0,0 +1,112 @@
+"""
+Validator for parameters provided to Convert Units Processor.
+"""
+
+from __future__ import annotations
+
+import warnings
+from typing import Any, Iterable
+
+from climakitae.core.constants import UNIT_OPTIONS, UNSET
+from climakitae.new_core.param_validation.abc_param_validation import (
+    register_processor_validator,
+)
+
+# All supported units (flattened from UNIT_OPTIONS)
+ALL_SUPPORTED_UNITS = set()
+for unit_list in UNIT_OPTIONS.values():
+    ALL_SUPPORTED_UNITS.update(unit_list)
+
+
+@register_processor_validator("convert_units")
+def validate_convert_units_param(
+    value: str | Iterable[str],
+    **kwargs: Any,
+) -> bool:
+    """
+    Validate the parameters provided to the Convert Units Processor.
+
+    This function checks the value provided to the Convert Units Processor and ensures that it
+    meets the expected criteria. Will raise a user warning and return false if the value
+    is not valid.
+
+    Parameters
+    ----------
+    value : str | Iterable[str]
+        The unit(s) to convert to. Can be a single unit string or an iterable of unit strings.
+        Valid units include temperature units (K, degC, degF), pressure units (Pa, hPa, mb, inHg),
+        wind units (m/s, m s-1, mph, knots), precipitation units (mm, mm/d, mm/h, inches, inches/d, inches/h),
+        moisture units (kg/kg, kg kg-1, g/kg, g kg-1), flux units (kg m-2 s-1), and relative humidity
+        units ([0 to 100], fraction).
+
+    Returns
+    -------
+    bool
+        True if all parameters are valid, False otherwise
+    """
+    # kwargs unused but required for signature compatibility
+    del kwargs
+
+    if value is UNSET:
+        # UNSET is valid - processor will not perform any conversion
+        return True
+
+    if not _check_input_types(value):
+        return False
+
+    if not _check_unit_validity(value):
+        return False
+
+    return True
+
+
+def _check_input_types(value: str | Iterable[str]) -> bool:
+    """
+    Check if the input value has the correct type.
+
+    Parameters
+    ----------
+    value : str | Iterable[str]
+        The value to check.
+
+    Returns
+    -------
+    bool
+        True if the input type is valid, False otherwise.
+    """
+    if isinstance(value, str):
+        return True
+
+    warnings.warn(
+        "\n\nConvert Units Processor expects a string. "
+        f"\nReceived type: {type(value)}"
+    )
+    return False
+
+
+def _check_unit_validity(value: str | Iterable[str]) -> bool:
+    """
+    Check if the provided unit(s) are supported.
+
+    Parameters
+    ----------
+    value : str | Iterable[str]
+        The unit(s) to validate.
+
+    Returns
+    -------
+    bool
+        True if all units are supported, False otherwise.
+    """
+    units_to_check = [value] if isinstance(value, str) else list(value)
+
+    for unit in units_to_check:
+        if unit not in ALL_SUPPORTED_UNITS:
+            supported_units_str = ", ".join(sorted(ALL_SUPPORTED_UNITS))
+            warnings.warn(
+                f"\n\nUnsupported unit: '{unit}'. "
+                f"\nSupported units are: {supported_units_str}"
+            )
+            return False
+
+    return True

climakitae/new_core/processors/__init__.py

@@ -1,6 +1,7 @@
 """Initialize the processors, ensuring they get registered."""
 
 from .concatenate import Concat
+from .convert_units import ConvertUnits
 from .clip import Clip
 from .filter_unadjusted_models import FilterUnAdjustedModels
 from .time_slice import TimeSlice
@@ -9,6 +10,7 @@
 
 __all__ = [
     "Concat",
+    "ConvertUnits",
     "Clip",
     "FilterUnAdjustedModels",
     "TimeSlice",