cloudnetpy 1.64.5__tar.gz → 1.65.1__tar.gz

{cloudnetpy-1.64.5/cloudnetpy.egg-info → cloudnetpy-1.65.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cloudnetpy
-Version: 1.64.5
+Version: 1.65.1
 Summary: Python package for Cloudnet processing
 Author: Simo Tukiainen
 License: MIT License

{cloudnetpy-1.64.5 → cloudnetpy-1.65.1}/cloudnetpy/categorize/atmos.py

@@ -181,7 +181,14 @@ class LiquidAttenuation(Attenuation):
 
     def __init__(self, data: dict, classification: ClassificationResult):
         super().__init__(data["model"], classification)
-        self._mwr = data["mwr"].data
+        if data["mwr"] is not None:
+            self._mwr = data["mwr"].data
+        else:
+            n_time = data["radar"].data["Z"][:].shape[0]
+            self._mwr = {
+                "lwp": ma.masked_all(n_time),
+                "lwp_error": ma.masked_all(n_time),
+            }
         self._lwc_dz_err = self._get_lwc_change_rate_error()
         self.atten = self._get_liquid_atten()
         self.atten_err = self._get_liquid_atten_err()

{cloudnetpy-1.64.5 → cloudnetpy-1.65.1}/cloudnetpy/categorize/categorize.py

@@ -20,54 +20,58 @@ def generate_categorize(
     uuid: str | None = None,
     options: dict | None = None,
 ) -> str:
-    """Generates Cloudnet Level 1c categorize file.
+    """Generates a Cloudnet Level 1c categorize file.
 
-    The measurements are rebinned into a common height / time grid,
-    and classified as different types of scatterers such as ice, liquid,
-    insects, etc. Next, the radar signal is corrected for atmospheric
-    attenuation, and error estimates are computed. Results are saved
-    in *output_file* which is a compressed netCDF4 file.
+    This function rebins measurements into a common height/time grid
+    and classifies them into different scatterer types, such as ice,
+    liquid, insects, etc. The radar signal is corrected for atmospheric
+    attenuation, and error estimates are computed. The results are saved in
+    *output_file*, a compressed netCDF4 file.
 
     Args:
-        input_files: dict containing file names for calibrated `radar`, `lidar`,
-            `model` and `mwr` files. Optionally also `lv0_files`, a list of
-            RPG level 0 files.
-        output_file: Full path of the output file.
-        uuid: Set specific UUID for the file.
-        options: Dictionary containing optional parameters.
+        input_files (dict): Contains filenames for calibrated `radar`, `lidar`,
+            and `model` files. Optionally, it can also include `disdrometer`,
+            `mwr` (containing the LWP variable), and `lv0_files` (a list of RPG
+            Level 0 files).
+        output_file (str): The full path of the output file.
+        uuid (str): Specific UUID to assign to the generated file.
+        options (dict): Dictionary containing optional parameters.
 
     Returns:
-        UUID of the generated file.
+        str: UUID of the generated file.
 
     Raises:
-        RuntimeError: Failed to create the categorize file.
+        RuntimeError: Raised if the categorize file creation fails.
 
     Notes:
-        Separate mwr-file is not needed when using RPG cloud radar which
-        measures liquid water path. Then, the radar file can be used as
-        a mwr-file as well, i.e. {'mwr': 'radar.nc'}.
+        A separate MWR file is not required when using an RPG cloud radar that
+        measures liquid water path (LWP). In this case, the radar file can also
+        serve as the MWR file (e.g., {'mwr': 'radar.nc'}). If no MWR file
+        is provided, liquid attenuation correction cannot be performed.
 
-        If RPG L0 files are provided as an additional input, Voodoo method is used
-        to detect liquid droplets.
+        If RPG L0 files are included as additional input, the Voodoo method
+        is used to detect liquid droplets.
 
     Examples:
         >>> from cloudnetpy.categorize import generate_categorize
-        >>> input_files = {'radar': 'radar.nc',
-                           'lidar': 'lidar.nc',
-                           'model': 'model.nc',
-                           'mwr': 'mwr.nc'}
+        >>> input_files = {
+        ...     'radar': 'radar.nc',
+        ...     'lidar': 'lidar.nc',
+        ...     'model': 'model.nc',
+        ...     'mwr': 'mwr.nc'
+        ... }
         >>> generate_categorize(input_files, 'output.nc')
 
-        >>> input_files["lv0_files"] = ["file1.LV0", "file2.LV0"]  # Add RGP LV0 files
-        >>> generate_categorize(input_files, 'output.nc')  # Use Voodoo method
-
+        >>> input_files['lv0_files'] = ['file1.LV0', 'file2.LV0']  # Add RPG LV0 files
+        >>> generate_categorize(input_files, 'output.nc')  # Use the Voodoo method
     """
 
     def _interpolate_to_cloudnet_grid() -> list:
         wl_band = utils.get_wl_band(data["radar"].radar_frequency)
-        data["mwr"].rebin_to_grid(time)
         if data["disdrometer"] is not None:
             data["disdrometer"].interpolate_to_grid(time)
+        if data["mwr"] is not None:
+            data["mwr"].rebin_to_grid(time)
         data["model"].interpolate_to_common_height(wl_band)
         model_gap_ind = data["model"].interpolate_to_grid(time, height)
         radar_gap_ind = data["radar"].rebin_to_grid(time)
@@ -115,7 +119,7 @@ def generate_categorize(
             **data["lidar"].data,
             **data["model"].data,
             **data["model"].data_sparse,
-            **data["mwr"].data,
+            **(data["mwr"].data if data["mwr"] is not None else {}),
             **(data["disdrometer"].data if data["disdrometer"] is not None else {}),
         }
 
@@ -131,10 +135,12 @@ def generate_categorize(
         data: dict = {
             "radar": Radar(input_files["radar"]),
             "lidar": Lidar(input_files["lidar"]),
-            "mwr": Mwr(input_files["mwr"]),
             "lv0_files": input_files.get("lv0_files"),
+            "mwr": None,
             "disdrometer": None,
         }
+        if "mwr" in input_files:
+            data["mwr"] = Mwr(input_files["mwr"])
         if "disdrometer" in input_files:
             try:
                 data["disdrometer"] = Disdrometer(input_files["disdrometer"])

{cloudnetpy-1.64.5 → cloudnetpy-1.65.1}/cloudnetpy/categorize/containers.py

@@ -58,7 +58,11 @@ class ClassData:
         self.tw = data["model"].data["Tw"][:]
         self.model_type = data["model"].source_type
         self.beta = data["lidar"].data["beta"][:]
-        self.lwp = data["mwr"].data["lwp"][:]
+        self.lwp = (
+            data["mwr"].data["lwp"][:]
+            if data["mwr"] is not None
+            else ma.masked_all(self.time.shape)
+        )
         self.is_rain = self._find_profiles_with_rain()
         self.is_clutter = _find_clutter(self.v, self.is_rain)
         self.altitude = data["radar"].altitude

{cloudnetpy-1.64.5 → cloudnetpy-1.65.1}/cloudnetpy/exceptions.py

@@ -63,3 +63,10 @@ class HatproDataError(CloudnetException):
 
     def __init__(self, msg: str = "Invalid HATPRO file"):
         super().__init__(msg)
+
+
+class InvalidSourceFileError(CloudnetException):
+    """Internal exception class."""
+
+    def __init__(self, msg: str = "Invalid source file"):
+        super().__init__(msg)

{cloudnetpy-1.64.5 → cloudnetpy-1.65.1}/cloudnetpy/instruments/hatpro.py

@@ -60,6 +60,10 @@ def hatpro2l1c(
 
     hatpro = HatproL1c(hatpro_raw, site_meta)
 
+    if not np.any(hatpro.data["tb"][:]):
+        msg = "No valid brightness temperatures found"
+        raise HatproDataError(msg)
+
     timestamps = hatpro.data["time"][:]
     if date is not None:
         # Screen timestamps if these assertions start to fail

{cloudnetpy-1.64.5 → cloudnetpy-1.65.1}/cloudnetpy/products/der.py

@@ -10,6 +10,7 @@ from numpy import ma
 from cloudnetpy import output, utils
 from cloudnetpy.categorize import atmos
 from cloudnetpy.datasource import DataSource
+from cloudnetpy.exceptions import InvalidSourceFileError
 from cloudnetpy.metadata import MetaData
 from cloudnetpy.products.product_tools import (
     CategorizeBits,
@@ -113,6 +114,9 @@ class DerSource(DataSource):
 
     def __init__(self, categorize_file: str, parameters: Parameters | None = None):
         super().__init__(categorize_file)
+        if "lwp" not in self.dataset.variables:
+            msg = "Liquid water path missing from the categorize file."
+            raise InvalidSourceFileError(msg)
         self.is_rain = get_is_rain(categorize_file)
         self.categorize_bits = CategorizeBits(categorize_file)
         if parameters is None:

{cloudnetpy-1.64.5 → cloudnetpy-1.65.1}/cloudnetpy/products/lwc.py

@@ -8,6 +8,7 @@ from numpy import ma
 from cloudnetpy import output, utils
 from cloudnetpy.categorize import atmos
 from cloudnetpy.datasource import DataSource
+from cloudnetpy.exceptions import InvalidSourceFileError
 from cloudnetpy.metadata import MetaData
 from cloudnetpy.products import product_tools as p_tools
 from cloudnetpy.products.product_tools import CategorizeBits, get_is_rain
@@ -88,6 +89,9 @@ class LwcSource(DataSource):
 
     def __init__(self, categorize_file: str):
         super().__init__(categorize_file)
+        if "lwp" not in self.dataset.variables:
+            msg = "Liquid water path missing from the categorize file."
+            raise InvalidSourceFileError(msg)
         self.lwp = self.getvar("lwp")
         self.lwp[self.lwp < 0] = 0
         self.lwp_error = self.getvar("lwp_error")

{cloudnetpy-1.64.5 → cloudnetpy-1.65.1}/cloudnetpy/version.py

@@ -1,4 +1,4 @@
 MAJOR = 1
-MINOR = 64
-PATCH = 5
+MINOR = 65
+PATCH = 1
 __version__ = f"{MAJOR}.{MINOR}.{PATCH}"

{cloudnetpy-1.64.5 → cloudnetpy-1.65.1/cloudnetpy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cloudnetpy
-Version: 1.64.5
+Version: 1.65.1
 Summary: Python package for Cloudnet processing
 Author: Simo Tukiainen
 License: MIT License