cloudnetpy 1.74.4__py3-none-any.whl → 1.75.1__py3-none-any.whl

cloudnetpy/instruments/hatpro.py

@@ -4,6 +4,7 @@ import datetime
 import logging
 from collections import defaultdict
 from pathlib import Path
+from typing import Literal
 
 import netCDF4
 import numpy as np
@@ -17,7 +18,7 @@ from cloudnetpy import output, utils
 from cloudnetpy.cloudnetarray import CloudnetArray
 from cloudnetpy.exceptions import HatproDataError, ValidTimeStampError
 from cloudnetpy.instruments import rpg
-from cloudnetpy.instruments.instruments import HATPRO
+from cloudnetpy.instruments.instruments import HATPRO, LHATPRO, LHUMPRO_U90, Instrument
 from cloudnetpy.instruments.rpg_reader import (
     HatproBin,
     HatproBinCombined,
@@ -25,11 +26,19 @@ from cloudnetpy.instruments.rpg_reader import (
     HatproBinLwp,
 )
 
+IType = Literal["hatpro", "lhatpro", "lhumpro_u90"]
+ITYPE_MAP: dict[IType, Instrument] = {
+    "hatpro": HATPRO,
+    "lhatpro": LHATPRO,
+    "lhumpro_u90": LHUMPRO_U90,
+}
+
 
 def hatpro2l1c(
     mwr_dir: str,
     output_file: str,
     site_meta: dict,
+    instrument_type: IType = "hatpro",
     uuid: str | None = None,
     date: datetime.date | str | None = None,
 ) -> str:
@@ -39,6 +48,7 @@ def hatpro2l1c(
         mwr_dir: Folder containing one day of HATPRO files.
         output_file: Output file name.
         site_meta: Dictionary containing information about the site and instrument
+        instrument_type: Specific type of the RPG microwave radiometer.
         uuid: Set specific UUID for the file.
         date: Expected date in the input files.
 
@@ -55,6 +65,7 @@ def hatpro2l1c(
         hatpro_raw = lev1_to_nc(
             "1C01",
             mwr_dir,
+            instrument_type=instrument_type,
             output_file=output_file,
             coeff_files=coeff_files,
             instrument_config=site_meta,
@@ -64,7 +75,7 @@ def hatpro2l1c(
     except MissingInputData as err:
         raise HatproDataError(str(err)) from err
 
-    hatpro = HatproL1c(hatpro_raw, site_meta)
+    hatpro = HatproL1c(hatpro_raw, site_meta, ITYPE_MAP[instrument_type])
 
     flags = hatpro.data["quality_flag"][:]
     bad_percentage = ma.sum(flags != 0) / flags.size * 100
@@ -123,18 +134,19 @@ def hatpro2l1c(
 
 
 class HatproL1c:
-    def __init__(self, hatpro, site_meta: dict):
+    def __init__(self, hatpro, site_meta: dict, instrument: Instrument):
         self.raw_data = hatpro.raw_data
         self.data = hatpro.data
         self.date = hatpro.date.isoformat().split("-")
         self.site_meta = site_meta
-        self.instrument = HATPRO
+        self.instrument = instrument
 
 
 def hatpro2nc(
     path_to_files: str,
     output_file: str,
     site_meta: dict,
+    instrument_type: IType = "hatpro",
     uuid: str | None = None,
     date: str | None = None,
 ) -> tuple[str, list]:
@@ -154,6 +166,7 @@ def hatpro2nc(
             - `latitude` (optional).
             - `longitude` (optional).
 
+        instrument_type: Specific type of the RPG microwave radiometer.
         uuid: Set specific UUID for the file.
         date: Expected date in the input files. If not set,
             all files will be used. This might cause unexpected behavior if
@@ -183,7 +196,7 @@ def hatpro2nc(
     if is_iwv_files:
         _add_missing_variables(hatpro_objects, ("lwp", "iwv"))
     one_day_of_data = rpg.create_one_day_data_record(hatpro_objects)
-    hatpro = rpg.Hatpro(one_day_of_data, site_meta)
+    hatpro = rpg.Hatpro(one_day_of_data, site_meta, ITYPE_MAP[instrument_type])
     hatpro.add_site_geolocation()
     hatpro.convert_time_to_fraction_hour("float64")
     hatpro.sort_timestamps()

cloudnetpy/instruments/instruments.py

@@ -137,6 +137,20 @@ HATPRO = Instrument(
     model="HATPRO",
 )
 
+LHATPRO = Instrument(
+    manufacturer="RPG-Radiometer Physics",
+    domain="mwr",
+    category="microwave radiometer",
+    model="LHATPRO",
+)
+
+LHUMPRO_U90 = Instrument(
+    manufacturer="RPG-Radiometer Physics",
+    domain="mwr",
+    category="microwave radiometer",
+    model="LHUMPRO-U90",
+)
+
 RADIOMETRICS = Instrument(
     manufacturer="Radiometrics",
     domain="mwr",

cloudnetpy/instruments/mira.py

@@ -247,15 +247,15 @@ def _get_keymap(filetype: str) -> dict:
     keymaps = {
         "znc": OrderedDict(
             [
-                ("Zg", "Zh"),
+                ("Zg", "Zh"),  # fallback
                 ("Zh2l", "Zh"),
-                ("VELg", "v"),
+                ("VELg", "v"),  # fallback
                 ("VELh2l", "v"),
-                ("RMSg", "width"),
+                ("RMSg", "width"),  # fallback
                 ("RMSh2l", "width"),
-                ("LDRg", "ldr"),
+                ("LDRg", "ldr"),  # fallback
                 ("LDRh2l", "ldr"),
-                ("SNRg", "SNR"),
+                ("SNRg", "SNR"),  # fallback
                 ("SNRh2l", "SNR"),
                 ("elv", "elevation"),
                 ("azi", "azimuth_angle"),
@@ -265,20 +265,23 @@ def _get_keymap(filetype: str) -> dict:
                 ("rg0", "rg0"),
             ],
         ),
-        "mmclx": {
-            "Zg": "Zh",
-            "VELg": "v",
-            "RMSg": "width",
-            "LDRg": "ldr",
-            "SNRg": "SNR",
-            "elv": "elevation",
-            "azi": "azimuth_angle",
-            "nfft": "nfft",
-            "nave": "nave",
-            "prf": "prf",
-            "rg0": "rg0",
-            "NyquistVelocity": "NyquistVelocity",  # variable in some mmclx files
-        },
+        "mmclx": OrderedDict(
+            [
+                ("Ze", "Zh"),  # fallback for old mmclx files
+                ("Zg", "Zh"),
+                ("VELg", "v"),
+                ("RMSg", "width"),
+                ("LDRg", "ldr"),
+                ("SNRg", "SNR"),
+                ("elv", "elevation"),
+                ("azi", "azimuth_angle"),
+                ("nfft", "nfft"),
+                ("nave", "nave"),
+                ("prf", "prf"),
+                ("rg0", "rg0"),
+                ("NyquistVelocity", "NyquistVelocity"),  # variable in some mmclx files
+            ]
+        ),
     }
 
     return keymaps.get(filetype.lower(), keymaps["mmclx"])

cloudnetpy/instruments/rpg.py

@@ -3,7 +3,6 @@
 import logging
 import math
 from collections.abc import Sequence
-from typing import TYPE_CHECKING
 
 import numpy as np
 from numpy import ma
@@ -15,12 +14,10 @@ from cloudnetpy.constants import G_TO_KG, HPA_TO_PA, KM_H_TO_M_S, MM_H_TO_M_S
 from cloudnetpy.exceptions import InconsistentDataError, ValidTimeStampError
 from cloudnetpy.instruments import instruments
 from cloudnetpy.instruments.cloudnet_instrument import CloudnetInstrument
+from cloudnetpy.instruments.instruments import Instrument
 from cloudnetpy.instruments.rpg_reader import Fmcw94Bin, HatproBinCombined
 from cloudnetpy.metadata import MetaData
 
-if TYPE_CHECKING:
-    from cloudnetpy.instruments.instruments import Instrument
-
 
 def rpg2nc(
     path_to_l1_files: str,
@@ -331,9 +328,9 @@ class Fmcw(Rpg):
 class Hatpro(Rpg):
     """Class for RPG HATPRO mwr."""
 
-    def __init__(self, raw_data: dict, site_properties: dict):
+    def __init__(self, raw_data: dict, site_properties: dict, instrument: Instrument):
         super().__init__(raw_data, site_properties)
-        self.instrument = instruments.HATPRO
+        self.instrument = instrument
 
 
 def _filter_zenith_angle(zenith: ma.MaskedArray) -> np.ndarray:

cloudnetpy/products/__init__.py

@@ -4,4 +4,4 @@ from .drizzle import generate_drizzle
 from .ier import generate_ier
 from .iwc import generate_iwc
 from .lwc import generate_lwc
-from .mwr_tools import generate_mwr_multi, generate_mwr_single
+from .mwr_tools import generate_mwr_lhumpro, generate_mwr_multi, generate_mwr_single

cloudnetpy/products/mwr_tools.py

@@ -1,10 +1,11 @@
 import os
 import tempfile
-from typing import Literal
+from typing import TYPE_CHECKING, Literal
 
 import netCDF4
 import numpy as np
 import requests
+from mwrpy.level2.lev2_collocated import generate_lev2_lhumpro as gen_lhumpro
 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
@@ -13,6 +14,9 @@ from mwrpy.version import __version__ as mwrpy_version
 from cloudnetpy import output, utils
 from cloudnetpy.exceptions import ValidTimeStampError
 
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
 
 def generate_mwr_single(
     mwr_l1c_file: str, output_file: str, uuid: str | None = None
@@ -34,6 +38,26 @@ def generate_mwr_single(
     return _generate_product(mwr_l1c_file, output_file, uuid, "single")
 
 
+def generate_mwr_lhumpro(
+    mwr_l1c_file: str, output_file: str, uuid: str | None = None
+) -> str:
+    """Generates LHUMPRO single-pointing product including liquid water path, integrated
+    water vapor, etc. from zenith measurements.
+
+    Args:
+        mwr_l1c_file: The Level 1C MWR file to be processed.
+        output_file: The file path where the output file should be saved.
+        uuid: The UUID, if any, associated with the output file. Defaults to None.
+
+    Returns:
+        UUID of generated file.
+
+    Example:
+        >>> generate_mwr_lhumpro('input_mwr_l1c_file', 'output_file', 'abcdefg1234567')
+    """
+    return _generate_product(mwr_l1c_file, output_file, uuid, "lhumpro")
+
+
 def generate_mwr_multi(
     mwr_l1c_file: str, output_file: str, uuid: str | None = None
 ) -> str:
@@ -56,9 +80,19 @@ def _generate_product(
     mwr_l1c_file: str,
     output_file: str,
     uuid: str | None,
-    product: Literal["multi", "single"],
+    product: Literal["multi", "single", "lhumpro"],
 ) -> str:
-    fun = gen_multi if product == "multi" else gen_single
+    fun: Callable
+    if product == "multi":
+        fun = gen_multi
+    elif product == "single":
+        fun = gen_single
+    elif product == "lhumpro":
+        fun = gen_lhumpro
+        product = "single"
+    else:
+        msg = f"Invalid product: {product}"
+        raise ValueError(msg)
     with tempfile.TemporaryDirectory() as temp_dir:
         coeffs = _read_mwrpy_coeffs(mwr_l1c_file, temp_dir)
         try:

cloudnetpy/utils.py

@@ -965,7 +965,8 @@ def get_files_with_common_range(filenames: list) -> list:
         with netCDF4.Dataset(file) as nc:
             n_range.append(len(nc.variables["range"]))
     most_common = np.bincount(n_range).argmax()
-    if n_removed := len(filenames) - n_range.count(int(most_common)) > 0:
+    n_removed = len(filenames) - n_range.count(int(most_common))
+    if n_removed > 0:
         logging.warning(
             "Removing %s files due to inconsistent height vector", n_removed
         )

cloudnetpy/version.py

@@ -1,4 +1,4 @@
 MAJOR = 1
-MINOR = 74
-PATCH = 4
+MINOR = 75
+PATCH = 1
 __version__ = f"{MAJOR}.{MINOR}.{PATCH}"

{cloudnetpy-1.74.4.dist-info → cloudnetpy-1.75.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudnetpy
-Version: 1.74.4
+Version: 1.75.1
 Summary: Python package for Cloudnet processing
 Author: Simo Tukiainen
 License: MIT License
@@ -41,7 +41,7 @@ License-File: LICENSE
 Requires-Dist: ceilopyter
 Requires-Dist: doppy>=0.5.0
 Requires-Dist: matplotlib
-Requires-Dist: mwrpy>=1.2.0
+Requires-Dist: mwrpy>=1.3.0
 Requires-Dist: netCDF4
 Requires-Dist: requests
 Requires-Dist: rpgpy>=0.14.5

{cloudnetpy-1.74.4.dist-info → cloudnetpy-1.75.1.dist-info}/RECORD

@@ -8,8 +8,8 @@ cloudnetpy/exceptions.py,sha256=hYbUtBwjCIfxnPe_5mELDEw87AWITBrwuo7WYIEKmJ8,1579
 cloudnetpy/metadata.py,sha256=lO7BCbVAzFoH3Nq-VuezYX0f7MnbG1Zp11g5GSiuQwM,6189
 cloudnetpy/output.py,sha256=l0LoOhcGCBrg2EJ4NT1xZ7-UKWdV7X7yQ0fJmhkwJVc,15829
 cloudnetpy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cloudnetpy/utils.py,sha256=mzibw-RiC4e6rJGeJUf3RR_j-LmmcwqejzbacmXCmZA,33460
-cloudnetpy/version.py,sha256=y9RgCPl0qtP9IUebjQy1PGFXDnttvhLWaPkMwq2OnFU,72
+cloudnetpy/utils.py,sha256=SSZWk82c4nkAiTcLdOKGVvxt5ovETdAMn_TLxVeYpBY,33473
+cloudnetpy/version.py,sha256=tMFs6L1VKyLJzgBVt3-cNkUiP4Yz4Ld_Cu8UkEL_7U4,72
 cloudnetpy/categorize/__init__.py,sha256=s-SJaysvVpVVo5kidiruWQO6p3gv2TXwY1wEHYO5D6I,44
 cloudnetpy/categorize/atmos_utils.py,sha256=RcmbKxm2COkE7WEya0mK3yX5rzUbrewRVh3ekm01RtM,10598
 cloudnetpy/categorize/attenuation.py,sha256=Y_-fzmQTltWTqIZTulJhovC7a6ifpMcaAazDJcnMIOc,990
@@ -41,17 +41,17 @@ cloudnetpy/instruments/cl61d.py,sha256=g6DNBFju3wYhLFl32DKmC8pUup7y-EupXoUU0fuoG
 cloudnetpy/instruments/cloudnet_instrument.py,sha256=3qJe8STIvsU8irj79xuElFUZa0jUsSSg2lq7Ozo1om4,4401
 cloudnetpy/instruments/copernicus.py,sha256=99idcn6-iKOSvSslNjwFRng3gwlTLFjKPiT1tnVytpQ,6613
 cloudnetpy/instruments/galileo.py,sha256=BjWE15_S3tTCOmAM5k--oicI3wghKaO0hv9EUBxtbl8,4830
-cloudnetpy/instruments/hatpro.py,sha256=D1iTR58ao6zA556LegPDhh4JHozxiup_9mUuLjR0NzE,9006
-cloudnetpy/instruments/instruments.py,sha256=BdtUBvBUpjIyXubirHkP1Xa9mtlF8CgPEnFPokJgyrQ,4408
+cloudnetpy/instruments/hatpro.py,sha256=G1fHsY9LTos4vHP5kFubjE5Wg2uTVFZpYDSD8VAo-zw,9590
+cloudnetpy/instruments/instruments.py,sha256=hdELBl4zw9gZghXLjmUBmC_XnyGvNuOyaYZzSl9M17k,4704
 cloudnetpy/instruments/lufft.py,sha256=nIoEKuuFGKq2dLqkX7zW-HpAifefG472tZhKfXE1yoA,4212
-cloudnetpy/instruments/mira.py,sha256=Wofp8HbiAwJce_IbOLjpEFV07H_Kh4170C9Wygiz-ew,11401
+cloudnetpy/instruments/mira.py,sha256=IH88dnV5fdAQ-A04S23ROgNmT4GBAtzXQxCr_9fWj-Q,11634
 cloudnetpy/instruments/mrr.py,sha256=eeAzCp3CiHGauywjwvMUAFwZ4vBOZMcd3IlF8KsrLQo,5711
 cloudnetpy/instruments/nc_lidar.py,sha256=5gQG9PApnNPrHmS9_zanl8HEYIQuGRpbnzC3wfTcOyQ,1705
 cloudnetpy/instruments/nc_radar.py,sha256=HlaZeH5939R86ukF8K-P4Kfzb5-CpLB15LU2u94C5eI,7330
 cloudnetpy/instruments/pollyxt.py,sha256=U3g-ttmcs02LuLwVOydP3GjeNcmDyoYQroB-leIGdHY,10060
 cloudnetpy/instruments/radiometrics.py,sha256=ySG4a042XkgjMTG8d20oAPNvFvw9bMwwiqS3zv-JF_w,11825
 cloudnetpy/instruments/rain_e_h3.py,sha256=9TdpP4UzMBNIt2iE2GL6K9dFldzTHPLOrU8Q3tcosCU,5317
-cloudnetpy/instruments/rpg.py,sha256=gjvDomyoqSaeS3-X4EuesvWBp32BNoD-CeuvBOP19AI,17359
+cloudnetpy/instruments/rpg.py,sha256=m3-xLJ-w2T7Ip7jBveWsGrts4tmNvdc-Lb4HebvHQjQ,17319
 cloudnetpy/instruments/rpg_reader.py,sha256=ThztFuVrWxhmWVAfZTfQDeUiKK1XMTbtv08IBe8GK98,11364
 cloudnetpy/instruments/toa5.py,sha256=CfmmBMv5iMGaWHIGBK01Rw24cuXC1R1RMNTXkmsm340,1760
 cloudnetpy/instruments/vaisala.py,sha256=RKAw_fVry4YOUF0i2_-2jLIc6_H85oL8USA4ji9rh0o,4583
@@ -103,7 +103,7 @@ cloudnetpy/model_evaluation/tests/unit/test_tools.py,sha256=Ia_VrLdV2NstX5gbx_3A
 cloudnetpy/plotting/__init__.py,sha256=lg9Smn4BI0dVBgnDLC3JVJ4GmwoSnO-qoSd4ApvwV6Y,107
 cloudnetpy/plotting/plot_meta.py,sha256=qfyZJNis937uM-NJseer8i4FO7I_v5jhQPyFl5Uszi8,17390
 cloudnetpy/plotting/plotting.py,sha256=ghdR-DW0N4wMju20LM0sNCPXkueR1WpsimQfiA-eQQQ,38422
-cloudnetpy/products/__init__.py,sha256=2hRb5HG9hNrxH1if5laJkLeFeaZCd5W1q3hh4ewsX0E,273
+cloudnetpy/products/__init__.py,sha256=cBJdJBYltz5ZTKDqnRo-0StytAZK8gE3RYxxriFA4ak,295
 cloudnetpy/products/classification.py,sha256=KwAiBSgFwDqhM114NIgYiUjj8HoYc7gAlc8E1QgcSig,8207
 cloudnetpy/products/der.py,sha256=soypE7uSEP4uHUCCQVEhyXsKY6e9mzV9B_2S5GUizqk,12729
 cloudnetpy/products/drizzle.py,sha256=58C9Mo6oRXR8KpbVPghbJvHvFX9GfS3xUp058pbf0qw,10804
@@ -114,12 +114,12 @@ cloudnetpy/products/ier.py,sha256=XW4gg_H-JWMWKToMqLVl6v8kx1S65GBwclWDCn1EfSk,59
 cloudnetpy/products/iwc.py,sha256=WcPdAZx3zW0zaNJNp2vpAD4JnG0NJjFmCUAhDWzNxMg,9459
 cloudnetpy/products/lwc.py,sha256=sl6Al2tuH3KkCBrPbWTmuz3jlD5UQJ4D6qBsn1tt2CQ,18962
 cloudnetpy/products/mie_lu_tables.nc,sha256=It4fYpqJXlqOgL8jeZ-PxGzP08PMrELIDVe55y9ob58,16637951
-cloudnetpy/products/mwr_tools.py,sha256=1SRaQRW6-1svfnUk25sMyWXSwRJ1fg7v48TsMENZQpg,5103
+cloudnetpy/products/mwr_tools.py,sha256=8HPZpQMTojKZP1JS1S83IE0sxmbDE9bxlaWoqmGnUZE,6199
 cloudnetpy/products/product_tools.py,sha256=uu4l6reuGbPcW3TgttbaSrqIKbyYGhBVTdnC7opKvmg,11101
-cloudnetpy-1.74.4.dist-info/licenses/LICENSE,sha256=wcZF72bdaoG9XugpyE95Juo7lBQOwLuTKBOhhtANZMM,1094
+cloudnetpy-1.75.1.dist-info/licenses/LICENSE,sha256=wcZF72bdaoG9XugpyE95Juo7lBQOwLuTKBOhhtANZMM,1094
 docs/source/conf.py,sha256=IKiFWw6xhUd8NrCg0q7l596Ck1d61XWeVjIFHVSG9Og,1490
-cloudnetpy-1.74.4.dist-info/METADATA,sha256=5Ok-P4mHlXu-sIxwnh_tSlGyV5wQ2odutXvGOka3tio,5796
-cloudnetpy-1.74.4.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
-cloudnetpy-1.74.4.dist-info/entry_points.txt,sha256=HhY7LwCFk4qFgDlXx_Fy983ZTd831WlhtdPIzV-Y3dY,51
-cloudnetpy-1.74.4.dist-info/top_level.txt,sha256=ibSPWRr6ojS1i11rtBFz2_gkIe68mggj7aeswYfaOo0,16
-cloudnetpy-1.74.4.dist-info/RECORD,,
+cloudnetpy-1.75.1.dist-info/METADATA,sha256=E9p1xLzJFAIa_z2emwjuzlVEHuWB1YiYuY1z9pn1ZR4,5796
+cloudnetpy-1.75.1.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+cloudnetpy-1.75.1.dist-info/entry_points.txt,sha256=HhY7LwCFk4qFgDlXx_Fy983ZTd831WlhtdPIzV-Y3dY,51
+cloudnetpy-1.75.1.dist-info/top_level.txt,sha256=ibSPWRr6ojS1i11rtBFz2_gkIe68mggj7aeswYfaOo0,16
+cloudnetpy-1.75.1.dist-info/RECORD,,

{cloudnetpy-1.74.4.dist-info → cloudnetpy-1.75.1.dist-info}/WHEEL

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