cloudnetpy 1.49.8__py3-none-any.whl → 1.50.0__py3-none-any.whl

cloudnetpy/instruments/campbell_scientific.py

@@ -0,0 +1,110 @@
+import logging
+import re
+from datetime import datetime
+
+import numpy as np
+
+from cloudnetpy import utils
+from cloudnetpy.exceptions import ValidTimeStampError
+from cloudnetpy.instruments import instruments
+from cloudnetpy.instruments.ceilometer import Ceilometer
+
+
+class Cs135(Ceilometer):
+    def __init__(
+        self, full_path: str, site_meta: dict, expected_date: str | None = None
+    ):
+        super().__init__()
+        self.full_path = full_path
+        self.site_meta = site_meta
+        self.expected_date = expected_date
+        self.data = {}
+        self.metadata = {}
+        self.instrument = instruments.CS135
+
+    def read_ceilometer_file(self, calibration_factor: float | None = None) -> None:
+        with open(self.full_path, mode="r", encoding="utf-8") as f:
+            lines = f.readlines()
+        timestamps, profiles, scales, tilt_angles = [], [], [], []
+        range_resolution, n_gates = 0, 0
+        for i, line in enumerate(lines):
+            line_splat = line.strip().split(",")
+            if is_timestamp(line_splat[0]):
+                timestamp = datetime.strptime(line_splat[0], "%Y-%m-%dT%H:%M:%S.%f")
+                try:
+                    self._check_timestamp(timestamp)
+                except ValidTimeStampError:
+                    continue
+                timestamps.append(timestamp)
+                _line1 = line_splat[1]
+                if len(_line1) != 11:
+                    raise NotImplementedError("Unknown message number")
+                if (msg_no := _line1[-4:-1]) != "002":
+                    raise NotImplementedError(
+                        f"Message number {msg_no} not implemented"
+                    )
+                _line3 = lines[i + 2].strip().split(" ")
+                scale, range_resolution, n_gates, tilt_angle = [
+                    int(_line3[ind]) for ind in [0, 1, 2, 5]
+                ]
+                scales.append(scale)
+                tilt_angles.append(tilt_angle)
+                _line4 = lines[i + 3].strip()
+                profiles.append(_hex2backscatter(_line4, n_gates))
+
+        if len(timestamps) == 0:
+            raise ValidTimeStampError("No valid timestamps found in the file")
+        array = self._handle_large_values(np.array(profiles))
+        self.data["beta_raw"] = _scale_backscatter(array, scales)
+        if calibration_factor is None:
+            calibration_factor = 1.0
+        self.data["beta_raw"] *= calibration_factor
+        self.data["calibration_factor"] = calibration_factor
+        self.data["range"] = (
+            np.arange(n_gates) * range_resolution + range_resolution / 2
+        )
+        self.data["time"] = utils.datetime2decimal_hours(timestamps)
+        self.data["zenith_angle"] = np.median(tilt_angles)
+
+    def _check_timestamp(self, timestamp: datetime):
+        timestamp_components = str(timestamp.date()).split("-")
+        if self.expected_date is not None:
+            if timestamp_components != self.expected_date.split("-"):
+                raise ValidTimeStampError
+        if not self.date:
+            self.date = timestamp_components
+        assert timestamp_components == self.date
+
+    @staticmethod
+    def _handle_large_values(array: np.ndarray) -> np.ndarray:
+        ind = np.where(array > 524287)
+        if ind[0].size > 0:
+            array[ind] -= 1048576
+        return array
+
+
+def is_timestamp(timestamp: str) -> bool:
+    """Tests if the input string is formatted as -yyyy-mm-dd hh:mm:ss"""
+    reg_exp = re.compile(r"\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}")
+    if reg_exp.match(timestamp) is not None:
+        return True
+    return False
+
+
+def _hex2backscatter(data: str, n_gates: int):
+    """Converts hex string to backscatter values."""
+    n_chars = 5
+    return [
+        int(data[i : i + n_chars], 16) for i in range(0, n_gates * n_chars, n_chars)
+    ]
+
+
+def _scale_backscatter(data: np.ndarray, scales: list) -> np.ndarray:
+    """Scales backscatter values."""
+    unit_conversion_factor = 1e-8
+    scales_array = np.array(scales)
+    ind = np.where(scales_array != 100)
+    if ind[0].size > 0:
+        logging.info(f"{ind[0].size} profiles have not 100% scaling")
+        data[ind, :] *= scales_array[ind] / 100
+    return data * unit_conversion_factor

cloudnetpy/instruments/ceilo.py

@@ -4,6 +4,7 @@ from itertools import islice
 import netCDF4
 
 from cloudnetpy import output
+from cloudnetpy.instruments.campbell_scientific import Cs135
 from cloudnetpy.instruments.cl61d import Cl61d
 from cloudnetpy.instruments.lufft import LufftCeilo
 from cloudnetpy.instruments.vaisala import ClCeilo, Ct25k
@@ -40,10 +41,11 @@ def ceilo2nc(
         output_file: Output file name, e.g. 'ceilo.nc'.
         site_meta: Dictionary containing information about the site and instrument.
             Required key value pairs are `name` and `altitude` (metres above mean
-            sea level).
-            Also 'calibration_factor' is recommended because the default value is
-            probably incorrect. If the backround noise is *not* range-corrected,
-            you must define: {'range_corrected': False}.
+            sea level). Also, 'calibration_factor' is recommended because the default
+            value is probably incorrect. If the backround noise is *not*
+            range-corrected, you must define: {'range_corrected': False}.
+            You can also explicitly set the instrument model with
+            e.g. {'model': 'cl61d'}.
         uuid: Set specific UUID for the file.
         date: Expected date as YYYY-MM-DD of all profiles in the file.
 
@@ -90,14 +92,31 @@ def ceilo2nc(
 
 def _initialize_ceilo(
     full_path: str, site_meta: dict, date: str | None = None
-) -> ClCeilo | Ct25k | LufftCeilo | Cl61d:
-    model = _find_ceilo_model(full_path)
+) -> ClCeilo | Ct25k | LufftCeilo | Cl61d | Cs135:
+    if "model" in site_meta:
+        if site_meta["model"] not in (
+            "cl31",
+            "cl51",
+            "cl61d",
+            "ct25k",
+            "chm15k",
+            "cs135",
+        ):
+            raise ValueError(f"Invalid ceilometer model: {site_meta['model']}")
+        if site_meta["model"] in ("cl31", "cl51"):
+            model = "cl31_or_cl51"
+        else:
+            model = site_meta["model"]
+    else:
+        model = _find_ceilo_model(full_path)
     if model == "cl31_or_cl51":
         return ClCeilo(full_path, site_meta, date)
     if model == "ct25k":
         return Ct25k(full_path, site_meta, date)
     if model == "cl61d":
         return Cl61d(full_path, site_meta, date)
+    if model == "cs135":
+        return Cs135(full_path, site_meta, date)
     return LufftCeilo(full_path, site_meta, date)
 
 

cloudnetpy/instruments/instruments.py

@@ -35,6 +35,14 @@ CL31 = Instrument(
     wavelength=910.0,
 )
 
+CS135 = Instrument(
+    manufacturer="Campbell Scientific",
+    domain="lidar",
+    category="ceilometer",
+    model="CS135",
+    wavelength=905.0,
+)
+
 CT25K = Instrument(
     manufacturer="Vaisala",
     domain="lidar",

cloudnetpy/version.py

@@ -1,4 +1,4 @@
 MAJOR = 1
-MINOR = 49
-PATCH = 8
+MINOR = 50
+PATCH = 0
 __version__ = f"{MAJOR}.{MINOR}.{PATCH}"

{cloudnetpy-1.49.8.dist-info → cloudnetpy-1.50.0.dist-info}/METADATA

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

{cloudnetpy-1.49.8.dist-info → cloudnetpy-1.50.0.dist-info}/RECORD

@@ -8,7 +8,7 @@ cloudnetpy/metadata.py,sha256=-oRmr4HWjG_-P8jOjdBYMgRkOYnJKr6jmGIF-38Tno8,5023
 cloudnetpy/output.py,sha256=6ysoCcrk_pS_fWhyQoJX29V403f7UOloFw0SZjHCwKk,14236
 cloudnetpy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cloudnetpy/utils.py,sha256=lKVPF7VpbX2IPXTztI8eJZm8rLne9IuhMngQXKP12vg,26971
-cloudnetpy/version.py,sha256=H8Z-e1lp7jMV7M-Dsgt0gAyPgaut-wn22FPaAKGj-PY,72
+cloudnetpy/version.py,sha256=f1gG8ukA8980EWUjCKF9qA8P9pYzoCtL8gGNb2eCEX0,72
 cloudnetpy/categorize/__init__.py,sha256=gP5q3Vis1y9u9OWgA_idlbjfWXYN_S0IBSWdwBhL_uU,69
 cloudnetpy/categorize/atmos.py,sha256=_8VU0UpzKh7ZFh3TbGs-g3SYMRsRIR5mio0PmP66O7o,12372
 cloudnetpy/categorize/atmos_utils.py,sha256=6WdfGqzOvnaDW7vlMMrZBJIxW_eHQdjH-Xl_iPv1TTI,3716
@@ -26,14 +26,15 @@ cloudnetpy/categorize/mwr.py,sha256=PSXf-OukhRLlQIpXtkKhcdgiy-fQy-X-CaVh_G42P9s,
 cloudnetpy/categorize/radar.py,sha256=3Or3_jWxs9rbwJ3XKzl4hPilg0bFdCRMrbkIAuS3H08,12425
 cloudnetpy/instruments/__init__.py,sha256=-MOKjKNu8PRciX_PXEBRihGVaKrPIc_2sR-n0D9NEkc,374
 cloudnetpy/instruments/basta.py,sha256=9KeP65uxOTUH1YavaI8sp35n-VcM-WgtqMfB3bxKSPo,3714
-cloudnetpy/instruments/ceilo.py,sha256=UouuG0cUf_iQQOwsWjX6PajkkmiUkiefnqjnmkh_8r4,7341
+cloudnetpy/instruments/campbell_scientific.py,sha256=HQMPLBMHUojNFnt4WV8cvGrNPfSvv_IUQVeVyC3KJyo,4237
+cloudnetpy/instruments/ceilo.py,sha256=_T_rbvy0kB6hol5iwNLtfFqYDM7g4ce9Mlt_Z1Vg2hU,8013
 cloudnetpy/instruments/ceilometer.py,sha256=j3Wb2wJlSGLaZkguPe3nv4751TfGd-hJjithKYNOsO4,10498
 cloudnetpy/instruments/cl61d.py,sha256=Qk2YQRrRkivc6nW2gOI7KKLt9rR4JAWF0bfbj8Hd_lY,1653
 cloudnetpy/instruments/cloudnet_instrument.py,sha256=nnaOtJJotXzYdoMoYGKeLZ1MciDYBx7tqVBFKBQjKL0,3304
 cloudnetpy/instruments/copernicus.py,sha256=FDS7Rsunp4ieTPFh_T_LXvreNi5_HTv4ZzR3OnTcAX8,5013
 cloudnetpy/instruments/galileo.py,sha256=F_XyoAb9PR-ifGhqhXziKnv0KfyOh-yEBaE1NgRMzNg,4318
 cloudnetpy/instruments/hatpro.py,sha256=H0FgTIxIp3fl59nrTS9z8NyRX7ugkR32B2N1uwEOWtQ,7438
-cloudnetpy/instruments/instruments.py,sha256=FGiN0369--1z8uYzgDP9_1A7DFLL_Cl4-Ca-OMsjBdI,2824
+cloudnetpy/instruments/instruments.py,sha256=x_YV4UG05lF-39Yr-K3h5OrxSqrsndpF1K-KM0VURI0,2975
 cloudnetpy/instruments/lufft.py,sha256=E2qzvya206gNiML7BSM6vm1lzeOMBePrIuPT81NHPvw,3397
 cloudnetpy/instruments/mira.py,sha256=5wmmJGYHVglxaCpSuL92WIisADRD-85k_jlsC9mKLgQ,5063
 cloudnetpy/instruments/nc_lidar.py,sha256=9FSsInEM8fdyyhgNXb2INBjb5OEGFE5ZaVSowHjzoCA,1386
@@ -105,8 +106,8 @@ cloudnetpy/products/mwr_multi.py,sha256=9dw5DqU9uae54SDk0Pjzp4EKtQrjo1DeP-Xx41NE
 cloudnetpy/products/mwr_single.py,sha256=tfUYvkVf_Hh1GcpBnjjE8T30EYzyYc07UuzGJCBME-8,2931
 cloudnetpy/products/product_tools.py,sha256=Gk5e4N1m071IIFT9dy9lUvcDICsMYx-pMEtcWTJ54nw,9739
 docs/source/conf.py,sha256=baQlgkkUGJi4952W6NRhLkIBbRtwFgqrIOBuEeSCLfk,1488
-cloudnetpy-1.49.8.dist-info/LICENSE,sha256=wcZF72bdaoG9XugpyE95Juo7lBQOwLuTKBOhhtANZMM,1094
-cloudnetpy-1.49.8.dist-info/METADATA,sha256=2r1KgQj196QOuyymMZ4ZXghE6kqw3cJSGn-2Y7yFutA,5759
-cloudnetpy-1.49.8.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-cloudnetpy-1.49.8.dist-info/top_level.txt,sha256=ibSPWRr6ojS1i11rtBFz2_gkIe68mggj7aeswYfaOo0,16
-cloudnetpy-1.49.8.dist-info/RECORD,,
+cloudnetpy-1.50.0.dist-info/LICENSE,sha256=wcZF72bdaoG9XugpyE95Juo7lBQOwLuTKBOhhtANZMM,1094
+cloudnetpy-1.50.0.dist-info/METADATA,sha256=mzFxNLsFFEPSD86rJ6RmgYmHdx9OA8zYONk3n_SL3h8,5759
+cloudnetpy-1.50.0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+cloudnetpy-1.50.0.dist-info/top_level.txt,sha256=ibSPWRr6ojS1i11rtBFz2_gkIe68mggj7aeswYfaOo0,16
+cloudnetpy-1.50.0.dist-info/RECORD,,