cloudnetpy 1.65.0__py3-none-any.whl → 1.65.2__py3-none-any.whl

cloudnetpy/categorize/categorize.py

@@ -20,47 +20,50 @@ 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:

cloudnetpy/instruments/hatpro.py

@@ -60,6 +60,12 @@ def hatpro2l1c(
 
     hatpro = HatproL1c(hatpro_raw, site_meta)
 
+    flags = hatpro.data["quality_flag"][:]
+    bad_percentage = ma.sum(flags != 0) / flags.size * 100
+    if bad_percentage > 90:
+        msg = "More than 90% of brightness temperatures are flagged"
+        raise HatproDataError(msg)
+
     timestamps = hatpro.data["time"][:]
     if date is not None:
         # Screen timestamps if these assertions start to fail

cloudnetpy/products/mwr_tools.py

@@ -2,6 +2,7 @@ import tempfile
 from typing import Literal
 
 import netCDF4
+import numpy as np
 from mwrpy.level2.lev2_collocated import generate_lev2_multi as gen_multi
 from mwrpy.level2.lev2_collocated import generate_lev2_single as gen_single
 from mwrpy.level2.write_lev2_nc import MissingInputData
@@ -67,6 +68,12 @@ def _generate_product(
         netCDF4.Dataset(mwr_l1c_file, "r") as nc_input,
         netCDF4.Dataset(output_file, "r+") as nc_output,
     ):
+        flag_variable = "lwp" if product == "single" else "temperature"
+        flag_name = f"{flag_variable}_quality_flag"
+        flags = nc_output.variables[flag_name][:]
+        if not np.any(flags == 0):
+            msg = f"All {flag_variable} data are flagged."
+            raise ValidTimeStampError(msg)
         mwr = Mwr(nc_input, nc_output, uuid)
         return mwr.harmonize(product)
 

cloudnetpy/version.py

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

{cloudnetpy-1.65.0.dist-info → cloudnetpy-1.65.2.dist-info}/METADATA

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

{cloudnetpy-1.65.0.dist-info → cloudnetpy-1.65.2.dist-info}/RECORD

@@ -8,11 +8,11 @@ cloudnetpy/metadata.py,sha256=v_VDo2vbdTxB0zIsfP69IcrwSKiRlLpsGdq6JPI4CoA,5306
 cloudnetpy/output.py,sha256=YkCaxVkG_Mt2hng_IVnhygHteV4UMKzKALkeFZwFJL8,14822
 cloudnetpy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cloudnetpy/utils.py,sha256=JV0Fawnme1HoZgoiidV3eIzsn6vx0AEjBNmI1CcrBsA,28517
-cloudnetpy/version.py,sha256=GyQ5dtQt1vQ9KfpnsA6Fw5Z-nvlfzCZj7jSg1WwwuhY,72
+cloudnetpy/version.py,sha256=u6lVmR8dh9GGZ-f5jZEFKWsE9A_b-CpQB_QHzX-r1b0,72
 cloudnetpy/categorize/__init__.py,sha256=gP5q3Vis1y9u9OWgA_idlbjfWXYN_S0IBSWdwBhL_uU,69
 cloudnetpy/categorize/atmos.py,sha256=vavMC_WQQyGH14eL4vAzKLKDDZt8tBrMYimztYHOjH8,12639
 cloudnetpy/categorize/atmos_utils.py,sha256=64uenj2uxj3P3Blaq_pBN1pBjcF-X4LYNt-uTOjvevg,3778
-cloudnetpy/categorize/categorize.py,sha256=WQobVBcCk0HbbSIVm9yNX5apwj-5S6IIX4dvleaji0Y,18070
+cloudnetpy/categorize/categorize.py,sha256=VcxSs22icYDG3R5x9jTX7uuSjPU8tyc5bIz0Zj5F9z0,18303
 cloudnetpy/categorize/classify.py,sha256=a-0bVCtynGfORnDGTsPuzqkuDeOOR_OMz5ai9NsMuic,9870
 cloudnetpy/categorize/containers.py,sha256=g3SQHoqlY1uJ8b-MG-BbW3oWz5IyacA8kJBeIPy_4EA,4859
 cloudnetpy/categorize/disdrometer.py,sha256=keU3pFvKtk840A0oLwAyNDuqOCswBPJEKf2bV0YWyA8,2004
@@ -34,7 +34,7 @@ cloudnetpy/instruments/cl61d.py,sha256=g6DNBFju3wYhLFl32DKmC8pUup7y-EupXoUU0fuoG
 cloudnetpy/instruments/cloudnet_instrument.py,sha256=RG5HJxGM6p0F-IGyr85fvOizcMmgx48OeD_XeIsrgSU,3367
 cloudnetpy/instruments/copernicus.py,sha256=nmgqGOjVQFngj7BNbpcuCwA-W3yksvBbqn__iq7MyDk,6469
 cloudnetpy/instruments/galileo.py,sha256=yQBedd7dmDnwuWi1MtXOsg4-RyRx0uRAXumCY4YuH9k,4686
-cloudnetpy/instruments/hatpro.py,sha256=PD2wLmzzbeOticvg44cT3aJzQYsRnLekW9pBPOzjFLc,8514
+cloudnetpy/instruments/hatpro.py,sha256=2lEblvJ9m7QniWH1OH7ycWtywYqY6X3ulE4dNuQp-Z8,8749
 cloudnetpy/instruments/instruments.py,sha256=jG5TYnZ8bdCZXnI303ZsaJBEdSKaIjKMbkGtnq6kQX0,3261
 cloudnetpy/instruments/lufft.py,sha256=ugXF6pssHAAz1Y_hqPdpKuluAjxxHSR88xBmQuS6RlI,3705
 cloudnetpy/instruments/mira.py,sha256=EyzEBTpWfDlgaspZVuIfaP4l73GYSVnSzEzBZc0lZNg,9333
@@ -105,11 +105,11 @@ cloudnetpy/products/ier.py,sha256=ge1f_aYick20Nlznq8zbBl5umWlTP-UwMivy4Y05Sck,78
 cloudnetpy/products/iwc.py,sha256=Q8dXV3JF3JUQgwkmQFOKakm21Tnf8oCWsH0CSqIEKl4,10209
 cloudnetpy/products/lwc.py,sha256=wSd3GDqELz4yyWBMiKDR-QhRK8scPheqsBcS1qzxYOI,18997
 cloudnetpy/products/mie_lu_tables.nc,sha256=It4fYpqJXlqOgL8jeZ-PxGzP08PMrELIDVe55y9ob58,16637951
-cloudnetpy/products/mwr_tools.py,sha256=3esU5cG5GI2WVmOENqrJ0FbMuxLegADv7q8TB0RorGg,4674
+cloudnetpy/products/mwr_tools.py,sha256=tN_sPDS3BdpFJfa5a2mnc3eCMoi7syjVJMaTt962hmo,5004
 cloudnetpy/products/product_tools.py,sha256=VNw2diJj30POz68-3qNVkJP7r9AUspT_d1Fp0BbeIx8,10414
 docs/source/conf.py,sha256=IKiFWw6xhUd8NrCg0q7l596Ck1d61XWeVjIFHVSG9Og,1490
-cloudnetpy-1.65.0.dist-info/LICENSE,sha256=wcZF72bdaoG9XugpyE95Juo7lBQOwLuTKBOhhtANZMM,1094
-cloudnetpy-1.65.0.dist-info/METADATA,sha256=MRy1c5jmGmBs67KS3mr2jWmkiuvmhMWh1zfdr8YZj58,5784
-cloudnetpy-1.65.0.dist-info/WHEEL,sha256=nCVcAvsfA9TDtwGwhYaRrlPhTLV9m-Ga6mdyDtuwK18,91
-cloudnetpy-1.65.0.dist-info/top_level.txt,sha256=ibSPWRr6ojS1i11rtBFz2_gkIe68mggj7aeswYfaOo0,16
-cloudnetpy-1.65.0.dist-info/RECORD,,
+cloudnetpy-1.65.2.dist-info/LICENSE,sha256=wcZF72bdaoG9XugpyE95Juo7lBQOwLuTKBOhhtANZMM,1094
+cloudnetpy-1.65.2.dist-info/METADATA,sha256=4xKvPJLnx0MWstdTF5rFXHynPcmaWO5qff4b-JlMLJ0,5784
+cloudnetpy-1.65.2.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
+cloudnetpy-1.65.2.dist-info/top_level.txt,sha256=ibSPWRr6ojS1i11rtBFz2_gkIe68mggj7aeswYfaOo0,16
+cloudnetpy-1.65.2.dist-info/RECORD,,

{cloudnetpy-1.65.0.dist-info → cloudnetpy-1.65.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (73.0.0)
+Generator: setuptools (73.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any