cloudnetpy 1.72.3__py3-none-any.whl → 1.73.0__py3-none-any.whl

cloudnetpy/instruments/__init__.py

@@ -1,4 +1,5 @@
 from .basta import basta2nc
+from .bowtie import bowtie2nc
 from .ceilo import ceilo2nc
 from .copernicus import copernicus2nc
 from .disdrometer import parsivel2nc, thies2nc

cloudnetpy/instruments/bowtie.py

@@ -0,0 +1,95 @@
+from os import PathLike
+
+from cloudnetpy import output
+from cloudnetpy.constants import G_TO_KG, MM_H_TO_M_S
+from cloudnetpy.exceptions import ValidTimeStampError
+from cloudnetpy.instruments.instruments import FMCW94
+from cloudnetpy.instruments.nc_radar import NcRadar
+from cloudnetpy.metadata import MetaData
+
+
+def bowtie2nc(
+    bowtie_file: str | PathLike,
+    output_file: str,
+    site_meta: dict,
+    uuid: str | None = None,
+    date: str | None = None,
+) -> str:
+    """Converts data from 'BOW-TIE' campaign cloud radar on RV-Meteor into
+       Cloudnet Level 1b netCDF file.
+
+    Args:
+        bowtie_file: Input filename.
+        output_file: Output filename.
+        site_meta: Dictionary containing information about the site. Required key
+            value pair is `name`. Optional are `latitude`, `longitude`, `altitude`.
+        uuid: Set specific UUID for the file.
+        date: Expected date as YYYY-MM-DD of all profiles in the file.
+
+    Returns:
+        UUID of the generated file.
+
+    Raises:
+        ValidTimeStampError: No valid timestamps found.
+
+    """
+    keymap = {
+        "Zh": "Zh",
+        "v": "v",
+        "width": "width",
+        "ldr": "ldr",
+        "kurt": "kurtosis",
+        "Skew": "skewness",
+        "SNR": "SNR",
+        "time": "time",
+        "range": "range",
+        "lwp": "lwp",
+        "SurfRelHum": "relative_humidity",
+        "rain": "rainfall_rate",
+        "Nyquist_velocity": "nyquist_velocity",
+        "range_offsets": "chirp_start_indices",
+    }
+
+    with Bowtie(bowtie_file, site_meta) as bowtie:
+        bowtie.init_data(keymap)
+        bowtie.add_time_and_range()
+        if date is not None:
+            bowtie.check_date(date)
+        bowtie.add_radar_specific_variables()
+        bowtie.add_site_geolocation()
+        bowtie.add_height()
+        bowtie.convert_units()
+        bowtie.test_if_all_masked()
+    attributes = output.add_time_attribute(ATTRIBUTES, bowtie.date)
+    output.update_attributes(bowtie.data, attributes)
+    return output.save_level1b(bowtie, output_file, uuid)
+
+
+class Bowtie(NcRadar):
+    def __init__(self, full_path: str | PathLike, site_meta: dict):
+        super().__init__(full_path, site_meta)
+        self.instrument = FMCW94
+        self.date = self.get_date()
+
+    def convert_units(self):
+        self.data["lwp"].data *= G_TO_KG
+        self.data["rainfall_rate"].data *= MM_H_TO_M_S
+        self.data["relative_humidity"].data /= 100
+
+    def check_date(self, date: str):
+        if "-".join(self.date) != date:
+            raise ValidTimeStampError
+
+
+ATTRIBUTES: dict = {
+    "v": MetaData(
+        long_name="Doppler velocity",
+        units="m s-1",
+        comment=(
+            "This parameter is the radial component of the velocity, with positive\n"
+            "velocities are away from the radar. It was corrected for the heave\n"
+            "motion of the ship. A rolling average over 3 time steps has been\n"
+            "applied to it."
+        ),
+    ),
+}

cloudnetpy/instruments/rpg.py

@@ -445,10 +445,6 @@ RPG_ATTRIBUTES = {
         long_name="Number of spectral samples in each chirp sequence",
         units="1",
     ),
-    "chirp_start_indices": MetaData(
-        long_name="Chirp sequences start indices",
-        units="1",
-    ),
     "number_of_averaged_chirps": MetaData(
         long_name="Number of averaged chirps in sequence",
         units="1",
@@ -517,10 +513,6 @@ RPG_ATTRIBUTES = {
         long_name="PC temperature",
         units="K",
     ),
-    "skewness": MetaData(
-        long_name="Skewness of spectra",
-        units="1",
-    ),
     "kurtosis": MetaData(
         long_name="Kurtosis of spectra",
         units="1",

cloudnetpy/metadata.py

@@ -93,6 +93,10 @@ COMMON_ATTRIBUTES = {
         long_name="Kurtosis of spectra",
         units="1",
     ),
+    "skewness": MetaData(
+        long_name="Skewness of spectra",
+        units="1",
+    ),
     "nyquist_velocity": MetaData(long_name="Nyquist velocity", units="m s-1"),
     "radar_frequency": MetaData(long_name="Radar transmit frequency", units="GHz"),
     "beta": MetaData(
@@ -190,4 +194,8 @@ COMMON_ATTRIBUTES = {
         units="dB",
         comment="SNR threshold used in data screening.",
     ),
+    "chirp_start_indices": MetaData(
+        long_name="Chirp sequences start indices",
+        units="1",
+    ),
 }

cloudnetpy/version.py

@@ -1,4 +1,4 @@
 MAJOR = 1
-MINOR = 72
-PATCH = 3
+MINOR = 73
+PATCH = 0
 __version__ = f"{MAJOR}.{MINOR}.{PATCH}"

{cloudnetpy-1.72.3.dist-info → cloudnetpy-1.73.0.dist-info}/METADATA

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

{cloudnetpy-1.72.3.dist-info → cloudnetpy-1.73.0.dist-info}/RECORD

@@ -5,11 +5,11 @@ cloudnetpy/concat_lib.py,sha256=jcLppqAmVHVkykcXBcpwUr8MS_k8v2Xl2xBLmVRE_DI,1262
 cloudnetpy/constants.py,sha256=YnoSzZm35NDooJfhlulSJBc7g0eSchT3yGytRaTaJEI,845
 cloudnetpy/datasource.py,sha256=FcWS77jz56gIzwnbafDLdj-HjAyu0P_VtY7gkeVZThU,7952
 cloudnetpy/exceptions.py,sha256=hYbUtBwjCIfxnPe_5mELDEw87AWITBrwuo7WYIEKmJ8,1579
-cloudnetpy/metadata.py,sha256=BDEpgwZ58PHznc1gi11gtNNV4kFiMAmlHnF4huTy7nw,5982
+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=U0iMIKPiKLrLVAfs_u9pPuoWYW1RJHcM8dbLF9a4yIA,29796
-cloudnetpy/version.py,sha256=VZyDjYqkZF5bawPUyoO9efabZW4A0aKtVUmrLqcEnGE,72
+cloudnetpy/version.py,sha256=3tb7RR3Otpei74n8G_komkzbUlDjdwa11eUTBVCQFw0,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,8 +32,9 @@ 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=2vAdceXCNxZhTujhArLf4NjYOfUdkhLpGM-NQa_LXdg,470
+cloudnetpy/instruments/__init__.py,sha256=sbJZBYWynZbGAWb8VMMaT5qXuCyzG1LwEdHhVxFXVMk,500
 cloudnetpy/instruments/basta.py,sha256=Lb_EhQTI93S5Bd9osDbCE_tC8gZreRsHz7D2_dFOjmE,3793
+cloudnetpy/instruments/bowtie.py,sha256=Hp4mzjGqvYw5bhgAy_LvScYrf3Xm3ULbtPjhG9GnAJ8,2977
 cloudnetpy/instruments/ceilo.py,sha256=rkP6Vo90eS5ZhnKxZpnkuiG5ZEP86lDK8zRqoMY1aqg,9498
 cloudnetpy/instruments/ceilometer.py,sha256=pdmLVljsuciyKpaGxWxJ_f1IrJK-UrkBC0lSeuirLlU,12095
 cloudnetpy/instruments/cl61d.py,sha256=g6DNBFju3wYhLFl32DKmC8pUup7y-EupXoUU0fuoGGA,1990
@@ -50,7 +51,7 @@ cloudnetpy/instruments/nc_radar.py,sha256=HlaZeH5939R86ukF8K-P4Kfzb5-CpLB15LU2u9
 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=9TdpP4UzMBNIt2iE2GL6K9dFldzTHPLOrU8Q3tcosCU,5317
-cloudnetpy/instruments/rpg.py,sha256=gEQd-yICUoikQnHVpikpHppUrwekdTuIf9Mk1jGxgCY,17566
+cloudnetpy/instruments/rpg.py,sha256=gjvDomyoqSaeS3-X4EuesvWBp32BNoD-CeuvBOP19AI,17359
 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
@@ -115,10 +116,10 @@ cloudnetpy/products/lwc.py,sha256=sl6Al2tuH3KkCBrPbWTmuz3jlD5UQJ4D6qBsn1tt2CQ,18
 cloudnetpy/products/mie_lu_tables.nc,sha256=It4fYpqJXlqOgL8jeZ-PxGzP08PMrELIDVe55y9ob58,16637951
 cloudnetpy/products/mwr_tools.py,sha256=rd7UC67O4fsIE5SaHVZ4qWvUJTj41ZGwgQWPwZzOM14,5377
 cloudnetpy/products/product_tools.py,sha256=uu4l6reuGbPcW3TgttbaSrqIKbyYGhBVTdnC7opKvmg,11101
-cloudnetpy-1.72.3.dist-info/licenses/LICENSE,sha256=wcZF72bdaoG9XugpyE95Juo7lBQOwLuTKBOhhtANZMM,1094
+cloudnetpy-1.73.0.dist-info/licenses/LICENSE,sha256=wcZF72bdaoG9XugpyE95Juo7lBQOwLuTKBOhhtANZMM,1094
 docs/source/conf.py,sha256=IKiFWw6xhUd8NrCg0q7l596Ck1d61XWeVjIFHVSG9Og,1490
-cloudnetpy-1.72.3.dist-info/METADATA,sha256=eKefOUz7gfLWg1dMP0-2GqIkWGPzjinAVmdzO05iNOs,5796
-cloudnetpy-1.72.3.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-cloudnetpy-1.72.3.dist-info/entry_points.txt,sha256=HhY7LwCFk4qFgDlXx_Fy983ZTd831WlhtdPIzV-Y3dY,51
-cloudnetpy-1.72.3.dist-info/top_level.txt,sha256=ibSPWRr6ojS1i11rtBFz2_gkIe68mggj7aeswYfaOo0,16
-cloudnetpy-1.72.3.dist-info/RECORD,,
+cloudnetpy-1.73.0.dist-info/METADATA,sha256=t2jW8No5Pzbx9iAxD0rhFytFG10fpylqlM5QVgauUN4,5796
+cloudnetpy-1.73.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+cloudnetpy-1.73.0.dist-info/entry_points.txt,sha256=HhY7LwCFk4qFgDlXx_Fy983ZTd831WlhtdPIzV-Y3dY,51
+cloudnetpy-1.73.0.dist-info/top_level.txt,sha256=ibSPWRr6ojS1i11rtBFz2_gkIe68mggj7aeswYfaOo0,16
+cloudnetpy-1.73.0.dist-info/RECORD,,