cloudnetpy 1.76.1__py3-none-any.whl → 1.77.0__py3-none-any.whl

cloudnetpy/instruments/__init__.py

@@ -3,6 +3,7 @@ from .bowtie import bowtie2nc
 from .ceilo import ceilo2nc
 from .copernicus import copernicus2nc
 from .disdrometer import parsivel2nc, thies2nc
+from .fd12p import fd12p2nc
 from .galileo import galileo2nc
 from .hatpro import hatpro2l1c, hatpro2nc
 from .instruments import Instrument

cloudnetpy/instruments/cloudnet_instrument.py

@@ -109,17 +109,22 @@ class CSVFile(CloudnetInstrument):
             parsed = (
                 utils.datetime2decimal_hours(value)
                 if key == "time"
-                else ma.array(value)
+                else ma.masked_invalid(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
+    def normalize_cumulative_amount(self, key: str) -> None:
+        if key not in self.data:
+            return
+        amount = self.data[key][:]
+        offset = 0
+        last_valid = 0
+        for i in range(1, len(amount)):
+            if amount[i] is ma.masked:
+                continue
+            if amount[i] + offset < amount[last_valid]:
+                offset += amount[last_valid]
+            amount[i] += offset
+            last_valid = i
+        amount -= amount[0]
+        self.data[key].data = amount

cloudnetpy/instruments/fd12p.py

@@ -0,0 +1,173 @@
+import datetime
+import math
+from os import PathLike
+from uuid import UUID
+
+import numpy as np
+from numpy import ma
+
+from cloudnetpy import output
+from cloudnetpy.exceptions import ValidTimeStampError
+from cloudnetpy.instruments import instruments
+from cloudnetpy.instruments.cloudnet_instrument import CSVFile
+from cloudnetpy.metadata import MetaData
+
+
+def fd12p2nc(
+    input_file: str | PathLike,
+    output_file: str | PathLike,
+    site_meta: dict,
+    uuid: str | UUID | None = None,
+    date: str | datetime.date | None = None,
+):
+    """Converts Vaisala FD12P into Cloudnet Level 1b netCDF file.
+
+    Args:
+        input_file: Filename of input 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:
+        ValidTimeStampError: No valid timestamps found.
+    """
+    if isinstance(date, str):
+        date = datetime.date.fromisoformat(date)
+    if isinstance(uuid, str):
+        uuid = UUID(uuid)
+    fd12p = FD12P(site_meta)
+    fd12p.parse_input_file(input_file, date)
+    fd12p.add_data()
+    fd12p.add_date()
+    fd12p.screen_all_masked()
+    fd12p.sort_timestamps()
+    fd12p.remove_duplicate_timestamps()
+    fd12p.convert_units()
+    fd12p.normalize_cumulative_amount("precipitation_amount")
+    fd12p.normalize_cumulative_amount("snowfall_amount")
+    fd12p.add_site_geolocation()
+    attributes = output.add_time_attribute(ATTRIBUTES, fd12p.date)
+    output.update_attributes(fd12p.data, attributes)
+    return output.save_level1b(fd12p, output_file, uuid)
+
+
+class FD12P(CSVFile):
+    def __init__(self, site_meta: dict):
+        super().__init__(site_meta)
+        self.instrument = instruments.FD12P
+        self._data = {
+            key: []
+            for key in (
+                "time",
+                "visibility",
+                "synop_WaWa",
+                "precipitation_rate",
+                "precipitation_amount",
+                "snowfall_amount",
+            )
+        }
+
+    def parse_input_file(
+        self, filename: str | PathLike, expected_date: datetime.date | None = None
+    ):
+        # In Lindenberg, format is date and time followed by Message 2 without
+        # non-printable characters.
+        with open(filename) as file:
+            for line in file:
+                columns = line.split()
+                date = _parse_date(columns[0])
+                time = _parse_time(columns[1])
+                self._data["time"].append(datetime.datetime.combine(date, time))
+                self._data["visibility"].append(_parse_int(columns[4]))
+                self._data["synop_WaWa"].append(_parse_int(columns[7]))
+                self._data["precipitation_rate"].append(
+                    _parse_float(columns[10])
+                )  # mm/h
+                self._data["precipitation_amount"].append(
+                    _parse_float(columns[11])
+                )  # mm
+                self._data["snowfall_amount"].append(_parse_int(columns[12]))  # mm
+        for key in ("visibility", "synop_WaWa", "snowfall_amount"):
+            values = np.array(
+                [0 if x is math.nan else x for x in self._data[key]], dtype=np.int32
+            )
+            mask = np.array([x is math.nan for x in self._data[key]])
+            self._data[key] = ma.array(values, mask=mask)
+        self._data["snowfall_amount"] = self._data["snowfall_amount"].astype(np.float32)
+        if expected_date:
+            self._data["time"] = [
+                d for d in self._data["time"] if d.date() == expected_date
+            ]
+        if not self._data["time"]:
+            raise ValidTimeStampError
+
+    def convert_units(self) -> None:
+        precipitation_rate = self.data["precipitation_rate"][:]
+        self.data["precipitation_rate"].data = (
+            precipitation_rate / 3600 / 1000
+        )  # mm/h -> m/s
+        for key in ("precipitation_amount", "snowfall_amount"):
+            self.data[key].data = self.data[key][:] / 1000  # mm -> m
+
+    def screen_all_masked(self) -> None:
+        is_valid = np.ones_like(self.data["time"][:], dtype=np.bool)
+        for key in self.data:
+            if key == "time":
+                continue
+            is_valid &= ma.getmaskarray(self.data[key][:])
+        self.screen_time_indices(~is_valid)
+
+
+def _parse_date(date: str) -> datetime.date:
+    day, month, year = map(int, date.split("."))
+    return datetime.date(year, month, day)
+
+
+def _parse_time(time: str) -> datetime.time:
+    hour, minute, *rest = [int(x) for x in time.split(":")]
+    second = rest[0] if rest else 0
+    return datetime.time(hour, minute, second)
+
+
+def _parse_int(value: str) -> float:
+    if "/" in value:
+        return math.nan
+    return int(value)
+
+
+def _parse_float(value: str) -> float:
+    if "/" in value:
+        return math.nan
+    return float(value)
+
+
+ATTRIBUTES = {
+    "visibility": MetaData(
+        long_name="Meteorological optical range (MOR) visibility",
+        units="m",
+        standard_name="visibility_in_air",
+    ),
+    "precipitation_rate": MetaData(
+        long_name="Precipitation rate",
+        standard_name="lwe_precipitation_rate",
+        units="m s-1",
+    ),
+    "precipitation_amount": MetaData(
+        long_name="Precipitation amount",
+        standard_name="lwe_thickness_of_precipitation_amount",
+        units="m",
+        comment="Cumulated precipitation since 00:00 UTC",
+    ),
+    "snowfall_amount": MetaData(
+        long_name="Snowfall amount",
+        units="m",
+        standard_name="thickness_of_snowfall_amount",
+        comment="Cumulated snow since 00:00 UTC",
+    ),
+    "synop_WaWa": MetaData(long_name="Synop code WaWa", units="1"),
+}

cloudnetpy/instruments/instruments.py

@@ -246,3 +246,10 @@ MRR_PRO = Instrument(
     model="MRR-PRO",
     frequency=24.23,
 )
+
+FD12P = Instrument(
+    manufacturer="Vaisala",
+    domain="weather-station",
+    category="present weather sensor",
+    model="FD12P",
+)

cloudnetpy/instruments/rain_e_h3.py

@@ -40,7 +40,7 @@ def rain_e_h32nc(
     rain.add_data()
     rain.add_date()
     rain.convert_units()
-    rain.normalize_rainfall_amount()
+    rain.normalize_cumulative_amount("rainfall_amount")
     rain.add_site_geolocation()
     rain.sort_timestamps()
     rain.remove_duplicate_timestamps()

cloudnetpy/instruments/weather_station.py

@@ -77,7 +77,7 @@ def ws2nc(
     ws.convert_pressure()
     ws.convert_rainfall_rate()
     ws.convert_rainfall_amount()
-    ws.normalize_rainfall_amount()
+    ws.normalize_cumulative_amount("rainfall_amount")
     ws.calculate_rainfall_amount()
     attributes = output.add_time_attribute({}, ws.date)
     output.update_attributes(ws.data, attributes)

cloudnetpy/plotting/plotting.py

@@ -361,9 +361,12 @@ class Plot:
         units_conversion = {
             "rainfall_rate": (multiply, 3600000, "mm h$^{-1}$"),
             "snowfall_rate": (multiply, 3600000, "mm h$^{-1}$"),
+            "precipitation_rate": (multiply, 3600000, "mm h$^{-1}$"),
             "air_pressure": (multiply, 0.01, "hPa"),
             "relative_humidity": (multiply, 100, "%"),
             "rainfall_amount": (multiply, 1000, "mm"),
+            "snowfall_amount": (multiply, 1000, "mm"),
+            "precipitation_amount": (multiply, 1000, "mm"),
             "air_temperature": (add, -273.15, "\u00b0C"),
             "r_accum_RT": (multiply, 1000, "mm"),
             "r_accum_NRT": (multiply, 1000, "mm"),

cloudnetpy/version.py

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

{cloudnetpy-1.76.1.dist-info → cloudnetpy-1.77.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudnetpy
-Version: 1.76.1
+Version: 1.77.0
 Summary: Python package for Cloudnet processing
 Author: Simo Tukiainen
 License: MIT License

{cloudnetpy-1.76.1.dist-info → cloudnetpy-1.77.0.dist-info}/RECORD

@@ -9,7 +9,7 @@ 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=SSZWk82c4nkAiTcLdOKGVvxt5ovETdAMn_TLxVeYpBY,33473
-cloudnetpy/version.py,sha256=h_CrP8sn9JN6-YKTFNNaJcVYnr_Y-PGPAYa6HOR0wGo,72
+cloudnetpy/version.py,sha256=2wWI0Vrxs-3sRV0GweamYgxmMxkoJvam_z0qRWpiarc,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,17 +32,18 @@ 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=sbJZBYWynZbGAWb8VMMaT5qXuCyzG1LwEdHhVxFXVMk,500
+cloudnetpy/instruments/__init__.py,sha256=PEgrrQNoiOuN_ctYilmt4LV2QCLg1likPjJdWtuGlLs,528
 cloudnetpy/instruments/basta.py,sha256=Lb_EhQTI93S5Bd9osDbCE_tC8gZreRsHz7D2_dFOjmE,3793
 cloudnetpy/instruments/bowtie.py,sha256=Hp4mzjGqvYw5bhgAy_LvScYrf3Xm3ULbtPjhG9GnAJ8,2977
 cloudnetpy/instruments/ceilo.py,sha256=qM3AkQKHUblhRCD42HsB6lr82giBH-0g_VzoWHZDgeA,9535
 cloudnetpy/instruments/ceilometer.py,sha256=ati9-fUQ54K9tvynIPB-nlBYwtvBVaQtUCjVCLNB67w,12059
 cloudnetpy/instruments/cl61d.py,sha256=g6DNBFju3wYhLFl32DKmC8pUup7y-EupXoUU0fuoGGA,1990
-cloudnetpy/instruments/cloudnet_instrument.py,sha256=3qJe8STIvsU8irj79xuElFUZa0jUsSSg2lq7Ozo1om4,4401
+cloudnetpy/instruments/cloudnet_instrument.py,sha256=SGPsRYYoGPoRoDY7hHJcKUVX0A23X0Telc00Fu01PnY,4495
 cloudnetpy/instruments/copernicus.py,sha256=99idcn6-iKOSvSslNjwFRng3gwlTLFjKPiT1tnVytpQ,6613
+cloudnetpy/instruments/fd12p.py,sha256=LNY_yYk9DshGkNJvGEhOsgDmfpHGZOFRRJAYkT_Qw0M,5868
 cloudnetpy/instruments/galileo.py,sha256=BjWE15_S3tTCOmAM5k--oicI3wghKaO0hv9EUBxtbl8,4830
 cloudnetpy/instruments/hatpro.py,sha256=G1fHsY9LTos4vHP5kFubjE5Wg2uTVFZpYDSD8VAo-zw,9590
-cloudnetpy/instruments/instruments.py,sha256=hdELBl4zw9gZghXLjmUBmC_XnyGvNuOyaYZzSl9M17k,4704
+cloudnetpy/instruments/instruments.py,sha256=z8Osjww3iQRxKvzXdISl-5vV6gShtji8Db5k-ZzDQ-0,4843
 cloudnetpy/instruments/lufft.py,sha256=nIoEKuuFGKq2dLqkX7zW-HpAifefG472tZhKfXE1yoA,4212
 cloudnetpy/instruments/mira.py,sha256=IH88dnV5fdAQ-A04S23ROgNmT4GBAtzXQxCr_9fWj-Q,11634
 cloudnetpy/instruments/mrr.py,sha256=eeAzCp3CiHGauywjwvMUAFwZ4vBOZMcd3IlF8KsrLQo,5711
@@ -50,12 +51,12 @@ cloudnetpy/instruments/nc_lidar.py,sha256=5gQG9PApnNPrHmS9_zanl8HEYIQuGRpbnzC3wf
 cloudnetpy/instruments/nc_radar.py,sha256=HlaZeH5939R86ukF8K-P4Kfzb5-CpLB15LU2u94C5eI,7330
 cloudnetpy/instruments/pollyxt.py,sha256=U3g-ttmcs02LuLwVOydP3GjeNcmDyoYQroB-leIGdHY,10060
 cloudnetpy/instruments/radiometrics.py,sha256=_ZBHYiw3u4m0UDPaYRHnx-ofq2FS59Vdv3-fLiOzm9I,15471
-cloudnetpy/instruments/rain_e_h3.py,sha256=9TdpP4UzMBNIt2iE2GL6K9dFldzTHPLOrU8Q3tcosCU,5317
+cloudnetpy/instruments/rain_e_h3.py,sha256=JEg4Ko7ZdfjAUJwJ1BWdTkm4K7r3s8WKrPb-HidTqpg,5336
 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
-cloudnetpy/instruments/weather_station.py,sha256=Ok2i4RUkbEHdOuXuDPkMPSRp_vAiST7SQeg2amIavyI,24530
+cloudnetpy/instruments/weather_station.py,sha256=pZK7I5bk1USDRoTeIhZoWzbka9ciea5ypA3oIzZX-7g,24549
 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
@@ -102,7 +103,7 @@ cloudnetpy/model_evaluation/tests/unit/test_statistical_methods.py,sha256=Ra3r4V
 cloudnetpy/model_evaluation/tests/unit/test_tools.py,sha256=Ia_VrLdV2NstX5gbx_3AZTOAlrgLAy_xFZ8fHYVX0xI,3817
 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/plotting/plotting.py,sha256=nMdrXg7WEUUAHFQ0-_kxlETuXYd17-mzYNXbbsE0nVU,38607
 cloudnetpy/products/__init__.py,sha256=cBJdJBYltz5ZTKDqnRo-0StytAZK8gE3RYxxriFA4ak,295
 cloudnetpy/products/classification.py,sha256=KwAiBSgFwDqhM114NIgYiUjj8HoYc7gAlc8E1QgcSig,8207
 cloudnetpy/products/der.py,sha256=soypE7uSEP4uHUCCQVEhyXsKY6e9mzV9B_2S5GUizqk,12729
@@ -116,10 +117,10 @@ cloudnetpy/products/lwc.py,sha256=sl6Al2tuH3KkCBrPbWTmuz3jlD5UQJ4D6qBsn1tt2CQ,18
 cloudnetpy/products/mie_lu_tables.nc,sha256=It4fYpqJXlqOgL8jeZ-PxGzP08PMrELIDVe55y9ob58,16637951
 cloudnetpy/products/mwr_tools.py,sha256=8HPZpQMTojKZP1JS1S83IE0sxmbDE9bxlaWoqmGnUZE,6199
 cloudnetpy/products/product_tools.py,sha256=uu4l6reuGbPcW3TgttbaSrqIKbyYGhBVTdnC7opKvmg,11101
-cloudnetpy-1.76.1.dist-info/licenses/LICENSE,sha256=wcZF72bdaoG9XugpyE95Juo7lBQOwLuTKBOhhtANZMM,1094
+cloudnetpy-1.77.0.dist-info/licenses/LICENSE,sha256=wcZF72bdaoG9XugpyE95Juo7lBQOwLuTKBOhhtANZMM,1094
 docs/source/conf.py,sha256=IKiFWw6xhUd8NrCg0q7l596Ck1d61XWeVjIFHVSG9Og,1490
-cloudnetpy-1.76.1.dist-info/METADATA,sha256=D879CAfuvaUbCF960Vvrb0Xiik6hijq1yiFREIFjZcE,5796
-cloudnetpy-1.76.1.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
-cloudnetpy-1.76.1.dist-info/entry_points.txt,sha256=HhY7LwCFk4qFgDlXx_Fy983ZTd831WlhtdPIzV-Y3dY,51
-cloudnetpy-1.76.1.dist-info/top_level.txt,sha256=ibSPWRr6ojS1i11rtBFz2_gkIe68mggj7aeswYfaOo0,16
-cloudnetpy-1.76.1.dist-info/RECORD,,
+cloudnetpy-1.77.0.dist-info/METADATA,sha256=tEn0YbqanXZxITD44cJM-bw_30aA1s-lwhIZQEJjtzA,5796
+cloudnetpy-1.77.0.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+cloudnetpy-1.77.0.dist-info/entry_points.txt,sha256=HhY7LwCFk4qFgDlXx_Fy983ZTd831WlhtdPIzV-Y3dY,51
+cloudnetpy-1.77.0.dist-info/top_level.txt,sha256=ibSPWRr6ojS1i11rtBFz2_gkIe68mggj7aeswYfaOo0,16
+cloudnetpy-1.77.0.dist-info/RECORD,,