cloudnetpy 1.67.8__py3-none-any.whl → 1.68.0__py3-none-any.whl

cloudnetpy/instruments/__init__.py

@@ -9,5 +9,6 @@ from .mira import mira2nc
 from .mrr import mrr2nc
 from .pollyxt import pollyxt2nc
 from .radiometrics import radiometrics2nc
+from .rain_e_h3 import rain_e_h32nc
 from .rpg import rpg2nc
 from .weather_station import ws2nc

cloudnetpy/instruments/cloudnet_instrument.py

@@ -112,3 +112,34 @@ class CloudnetInstrument:
         if np.isnan(zenith_angle) or zenith_angle is ma.masked:
             return None
         return zenith_angle
+
+
+class CSVFile(CloudnetInstrument):
+    def __init__(self, site_meta: dict):
+        super().__init__()
+        self.site_meta = site_meta
+        self._data: dict = {}
+
+    def add_date(self) -> None:
+        dt = self._data["time"][0]
+        self.date = dt.strftime("%Y %m %d").split()
+
+    def add_data(self) -> None:
+        for key, value in self._data.items():
+            parsed = (
+                utils.datetime2decimal_hours(value)
+                if key == "time"
+                else ma.array(value)
+            )
+            self.data[key] = CloudnetArray(parsed, key)
+
+    def normalize_rainfall_amount(self) -> None:
+        if "rainfall_amount" in self.data:
+            amount = self.data["rainfall_amount"][:]
+            offset = 0
+            for i in range(1, len(amount)):
+                if amount[i] + offset < amount[i - 1]:
+                    offset += amount[i - 1]
+                amount[i] += offset
+            amount -= amount[0]
+            self.data["rainfall_amount"].data = amount

cloudnetpy/instruments/rain_e_h3.py

@@ -0,0 +1,166 @@
+import csv
+import datetime
+from os import PathLike
+
+import numpy as np
+
+from cloudnetpy import output
+from cloudnetpy.exceptions import ValidTimeStampError
+from cloudnetpy.instruments import instruments
+from cloudnetpy.instruments.cloudnet_instrument import CSVFile
+
+
+def rain_e_h32nc(
+    input_file: str | PathLike,
+    output_file: str,
+    site_meta: dict,
+    uuid: str | None = None,
+    date: str | datetime.date | None = None,
+):
+    """Converts rain_e_h3 rain-gauge into Cloudnet Level 1b netCDF file.
+
+    Args:
+        input_file: Filename of rain_e_h3 CSV file.
+        output_file: Output filename.
+        site_meta: Dictionary containing information about the site. Required key
+            is `name`.
+        uuid: Set specific UUID for the file.
+        date: Expected date of the measurements as YYYY-MM-DD or datetime.date object.
+
+    Returns:
+        UUID of the generated file.
+
+    Raises:
+        WeatherStationDataError : Unable to read the file.
+        ValidTimeStampError: No valid timestamps found.
+    """
+    rain = RainEH3(site_meta)
+    if isinstance(date, str):
+        date = datetime.date.fromisoformat(date)
+    rain.parse_input_file(input_file, date)
+    rain.add_data()
+    rain.add_date()
+    rain.convert_units()
+    rain.normalize_rainfall_amount()
+    rain.add_site_geolocation()
+    attributes = output.add_time_attribute({}, rain.date)
+    output.update_attributes(rain.data, attributes)
+    return output.save_level1b(rain, output_file, uuid)
+
+
+class RainEH3(CSVFile):
+    def __init__(self, site_meta: dict):
+        super().__init__(site_meta)
+        self.instrument = instruments.RAIN_E_H3
+        self._data = {
+            "time": [],
+            "rainfall_rate": [],
+            "rainfall_amount": [],
+        }
+
+    def parse_input_file(
+        self, filepath: str | PathLike, date: datetime.date | None = None
+    ) -> None:
+        with open(filepath, encoding="latin1") as f:
+            data = list(csv.reader(f, delimiter=";"))
+        n_values = np.median([len(row) for row in data]).astype(int)
+
+        if n_values == 22:
+            self._read_talker_protocol_22_columns(data, date)
+        elif n_values == 16:
+            self._read_talker_protocol_16_columns(data, date)
+        else:
+            msg = "Only talker protocol with 16 or 22 columns is supported."
+            raise NotImplementedError(msg)
+
+    def _read_talker_protocol_16_columns(
+        self, data: list, date: datetime.date | None = None
+    ) -> None:
+        """Old Lindenberg data format.
+
+        0  date  DD.MM.YYYY
+        1  time
+        2  precipitation intensity in mm/h
+        3  precipitation accumulation in mm
+        4  housing contact
+        5  top temperature
+        6  bottom temperature
+        7  heater status
+        8  error code
+        9  system status
+        10 talker interval in seconds
+        11 operating hours
+        12 device type
+        13 user data storage 1
+        14 user data storage 2
+        15 user data storage 3
+
+        """
+        for row in data:
+            if len(row) != 16:
+                continue
+            try:
+                dt = datetime.datetime.strptime(
+                    f"{row[0]} {row[1]}", "%d.%m.%Y %H:%M:%S"
+                )
+            except ValueError:
+                continue
+            if date and date != dt.date():
+                continue
+            self._data["time"].append(dt)
+            self._data["rainfall_rate"].append(float(row[2]))
+            self._data["rainfall_amount"].append(float(row[3]))
+        if not self._data["time"]:
+            raise ValidTimeStampError
+
+    def _read_talker_protocol_22_columns(
+        self, data: list, date: datetime.date | None = None
+    ) -> None:
+        """Columns according to header in Lindenberg data.
+
+        0  datetime utc
+        1  date
+        2  time
+        3  precipitation intensity in mm/h
+        4  precipitation accumulation in mm
+        5  housing contact
+        6  top temperature
+        7  bottom temperature
+        8  heater status
+        9  error code
+        10 system status
+        11 talker interval in seconds
+        12 operating hours
+        13 device type
+        14 user data storage 1
+        15 user data storage 2
+        16 user data storage 3
+        17 user data storage 4
+        18 serial number
+        19 hardware version
+        20 firmware version
+        21 external temperature * checksum
+
+        """
+        for row in data:
+            if len(row) != 22:
+                continue
+            try:
+                dt = datetime.datetime.strptime(f"{row[0]}", "%Y-%m-%d %H:%M:%S")
+            except ValueError:
+                continue
+            if date and date != dt.date():
+                continue
+            self._data["time"].append(dt)
+            self._data["rainfall_rate"].append(float(row[3]))
+            self._data["rainfall_amount"].append(float(row[4]))
+            self.serial_number = row[18]
+        if not self._data["time"]:
+            raise ValidTimeStampError
+
+    def convert_units(self) -> None:
+        rainfall_rate = self.data["rainfall_rate"][:]
+        self.data["rainfall_rate"].data = rainfall_rate / 3600 / 1000  # mm/h -> m/s
+        self.data["rainfall_amount"].data = (
+            self.data["rainfall_amount"][:] / 1000
+        )  # mm -> m

cloudnetpy/instruments/weather_station.py

@@ -12,7 +12,7 @@ from cloudnetpy.cloudnetarray import CloudnetArray
 from cloudnetpy.constants import HPA_TO_PA, MM_H_TO_M_S, SEC_IN_HOUR
 from cloudnetpy.exceptions import ValidTimeStampError, WeatherStationDataError
 from cloudnetpy.instruments import instruments
-from cloudnetpy.instruments.cloudnet_instrument import CloudnetInstrument
+from cloudnetpy.instruments.cloudnet_instrument import CSVFile
 from cloudnetpy.instruments.toa5 import read_toa5
 from cloudnetpy.utils import datetime2decimal_hours
 
@@ -79,28 +79,13 @@ def ws2nc(
     return output.save_level1b(ws, output_file, uuid)
 
 
-class WS(CloudnetInstrument):
+class WS(CSVFile):
     def __init__(self, site_meta: dict):
-        super().__init__()
-        self._data: dict
-        self.site_meta = site_meta
+        super().__init__(site_meta)
         self.instrument = instruments.GENERIC_WEATHER_STATION
 
     date: list[str]
 
-    def add_date(self) -> None:
-        first_date = self._data["time"][0].date()
-        self.date = [
-            str(first_date.year),
-            str(first_date.month).zfill(2),
-            str(first_date.day).zfill(2),
-        ]
-
-    def add_data(self) -> None:
-        for key, value in self._data.items():
-            parsed = datetime2decimal_hours(value) if key == "time" else ma.array(value)
-            self.data[key] = CloudnetArray(parsed, key)
-
     def calculate_rainfall_amount(self) -> None:
         if "rainfall_amount" in self.data:
             return
@@ -137,17 +122,6 @@ class WS(CloudnetInstrument):
     def convert_pressure(self) -> None:
         self.data["air_pressure"].data = self.data["air_pressure"][:] * HPA_TO_PA
 
-    def normalize_rainfall_amount(self) -> None:
-        if "rainfall_amount" in self.data:
-            amount = self.data["rainfall_amount"][:]
-            offset = 0
-            for i in range(1, len(amount)):
-                if amount[i] + offset < amount[i - 1]:
-                    offset += amount[i - 1]
-                amount[i] += offset
-            amount -= amount[0]
-            self.data["rainfall_amount"].data = amount
-
     def convert_time(self) -> None:
         pass
 

cloudnetpy/version.py

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

{cloudnetpy-1.67.8.dist-info → cloudnetpy-1.68.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: cloudnetpy
-Version: 1.67.8
+Version: 1.68.0
 Summary: Python package for Cloudnet processing
 Author: Simo Tukiainen
 License: MIT License

{cloudnetpy-1.67.8.dist-info → cloudnetpy-1.68.0.dist-info}/RECORD

@@ -9,7 +9,7 @@ cloudnetpy/metadata.py,sha256=gEHwqEMY9gfaqVxx2_CobLg3i5gFXAumXLwnnW4BqtU,5840
 cloudnetpy/output.py,sha256=lq4YSeMT_d-j4rlQkKm9KIZ8boupTBBBKV1eUawpmCI,15672
 cloudnetpy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cloudnetpy/utils.py,sha256=U0iMIKPiKLrLVAfs_u9pPuoWYW1RJHcM8dbLF9a4yIA,29796
-cloudnetpy/version.py,sha256=s7jW9g8DRO6lagW0MNY4yj9My3nwbtL_nz4PbfmcC0E,72
+cloudnetpy/version.py,sha256=pLcy0tJTzjkz7cIE9-iU77WdDdE6S-zJExkR0XtvzuQ,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
@@ -32,13 +32,13 @@ cloudnetpy/categorize/attenuations/gas_attenuation.py,sha256=emr-RCxQT0i2N8k6eBN
 cloudnetpy/categorize/attenuations/liquid_attenuation.py,sha256=0p0G79BPkw1itCXHMwbvkNHtJGBocJzow3gNHAirChI,3036
 cloudnetpy/categorize/attenuations/melting_attenuation.py,sha256=9c9xoZHtGUbjFYJxkVc3UUDHLDy0UbNUZ32ITtnsj5w,2333
 cloudnetpy/categorize/attenuations/rain_attenuation.py,sha256=qazJzRyXf9vbjJhh4yiFmABI4L57j5W_6YZ-6qjRiBI,2839
-cloudnetpy/instruments/__init__.py,sha256=0ffYMCJoqXfwYY8LUjhZowJ6X_pGyqJRXHTSy-9p2bA,434
+cloudnetpy/instruments/__init__.py,sha256=2vAdceXCNxZhTujhArLf4NjYOfUdkhLpGM-NQa_LXdg,470
 cloudnetpy/instruments/basta.py,sha256=_OTnySd36ktvxk_swWBzbv_H4AVGlkF_Ce3KtPGD1rE,3758
 cloudnetpy/instruments/campbell_scientific.py,sha256=2WHfBKQjtRSl0AqvtPeX7G8Hdi3Dn0WbvoAppFOMbA8,5270
 cloudnetpy/instruments/ceilo.py,sha256=xrI7iYNftKvGZf-3C_ESUNsu-QhXV43iWkDuKp3biZU,9552
 cloudnetpy/instruments/ceilometer.py,sha256=pdmLVljsuciyKpaGxWxJ_f1IrJK-UrkBC0lSeuirLlU,12095
 cloudnetpy/instruments/cl61d.py,sha256=g6DNBFju3wYhLFl32DKmC8pUup7y-EupXoUU0fuoGGA,1990
-cloudnetpy/instruments/cloudnet_instrument.py,sha256=NQZ_FMXh8iyzXYSCKQSpIdp0MZFAh7WqKE8mZRmVbF4,4164
+cloudnetpy/instruments/cloudnet_instrument.py,sha256=086GJ6Nfp7sK9ZK8UygJOn-aiVPreez674_gbrOZj4I,5183
 cloudnetpy/instruments/copernicus.py,sha256=he15ncH6SDCidBhr0BkOJc6Rg8cMvLWN0vGmpui6nGQ,6611
 cloudnetpy/instruments/galileo.py,sha256=qABO3IUdRpGFDgqKsN0Pl4TQ-CWHQz8s13PxnwdIUnU,4828
 cloudnetpy/instruments/hatpro.py,sha256=DzCWzTJxTc5BSOgoeyM8RjYkSXX6NDi3QXgKRp0uxlI,8759
@@ -50,11 +50,12 @@ cloudnetpy/instruments/nc_lidar.py,sha256=5gQG9PApnNPrHmS9_zanl8HEYIQuGRpbnzC3wf
 cloudnetpy/instruments/nc_radar.py,sha256=AjPn3mkq5a1mE7YzKtZnxX5suNju9NhUq-TDvs7T_uU,6911
 cloudnetpy/instruments/pollyxt.py,sha256=ra7sYQ_cmkC0T9TBYrMN6iiQEZimmWGdW9Ilv61JB-Q,10027
 cloudnetpy/instruments/radiometrics.py,sha256=ySG4a042XkgjMTG8d20oAPNvFvw9bMwwiqS3zv-JF_w,11825
+cloudnetpy/instruments/rain_e_h3.py,sha256=xZWYYuSHeMPGKMcp3jG6JTLsy5VGivUiXxf1qEzzzJw,5310
 cloudnetpy/instruments/rpg.py,sha256=vfs_eGahPOxFjOIBczNywRwtdutOsJpSNeXZm99SIOo,17438
 cloudnetpy/instruments/rpg_reader.py,sha256=ThztFuVrWxhmWVAfZTfQDeUiKK1XMTbtv08IBe8GK98,11364
 cloudnetpy/instruments/toa5.py,sha256=CfmmBMv5iMGaWHIGBK01Rw24cuXC1R1RMNTXkmsm340,1760
 cloudnetpy/instruments/vaisala.py,sha256=GGuA_v4S7kR9yApSr1-d0ETzNj4ehEZ7-pD1-AdPYRE,14662
-cloudnetpy/instruments/weather_station.py,sha256=bWPL5dvsxumc0-0JP81i-2c0oWy7_ds8VGOWsn8Qt3c,17982
+cloudnetpy/instruments/weather_station.py,sha256=x4IwG8loGD8FgAJgLAvRQyOy05glI6bI6sz5E7GByFo,17015
 cloudnetpy/instruments/disdrometer/__init__.py,sha256=lyjwttWvFvuwYxEkusoAvgRcbBmglmOp5HJOpXUqLWo,93
 cloudnetpy/instruments/disdrometer/common.py,sha256=g52iK2aNp3Z88kovUmGVpC54NZomPa9D871gzO0AmQ4,9267
 cloudnetpy/instruments/disdrometer/parsivel.py,sha256=HJZrEysQkx9MiIVPDV25CYHpXi_SjgZlgO-otoaKK34,25640
@@ -115,9 +116,9 @@ cloudnetpy/products/mie_lu_tables.nc,sha256=It4fYpqJXlqOgL8jeZ-PxGzP08PMrELIDVe5
 cloudnetpy/products/mwr_tools.py,sha256=rd7UC67O4fsIE5SaHVZ4qWvUJTj41ZGwgQWPwZzOM14,5377
 cloudnetpy/products/product_tools.py,sha256=uu4l6reuGbPcW3TgttbaSrqIKbyYGhBVTdnC7opKvmg,11101
 docs/source/conf.py,sha256=IKiFWw6xhUd8NrCg0q7l596Ck1d61XWeVjIFHVSG9Og,1490
-cloudnetpy-1.67.8.dist-info/LICENSE,sha256=wcZF72bdaoG9XugpyE95Juo7lBQOwLuTKBOhhtANZMM,1094
-cloudnetpy-1.67.8.dist-info/METADATA,sha256=X2Lrmxa0YYJBgmTNueXjTBbzGKieTL9CK6r5LSNSrVA,5793
-cloudnetpy-1.67.8.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-cloudnetpy-1.67.8.dist-info/entry_points.txt,sha256=HhY7LwCFk4qFgDlXx_Fy983ZTd831WlhtdPIzV-Y3dY,51
-cloudnetpy-1.67.8.dist-info/top_level.txt,sha256=ibSPWRr6ojS1i11rtBFz2_gkIe68mggj7aeswYfaOo0,16
-cloudnetpy-1.67.8.dist-info/RECORD,,
+cloudnetpy-1.68.0.dist-info/LICENSE,sha256=wcZF72bdaoG9XugpyE95Juo7lBQOwLuTKBOhhtANZMM,1094
+cloudnetpy-1.68.0.dist-info/METADATA,sha256=B6v8K31KoLzIshYnuy85fsc5CZRe-pytrv2RoFQRmPU,5793
+cloudnetpy-1.68.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+cloudnetpy-1.68.0.dist-info/entry_points.txt,sha256=HhY7LwCFk4qFgDlXx_Fy983ZTd831WlhtdPIzV-Y3dY,51
+cloudnetpy-1.68.0.dist-info/top_level.txt,sha256=ibSPWRr6ojS1i11rtBFz2_gkIe68mggj7aeswYfaOo0,16
+cloudnetpy-1.68.0.dist-info/RECORD,,