disdrodb 0.0.21__py3-none-any.whl → 0.1.0__py3-none-any.whl

disdrodb/l0/readers/{EPFL → PARSIVEL/EPFL}/GRAND_ST_BERNARD_2007_2.py

@@ -17,23 +17,21 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
-from disdrodb.l0 import run_l0a
+"""Reader for the GRAND ST BERNARD campaign."""
+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(
-    raw_dir,
-    processed_dir,
-    station_name,
-    # Processing options
-    force=False,
-    verbose=False,
-    parallel=False,
-    debugging_mode=False,
+    filepath,
+    logger=None,
 ):
+    """Reader."""
     ##------------------------------------------------------------------------.
-    #### - Define column names
+    #### Define column names
     column_names = [
         "time",
         "id",
@@ -59,7 +57,7 @@ def reader(
     ]
 
     ##------------------------------------------------------------------------.
-    #### - Define reader options
+    #### Define reader options
     reader_kwargs = {}
     # - Define delimiter
     reader_kwargs["delimiter"] = ","
@@ -79,42 +77,25 @@ def reader(
     #   - 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’
+    #   - 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", "-.-", " NA"]
 
     ##------------------------------------------------------------------------.
-    #### - Define dataframe sanitizer function for L0 processing
-    def df_sanitizer_fun(df):
-        # - Import pandas
-        import pandas as pd
-
-        # - Convert time column to datetime
-        df["time"] = pd.to_datetime(df["time"], format="%Y-%m-%d %H:%M:%S", errors="coerce")
-
-        # - Drop columns not agreeing with DISDRODB L0 standards
-        df = df.drop(columns=["id", "data_logger_temperature", "data_logger_voltage"])
-        return df
-
-    ##------------------------------------------------------------------------.
-    #### - Define glob pattern to search data files in <raw_dir>/data/<station_name>
-    glob_patterns = "*.dat*"
-
-    ####----------------------------------------------------------------------.
-    #### - Create L0A products
-    run_l0a(
-        raw_dir=raw_dir,
-        processed_dir=processed_dir,
-        station_name=station_name,
-        # Custom arguments of the reader for L0A processing
-        glob_patterns=glob_patterns,
+    #### Read the data
+    df = read_raw_text_file(
+        filepath=filepath,
         column_names=column_names,
         reader_kwargs=reader_kwargs,
-        df_sanitizer_fun=df_sanitizer_fun,
-        # Processing options
-        force=force,
-        verbose=verbose,
-        parallel=parallel,
-        debugging_mode=debugging_mode,
+        logger=logger,
     )
+
+    ##------------------------------------------------------------------------.
+    #### Adapt the dataframe to adhere to DISDRODB L0 standards
+    # Convert time column to datetime
+    df["time"] = pd.to_datetime(df["time"], format="%Y-%m-%d %H:%M:%S", errors="coerce")
+
+    # Drop columns not agreeing with DISDRODB L0 standards
+    df = df.drop(columns=["id", "data_logger_temperature", "data_logger_voltage"])
+    return df

disdrodb/l0/readers/{EPFL → PARSIVEL/EPFL}/HPICONET_2010.py

@@ -15,23 +15,21 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
-from disdrodb.l0 import run_l0a
+"""Reader for the HPICONET campaign."""
+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(
-    raw_dir,
-    processed_dir,
-    station_name,
-    # Processing options
-    force=False,
-    verbose=False,
-    parallel=False,
-    debugging_mode=False,
+    filepath,
+    logger=None,
 ):
+    """Reader."""
     ##------------------------------------------------------------------------.
-    #### - Define column names
+    #### Define column names
     column_names = [
         "time",
         "id",
@@ -58,7 +56,7 @@ def reader(
     ]
 
     ##------------------------------------------------------------------------.
-    #### - Define reader options
+    #### Define reader options
     reader_kwargs = {}
     # - Define delimiter
     reader_kwargs["delimiter"] = ","
@@ -78,49 +76,34 @@ def reader(
     #   - 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’
+    #   - 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", "-.-"]
 
     ##------------------------------------------------------------------------.
-    #### - Define  dataframe sanitizer function for L0 processing
-    def df_sanitizer_fun(df):
-        # - Import pandas
-        import pandas as pd
-
-        # - Convert time column to datetime
-        df["time"] = pd.to_datetime(df["time"], format="%Y-%m-%d %H:%M:%S")
-
-        # - Drop columns not agreeing with DISDRODB L0 standards
-        columns_to_drop = [
-            "id",
-            "datalogger_temperature",
-            "datalogger_voltage",
-            "datalogger_debug",
-            "datalogger_error",
-        ]
-        df = df.drop(columns=columns_to_drop)
-        return df
-
-    ##------------------------------------------------------------------------.
-    #### - Define glob pattern to search data files in <raw_dir>/data/<station_name>
-    glob_patterns = "*.dat*"
-
-    ####----------------------------------------------------------------------.
-    #### - Create L0A products
-    run_l0a(
-        raw_dir=raw_dir,
-        processed_dir=processed_dir,
-        station_name=station_name,
-        # Custom arguments of the reader for L0A processing
-        glob_patterns=glob_patterns,
+    #### Read the data
+    df = read_raw_text_file(
+        filepath=filepath,
         column_names=column_names,
         reader_kwargs=reader_kwargs,
-        df_sanitizer_fun=df_sanitizer_fun,
-        # Processing options
-        force=force,
-        verbose=verbose,
-        parallel=parallel,
-        debugging_mode=debugging_mode,
+        logger=logger,
     )
+
+    ##------------------------------------------------------------------------.
+    #### Adapt the dataframe to adhere to DISDRODB L0 standards
+    # Convert time column to datetime
+    df["time"] = pd.to_datetime(df["time"], format="%Y-%m-%d %H:%M:%S")
+
+    # Drop columns not agreeing with DISDRODB L0 standards
+    columns_to_drop = [
+        "id",
+        "datalogger_temperature",
+        "datalogger_voltage",
+        "datalogger_debug",
+        "datalogger_error",
+    ]
+    df = df.drop(columns=columns_to_drop)
+
+    # Return the dataframe adhering to DISDRODB L0 standards
+    return df

disdrodb/l0/readers/{EPFL/EPFL_ROOF_2010.py → PARSIVEL/EPFL/HYMEX_LTE_SOP2.py}

@@ -15,23 +15,21 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
-from disdrodb.l0 import run_l0a
+"""Reader for the HYMEX SOP2 campaign."""
+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(
-    raw_dir,
-    processed_dir,
-    station_name,
-    # Processing options
-    force=False,
-    verbose=False,
-    parallel=False,
-    debugging_mode=False,
+    filepath,
+    logger=None,
 ):
+    """Reader."""
     ##------------------------------------------------------------------------.
-    #### - Define column names
+    #### Define column names
     column_names = [
         "time",
         "id",
@@ -58,7 +56,7 @@ def reader(
     ]
 
     ##------------------------------------------------------------------------.
-    #### - Define reader options
+    #### Define reader options
     reader_kwargs = {}
     # - Define delimiter
     reader_kwargs["delimiter"] = ","
@@ -74,49 +72,38 @@ def reader(
     #   - 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’
+    #   - 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", "-.-", " NA"]
 
     ##------------------------------------------------------------------------.
-    #### - Define dataframe sanitizer function for L0 processing
-    def df_sanitizer_fun(df):
-        # - Import pandas
-        import pandas as pd
+    #### Read the data
+    df = read_raw_text_file(
+        filepath=filepath,
+        column_names=column_names,
+        reader_kwargs=reader_kwargs,
+        logger=logger,
+    )
 
-        # - Convert time column to datetime
-        df["time"] = pd.to_datetime(df["time"], format="%Y-%m-%d %H:%M:%S", errors="coerce")
+    ##------------------------------------------------------------------------.
+    #### Adapt the dataframe to adhere to DISDRODB L0 standards
+    # Convert time column to datetime
+    df["time"] = pd.to_datetime(df["time"], format="%Y-%m-%d %H:%M:%S", errors="coerce")
 
-        # - Drop columns not agreeing with DISDRODB L0 standards
-        columns_to_drop = [
-            "id",
-            "datalogger_voltage",
-            "datalogger_temperature",
-            "datalogger_debug",
-            "datalogger_error",
-        ]
-        df = df.drop(columns=columns_to_drop)
-        return df
+    # Drop rows when "raw_drop_number" is "NA"
+    # --> This is used to drop all rows where all values are "NA"
+    df = df.dropna(subset="raw_drop_number", axis=0)
 
-    ##------------------------------------------------------------------------.
-    #### - Define glob pattern to search data files in <raw_dir>/data/<station_name>
-    glob_patterns = "*.dat*"
+    # Drop columns not agreeing with DISDRODB L0 standards
+    columns_to_drop = [
+        "datalogger_debug",
+        "datalogger_voltage",
+        "id",
+        "datalogger_temperature",
+        "datalogger_error",
+    ]
+    df = df.drop(columns=columns_to_drop)
 
-    ####----------------------------------------------------------------------.
-    #### - Create L0A products
-    run_l0a(
-        raw_dir=raw_dir,
-        processed_dir=processed_dir,
-        station_name=station_name,
-        # Custom arguments of the reader for L0A processing
-        glob_patterns=glob_patterns,
-        column_names=column_names,
-        reader_kwargs=reader_kwargs,
-        df_sanitizer_fun=df_sanitizer_fun,
-        # Processing options
-        force=force,
-        verbose=verbose,
-        parallel=parallel,
-        debugging_mode=debugging_mode,
-    )
+    # Return the dataframe adhering to DISDRODB L0 standards
+    return df

disdrodb/l0/readers/PARSIVEL/EPFL/HYMEX_LTE_SOP3.py

@@ -0,0 +1,111 @@
+#!/usr/bin/env python3
+# -----------------------------------------------------------------------------.
+# Copyright (c) 2021-2023 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/>.
+# -----------------------------------------------------------------------------.
+"""Reader for HYMEX SOP3 campaign."""
+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 = [
+        "time",
+        "id",
+        "datalogger_temperature",
+        "datalogger_voltage",
+        "rainfall_rate_32bit",
+        "rainfall_accumulated_32bit",
+        "weather_code_synop_4680",
+        "weather_code_synop_4677",
+        "reflectivity_32bit",
+        "mor_visibility",
+        "laser_amplitude",
+        "number_particles",
+        "sensor_temperature",
+        "sensor_heating_current",
+        "sensor_battery_voltage",
+        "sensor_status",
+        "rainfall_amount_absolute_32bit",
+        "datalogger_debug",
+        "raw_drop_concentration",
+        "raw_drop_average_velocity",
+        "raw_drop_number",
+        "datalogger_error",
+    ]
+
+    ##------------------------------------------------------------------------.
+    #### Define reader options
+    reader_kwargs = {}
+    # - Define delimiter
+    reader_kwargs["delimiter"] = ","
+    # - Avoid first column to become df index !!!
+    reader_kwargs["index_col"] = False
+    # - Define behaviour when encountering bad lines
+    reader_kwargs["on_bad_lines"] = "skip"
+    # - Avoid UnicodeDecodeError: 'utf-8' codec can't decode byte ...
+    reader_kwargs["encoding"] = "latin-1"
+    # - 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", "-.-", " NA"]
+
+    ##------------------------------------------------------------------------.
+    #### 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
+    # Convert time column to datetime
+    df["time"] = pd.to_datetime(df["time"], format="%Y-%m-%d %H:%M:%S", errors="coerce")
+
+    # Drop rows when "raw_drop_number" is "NA"
+    # --> This is used to drop all rows where all values are "NA"
+    df = df.dropna(subset="raw_drop_number", axis=0)
+
+    # Drop columns not agreeing with DISDRODB L0 standards
+    columns_to_drop = [
+        "datalogger_debug",
+        "datalogger_voltage",
+        "id",
+        "datalogger_temperature",
+        "datalogger_error",
+    ]
+    df = df.drop(columns=columns_to_drop)
+
+    # Return the dataframe adhering to DISDRODB L0 standards
+    return df

disdrodb/l0/readers/{EPFL → PARSIVEL/EPFL}/HYMEX_LTE_SOP4.py

@@ -16,23 +16,20 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
 """Reader for HYMEX SOP4 campaign."""
-from disdrodb.l0 import run_l0a
+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(
-    raw_dir,
-    processed_dir,
-    station_name,
-    # Processing options
-    force=False,
-    verbose=False,
-    parallel=False,
-    debugging_mode=False,
+    filepath,
+    logger=None,
 ):
+    """Reader."""
     ##------------------------------------------------------------------------.
-    #### - Define column names
+    #### Define column names
     column_names = [
         "time",
         "id",
@@ -59,7 +56,7 @@ def reader(
     ]
 
     ##------------------------------------------------------------------------.
-    #### - Define reader options
+    #### Define reader options
     reader_kwargs = {}
     # - Define delimiter
     reader_kwargs["delimiter"] = ","
@@ -77,53 +74,38 @@ def reader(
     #   - 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’
+    #   - 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", "-.-", " NA"]
 
     ##------------------------------------------------------------------------.
-    #### - Define dataframe sanitizer function for L0 processing
-    def df_sanitizer_fun(df):
-        # Import dask or pandas
-        import pandas as pd
-
-        # - Convert time column to datetime
-        df["time"] = pd.to_datetime(df["time"], format="%Y-%m-%d %H:%M:%S", errors="coerce")
+    #### Read the data
+    df = read_raw_text_file(
+        filepath=filepath,
+        column_names=column_names,
+        reader_kwargs=reader_kwargs,
+        logger=logger,
+    )
 
-        # - Drop rows when "raw_drop_number" is "NA"
-        # --> This is used to drop all rows where all values are "NA"
-        df = df.dropna(subset="raw_drop_number", axis=0)
+    ##------------------------------------------------------------------------.
+    #### Adapt the dataframe to adhere to DISDRODB L0 standards
+    # Convert time column to datetime
+    df["time"] = pd.to_datetime(df["time"], format="%Y-%m-%d %H:%M:%S", errors="coerce")
 
-        # - Drop columns not agreeing with DISDRODB L0 standards
-        columns_to_drop = [
-            "datalogger_debug",
-            "datalogger_voltage",
-            "id",
-            "datalogger_temperature",
-            "datalogger_error",
-        ]
-        df = df.drop(columns=columns_to_drop)
-        return df
+    # - Drop rows when "raw_drop_number" is "NA"
+    # --> This is used to drop all rows where all values are "NA"
+    df = df.dropna(subset="raw_drop_number", axis=0)
 
-    ##------------------------------------------------------------------------.
-    #### - Define glob pattern to search data files in <raw_dir>/data/<station_name>
-    glob_patterns = "*.dat*"
+    # Drop columns not agreeing with DISDRODB L0 standards
+    columns_to_drop = [
+        "datalogger_debug",
+        "datalogger_voltage",
+        "id",
+        "datalogger_temperature",
+        "datalogger_error",
+    ]
+    df = df.drop(columns=columns_to_drop)
 
-    ####----------------------------------------------------------------------.
-    #### - Create L0A products
-    run_l0a(
-        raw_dir=raw_dir,
-        processed_dir=processed_dir,
-        station_name=station_name,
-        # Custom arguments of the reader for L0A processing
-        glob_patterns=glob_patterns,
-        column_names=column_names,
-        reader_kwargs=reader_kwargs,
-        df_sanitizer_fun=df_sanitizer_fun,
-        # Processing options
-        force=force,
-        verbose=verbose,
-        parallel=parallel,
-        debugging_mode=debugging_mode,
-    )
+    # Return the dataframe adhering to DISDRODB L0 standards
+    return df