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

disdrodb/l0/readers/SPAIN/SBEGUERIA.py

@@ -1,179 +0,0 @@
-#!/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/>.
-# -----------------------------------------------------------------------------.
-from disdrodb.l0 import run_l0a
-from disdrodb.l0.l0_reader import is_documented_by, reader_generic_docstring
-
-
-@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,
-):
-    ##------------------------------------------------------------------------.
-    #### - Define column names
-    # These are the variables included in the datasets:
-
-    # var			full name										units
-
-    # Time		    time of the record								Y-m-d hh:mm:ss
-    # Event		    event ID 										(factor)
-    # ID			disdromter ID 									(factor: T1, T2, P1, P2)
-    # Serial		disdrometer serial number						(factor)
-    # Type		    disdrometer type 								(factor: Thi, Par)
-    # Mast		    mast ID											(factor: 1, 2)
-    # NP_meas		number of particles detected					(-)
-    # R_meas		rainfall intensity, as outputted by the device	mm h−1
-    # Z_meas		radar reflectivity, as outputted by the device	dB mm6 m−3
-    # E_meas		erosivity, as outputted by the device			J m−2 mm−1
-    # Pcum_meas	    cumulative rainfall amount						mm
-    # Ecum_meas	    cumulative kinetic energy						J m−2 mm−1
-    # NP			number of particles detected					(-)
-    # ND			particle density								m−3 mm−1
-    # R			    rainfall intensity								mm h−1
-    # P		     	rainfall amount									mm
-    # Z		    	radar reflectivity								dB mm6 m−3
-    # M		    	water content									gm−3
-    # E		        kinetic energy									J m−2 mm−1
-    # Pcum	    	cumulative rainfall amount						mm
-    # Ecum	    	cumulative kinetic energy						J m−2 mm−1
-    # D10			drop diameter’s 10th percentile					mm
-    # D25			drop diameter’s 25th percentile					mm
-    # D50			drop diameter’s 50th percentile					mm
-    # D75			drop diameter’s 75th percentile					mm
-    # D90			drop diameter’s 90th percentile					mm
-    # Dm			mean drop diameter								mm
-    # V10			drop velocity’s 10th percentile					m s−1
-    # V25			drop velocity’s 25th percentile					m s−1
-    # V50			drop velocity’s 50th percentile					m s−1
-    # V75			drop velocity’s 75th percentile					m s−1
-    # V90			drop velocity’s 90th percentile					m s−1
-    # Vm			mean drop velocity								m s−1
-
-    column_names = [
-        "time",
-        "event_id",
-        "disdrometer_ID",
-        "disdrometer_serial",
-        "disdrometer_type",
-        "mast_ID",
-        "number_particles",
-        "rainfall_rate_32bit",
-        "reflectivity_32bit",
-        "unknown",  # rain_kinetic_energy ?
-        "rainfall_accumulated_32bit",
-        "rain_kinetic_energy",  # unknown ?
-        "NP",
-        "NDRPZMEPcumEcumD10",
-        "D25",
-        "D50",
-        "D75",
-        "D90",
-        "Dm",
-        "V10",
-        "V25",
-        "V50",
-        "V75",
-        "V90",
-        "Vm",
-    ]
-
-    ##------------------------------------------------------------------------.
-    #### - Define reader options
-    reader_kwargs = {}
-    # - Define delimiter
-    reader_kwargs["delimiter"] = ","
-    # 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", "NA", "-.-"]  # Cast all to string
-
-    ##------------------------------------------------------------------------.
-    #### - 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
-        columns_to_drop = [
-            "event_id",
-            "disdrometer_ID",
-            "disdrometer_serial",
-            "disdrometer_type",
-            "mast_ID",
-            "NP",
-            "NDRPZMEPcumEcumD10",
-            "D25",
-            "D50",
-            "D75",
-            "D90",
-            "Dm",
-            "V10",
-            "V25",
-            "V50",
-            "V75",
-            "V90",
-            "Vm",
-        ]
-        df = df.drop(columns=columns_to_drop)
-
-        return df
-
-    ##------------------------------------------------------------------------.
-    #### - Define glob pattern to search data files in <raw_dir>/data/<station_name>
-    glob_patterns = "*.csv*"
-
-    ####----------------------------------------------------------------------.
-    #### - 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,
-    )

disdrodb/l0/scripts/disdrodb_run_l0b_concat.py

@@ -1,93 +0,0 @@
-# -----------------------------------------------------------------------------.
-# 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/>.
-# -----------------------------------------------------------------------------.
-##################################################
-## Wrapper to concat L0B files by command lines ##
-##################################################
-import sys
-
-import click
-
-from disdrodb.l0.routines import (
-    click_l0_stations_options,
-    click_l0b_concat_options,
-)
-from disdrodb.utils.scripts import click_base_dir_option, parse_arg_to_list, parse_base_dir
-
-sys.tracebacklimit = 0  # avoid full traceback error if occur
-
-
-@click.command()
-@click_l0_stations_options
-@click_l0b_concat_options
-@click_base_dir_option
-def disdrodb_run_l0b_concat(
-    data_sources: str = None,
-    campaign_names: str = None,
-    station_names: str = None,
-    remove_l0b: bool = False,
-    verbose: bool = True,
-    base_dir: str = None,
-):
-    """Run the L0B concatenation of available DISDRODB stations.
-
-    This function allow to launch the processing of many DISDRODB stations with a single command.
-    From the list of all available DISDRODB stations, it runs the processing of the
-    stations matching the provided data_sources, campaign_names and station_names.
-
-    Parameters
-    ----------
-
-    data_sources : str
-        Name of data source(s) to process.
-        The name(s) must be UPPER CASE.
-        If campaign_names and station are not specified, process all stations.
-        To specify multiple data sources, write i.e.: --data_sources 'GPM EPFL NCAR'
-    campaign_names : str
-        Name of the campaign(s) to process.
-        The name(s) must be UPPER CASE.
-        To specify multiple campaigns, write i.e.: --campaign_names 'IPEX IMPACTS'
-    station_names : str
-        Station names.
-        To specify multiple stations, write i.e.: --station_names 'station1 station2'
-    remove_l0b : bool
-        If true, remove all source L0B files once L0B concatenation is terminated.
-        The default is False.
-    verbose : bool
-        Whether to print detailed processing information into terminal.
-        The default is False.
-    base_dir : str
-        Base directory of DISDRODB
-        Format: <...>/DISDRODB
-        If not specified, uses path specified in the DISDRODB active configuration.
-    """
-    from disdrodb.l0.routines import run_disdrodb_l0b_concat
-
-    # Parse data_sources, campaign_names and station arguments
-    base_dir = parse_base_dir(base_dir)
-    data_sources = parse_arg_to_list(data_sources)
-    campaign_names = parse_arg_to_list(campaign_names)
-    station_names = parse_arg_to_list(station_names)
-
-    # Run concatenation
-    run_disdrodb_l0b_concat(
-        base_dir=base_dir,
-        data_sources=data_sources,
-        campaign_names=campaign_names,
-        station_names=station_names,
-        remove_l0b=remove_l0b,
-        verbose=verbose,
-    )

disdrodb/l0/scripts/disdrodb_run_l0b_concat_station.py

@@ -1,85 +0,0 @@
-# -----------------------------------------------------------------------------.
-# 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/>.
-# -----------------------------------------------------------------------------.
-##################################################
-## Wrapper to concat L0B files by command lines ##
-##################################################
-import sys
-
-import click
-
-from disdrodb.l0.routines import click_l0b_concat_options
-from disdrodb.utils.scripts import (
-    click_base_dir_option,
-    click_station_arguments,
-    parse_base_dir,
-)
-
-sys.tracebacklimit = 0  # avoid full traceback error if occur
-
-
-@click.command()
-@click_station_arguments
-@click_l0b_concat_options
-@click_base_dir_option
-def disdrodb_run_l0b_concat_station(
-    # Station arguments
-    data_source: str,
-    campaign_name: str,
-    station_name: str,
-    # L0B concat options
-    remove_l0b=False,
-    verbose=True,
-    base_dir: str = None,
-):
-    """Concatenation all L0B files of a specific DISDRODB station into a single netCDF.
-
-    Parameters
-    ----------
-
-    data_source : str
-        Institution name (when campaign data spans more than 1 country),
-        or country (when all campaigns (or sensor networks) are inside a given country).
-        Must be UPPER CASE.
-    campaign_name : str
-        Campaign name. Must be UPPER CASE.
-    station_name : str
-        Station name
-    remove_l0b : bool
-        If true, remove all source L0B files once L0B concatenation is terminated.
-        The default is False.
-    verbose : bool
-        Whether to print detailed processing information into terminal.
-        The default is False.
-    base_dir : str
-        Base directory of DISDRODB
-        Format: <...>/DISDRODB
-        If not specified, uses path specified in the DISDRODB active configuration.
-    """
-    from disdrodb.l0.l0_processing import run_l0b_concat_station
-
-    base_dir = parse_base_dir(base_dir)
-
-    run_l0b_concat_station(
-        # Station arguments
-        data_source=data_source,
-        campaign_name=campaign_name,
-        station_name=station_name,
-        # Processing options
-        remove_l0b=remove_l0b,
-        verbose=verbose,
-        base_dir=base_dir,
-    )