disdrodb 0.2.1__py3-none-any.whl → 0.4.0__py3-none-any.whl

disdrodb/l0/readers/PARSIVEL/KOREA/ICEPOP_MSC.py

@@ -0,0 +1,159 @@
+#!/usr/bin/env python3
+# -----------------------------------------------------------------------------.
+# Copyright (c) 2021-2026 DISDRODB developers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# -----------------------------------------------------------------------------.
+import numpy as np
+import pandas as pd
+
+from disdrodb.l0.l0_reader import is_documented_by, reader_generic_docstring
+from disdrodb.l0.l0a_processing import read_raw_text_file
+
+
+@is_documented_by(reader_generic_docstring)
+def reader(
+    filepath,
+    logger=None,
+):
+    """Reader."""
+    ##------------------------------------------------------------------------.
+    #### Define column names
+    column_names = ["TO_PARSE"]
+
+    ##------------------------------------------------------------------------.
+    #### Define reader options
+    reader_kwargs = {}
+
+    # - Define delimiter
+    reader_kwargs["delimiter"] = "\\n"
+
+    # - Define encoding
+    reader_kwargs["encoding"] = "ISO-8859-1"
+
+    # - Skip first row as columns names
+    reader_kwargs["header"] = None
+
+    # - Avoid first column to become df index !!!
+    reader_kwargs["index_col"] = False
+
+    # - Define behaviour when encountering bad lines
+    reader_kwargs["on_bad_lines"] = "skip"
+
+    # - Define reader engine
+    #   - C engine is faster
+    #   - Python engine is more feature-complete
+    reader_kwargs["engine"] = "python"
+
+    # - Define on-the-fly decompression of on-disk data
+    #   - Available: gzip, bz2, zip
+    reader_kwargs["compression"] = "infer"
+
+    # - Strings to recognize as NA/NaN and replace with standard NA flags
+    #   - Already included: '#N/A', '#N/A N/A', '#NA', '-1.#IND', '-1.#QNAN',
+    #                       '-NaN', '-nan', '1.#IND', '1.#QNAN', '<NA>', 'N/A',
+    #                       'NA', 'NULL', 'NaN', 'n/a', 'nan', 'null'
+    reader_kwargs["na_values"] = ["na", "", "error"]
+
+    ##------------------------------------------------------------------------.
+    #### Read the data
+    df = read_raw_text_file(
+        filepath=filepath,
+        column_names=column_names,
+        reader_kwargs=reader_kwargs,
+        logger=logger,
+    )
+
+    ##------------------------------------------------------------------------.
+    #### Adapt the dataframe to adhere to DISDRODB L0 standards
+    # Create ID and Value columns
+    df = df["TO_PARSE"].str.split(":", expand=True, n=1)
+    df.columns = ["ID", "Value"]
+
+    # Select only rows with values
+    df = df[df["Value"].astype(bool)]
+    df = df[df["Value"].apply(lambda x: x is not None)]
+
+    # Drop rows with invalid IDs
+    # - Corrupted rows
+    valid_id_str = np.char.rjust(np.arange(0, 94).astype(str), width=2, fillchar="0")
+    df = df[df["ID"].astype(str).isin(valid_id_str)]
+
+    # Create the dataframe where each row corresponds to a timestep
+    df["_group"] = (df["ID"].astype(int).diff() <= 0).cumsum()
+    df = df.pivot(index="_group", columns="ID")  # noqa
+    df.columns = df.columns.get_level_values("ID")
+    df = df.reset_index(drop=True)
+
+    # Assign column names
+    column_dict = {
+        "01": "rainfall_rate_32bit",
+        "02": "rainfall_accumulated_32bit",
+        "03": "weather_code_synop_4680",
+        "04": "weather_code_synop_4677",
+        "05": "weather_code_metar_4678",
+        "06": "weather_code_nws",
+        "07": "reflectivity_32bit",
+        "08": "mor_visibility",
+        "09": "sample_interval",
+        "10": "laser_amplitude",
+        "11": "number_particles",
+        "12": "sensor_temperature",
+        # "13": "sensor_serial_number",
+        # "14": "firmware_iop",
+        # "15": "firmware_dsp",
+        "16": "sensor_heating_current",
+        "17": "sensor_battery_voltage",
+        "18": "sensor_status",
+        # "19": "start_time",
+        "20": "sensor_time",
+        "21": "sensor_date",
+        # "22": "station_name",
+        # "23": "station_number",
+        "90": "raw_drop_concentration",
+        "91": "raw_drop_average_velocity",
+        "93": "raw_drop_number",
+    }
+
+    # Identify missing columns and add NaN
+    expected_columns = np.array(list(column_dict.keys()))
+    missing_columns = expected_columns[np.isin(expected_columns, df.columns, invert=True)].tolist()
+    if len(missing_columns) > 0:
+        for column in missing_columns:
+            df[column] = "NaN"
+
+    # Rename columns
+    df = df.rename(column_dict, axis=1)
+
+    # Keep only columns defined in the dictionary
+    df = df[list(column_dict.values())]
+
+    # Define datetime "time" column
+    df["time"] = df["sensor_date"] + "-" + df["sensor_time"]
+    df["time"] = pd.to_datetime(df["time"], format="%d.%m.%Y-%H:%M:%S", errors="coerce")
+
+    # Drop columns not agreeing with DISDRODB L0 standards
+    columns_to_drop = [
+        "sensor_date",
+        "sensor_time",
+        # "firmware_iop",
+        # "firmware_dsp",
+        # "sensor_serial_number",
+        # "station_name",
+        # "station_number",
+    ]
+    df = df.drop(columns=columns_to_drop)
+
+    # Return the dataframe adhering to DISDRODB L0 standards
+    return df

disdrodb/l0/readers/PARSIVEL/NASA/LPVEX.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL/NASA/MC3E.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL/NCAR/CCOPE_2015.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL/NCAR/OWLES_MIPS.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL/NCAR/PECAN_MOBILE.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL/NCAR/PLOWS_MIPS.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL/NCAR/VORTEX2_2009.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL/NCAR/VORTEX2_2010.py

@@ -1,7 +1,5 @@
-#!/usr/bin/env python3
-
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL/NCAR/VORTEX2_2010_UF.py

@@ -1,7 +1,5 @@
-#!/usr/bin/env python3
-
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL/SLOVENIA/UL.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -16,6 +16,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
 """Reader for EPFL 2009 campaign."""
+
 import pandas as pd
 
 from disdrodb.l0.l0_reader import is_documented_by, reader_generic_docstring

disdrodb/l0/readers/PARSIVEL2/ARM/ARM_PARSIVEL2.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -16,6 +16,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
 """Reader for ARM OTT PARSIVEL2 sensor."""
+
 from disdrodb.l0.l0_reader import is_documented_by, reader_generic_docstring
 from disdrodb.l0.l0b_nc_processing import open_raw_netcdf_file, replace_custom_nan_flags, standardize_raw_dataset
 

disdrodb/l0/readers/PARSIVEL2/BASQUECOUNTRY/EUSKALMET_OTT2.py

@@ -1,5 +1,5 @@
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -15,6 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
 """DISDRODB reader for EUSKALMET OTT Parsivel 2 raw data."""
+
 # import os
 # import tempfile
 # from disdrodb.utils.compression import unzip_file_on_terminal

disdrodb/l0/readers/PARSIVEL2/BELGIUM/ILVO.py

@@ -1,7 +1,5 @@
-#!/usr/bin/env python3
-
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -17,6 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
 """DISDRODB reader for UGENT ILVO Parsivel2 raw text data."""
+
 import tarfile
 
 import numpy as np

disdrodb/l0/readers/PARSIVEL2/BRAZIL/CHUVA_PARSIVEL2.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL2/BRAZIL/GOAMAZON_PARSIVEL2.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL2/CANADA/UQAM_NC.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL2/DENMARK/DTU.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL2/DENMARK/EROSION_nc.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -16,6 +16,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
 """Reader for the EROSION campaign in Denmark."""
+
 from disdrodb.l0.l0_reader import is_documented_by, reader_generic_docstring
 from disdrodb.l0.l0b_nc_processing import open_raw_netcdf_file, standardize_raw_dataset
 

disdrodb/l0/readers/PARSIVEL2/DENMARK/EROSION_raw.py

@@ -1,5 +1,5 @@
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -15,6 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
 """Reader for the EROSION campaign in Denmark."""
+
 import numpy as np
 import pandas as pd
 

disdrodb/l0/readers/PARSIVEL2/FINLAND/FMI_PARSIVEL2.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL2/FRANCE/ENPC_PARSIVEL2.py

@@ -1,7 +1,5 @@
-#!/usr/bin/env python3
-
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -17,6 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
 """DISDRODB reader for ENPC PARSIVEL2 raw text data."""
+
 # import os
 # import tempfile
 # from disdrodb.utils.compression import unzip_file_on_terminal

disdrodb/l0/readers/PARSIVEL2/FRANCE/OSUG.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -357,7 +357,7 @@ def select_only_valid_rows(df, expected_n_values, logger, filepath):
     unique_values, counts = np.unique(n_values_per_row, return_counts=True)
 
     # Determine the valid number of values
-    valid_counts = [(val, count) for val, count in zip(unique_values, counts) if val in expected_n_values]
+    valid_counts = [(val, count) for val, count in zip(unique_values, counts, strict=True) if val in expected_n_values]
     if not valid_counts:
         raise ValueError(
             f"{filepath} has no rows with expected number of values: {expected_n_values}."

disdrodb/l0/readers/PARSIVEL2/FRANCE/SIRTA_PARSIVEL2.py

@@ -1,7 +1,5 @@
-#!/usr/bin/env python3
-
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL2/GREECE/NOA.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -120,8 +120,9 @@ def reader(
     # Example: ',,1,,' --> '0,0,1,0,'
     df["raw_drop_number"] = df["raw_drop_number"].str.replace(r"(?<!\d);", "0;", regex=True)
 
-    # Replace ending 999; with 0;
-    df["raw_drop_number"] = df["raw_drop_number"].str.replace(r"999;$", "0", regex=True)
+    # Replace ending with 999; or 256; with 0;
+    df["raw_drop_number"] = df["raw_drop_number"].str.replace(r"999;$", "0;", regex=True)
+    df["raw_drop_number"] = df["raw_drop_number"].str.replace(r"256;$", "0;", regex=True)
 
     # Return the dataframe adhering to DISDRODB L0 standards
     return df

disdrodb/l0/readers/PARSIVEL2/ITALY/GID_PARSIVEL2.py

@@ -1,7 +1,5 @@
-#!/usr/bin/env python3
-
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL2/ITALY/HYDROX.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -16,6 +16,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
 """Reader for HYDROX PARSIVEL2 disdrometer located at Trafoi (Italy)."""
+
 import os
 
 import pandas as pd
@@ -120,6 +121,7 @@ def read_old_format(filepath, logger):
 
     # Replace ending 999; with 0;
     df["raw_drop_number"] = df["raw_drop_number"].str.replace(r"999;$", "0", regex=True)
+    df["raw_drop_number"] = df["raw_drop_number"].str.replace(r"256;$", "0;", regex=True)
 
     # Return the dataframe adhering to DISDRODB L0 standards
     return df
@@ -220,8 +222,9 @@ def read_new_format(filepath, logger):
     # Example: ',,1,,' --> '0,0,1,0,'
     df["raw_drop_number"] = df["raw_drop_number"].str.replace(r"(?<!\d);", "0;", regex=True)
 
-    # Replace ending 999; with 0;
-    df["raw_drop_number"] = df["raw_drop_number"].str.replace(r"999;$", "0", regex=True)
+    # Replace ending with 999; or 256; with 0;
+    df["raw_drop_number"] = df["raw_drop_number"].str.replace(r"999;$", "0;", regex=True)
+    df["raw_drop_number"] = df["raw_drop_number"].str.replace(r"256;$", "0;", regex=True)
 
     # Return the dataframe adhering to DISDRODB L0 standards
     return df

disdrodb/l0/readers/PARSIVEL2/JAPAN/PRECIP.py

@@ -1,5 +1,5 @@
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL2/KIT/BURKINA_FASO.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

disdrodb/l0/readers/PARSIVEL2/KIT/TEAMX.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 DISDRODB developers
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by