disdrodb 0.1.4__py3-none-any.whl → 0.2.0__py3-none-any.whl

disdrodb/cli/disdrodb_create_summary.py

@@ -39,6 +39,14 @@ sys.tracebacklimit = 0  # avoid full traceback error if occur
 @click_data_archive_dir_option
 @click_metadata_archive_dir_option
 @click.option("-p", "--parallel", type=bool, show_default=True, default=False, help="Read files in parallel")
+@click.option(
+    "-t",
+    "--temporal_resolution",
+    type=str,
+    show_default=True,
+    default="1MIN",
+    help="Temporal resolution of the L2E product to be used for the summary.",
+)
 def disdrodb_create_summary(
     # Stations options
     data_sources: Optional[str] = None,
@@ -46,6 +54,7 @@ def disdrodb_create_summary(
     station_names: Optional[str] = None,
     # Processing options:
     parallel=False,
+    temporal_resolution="1MIN",
     # DISDRODB root directories
     data_archive_dir: Optional[str] = None,
     metadata_archive_dir: Optional[str] = None,
@@ -58,7 +67,7 @@ def disdrodb_create_summary(
         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'
+        To specify multiple data sources, write i.e.: --data_sources 'NASA EPFL NCAR'
     campaign_names : str
         Name of the campaign(s) for which to create stations summaries.
         The name(s) must be UPPER CASE.
@@ -92,6 +101,7 @@ def disdrodb_create_summary(
         station_names=station_names,
         # Options
         parallel=parallel,
+        temporal_resolution=temporal_resolution,
         # DISDRODB root directory
         data_archive_dir=data_archive_dir,
         metadata_archive_dir=metadata_archive_dir,

disdrodb/cli/disdrodb_create_summary_station.py

@@ -36,6 +36,14 @@ sys.tracebacklimit = 0  # avoid full traceback error if occur
 @click_station_arguments
 @click_data_archive_dir_option
 @click.option("-p", "--parallel", type=bool, show_default=True, default=False, help="Read files in parallel")
+@click.option(
+    "-t",
+    "--temporal_resolution",
+    type=str,
+    show_default=True,
+    default="1MIN",
+    help="Temporal resolution of the L2E product to be used for the summary.",
+)
 def disdrodb_create_summary_station(
     # Station arguments
     data_source: str,
@@ -43,6 +51,7 @@ def disdrodb_create_summary_station(
     station_name: str,
     # Processing options:
     parallel=False,
+    temporal_resolution="1MIN",
     # DISDRODB root directories
     data_archive_dir: Optional[str] = None,
 ):
@@ -81,6 +90,7 @@ def disdrodb_create_summary_station(
         station_name=station_name,
         # Options
         parallel=parallel,
+        temporal_resolution=temporal_resolution,
         # DISDRODB root directory
         data_archive_dir=data_archive_dir,
     )

disdrodb/cli/disdrodb_run_l0.py

@@ -75,7 +75,7 @@ def disdrodb_run_l0(
         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'
+        To specify multiple data sources, write i.e.: --data_sources 'NASA EPFL NCAR'
     campaign_names : str
         Name of the campaign(s) to process.
         The name(s) must be UPPER CASE.

disdrodb/cli/disdrodb_run_l0a.py

@@ -65,7 +65,7 @@ def disdrodb_run_l0a(
         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'
+        To specify multiple data sources, write i.e.: --data_sources 'NASA EPFL NCAR'
     campaign_names : str
         Name of the campaign(s) to process.
         The name(s) must be UPPER CASE.

disdrodb/cli/disdrodb_run_l0b.py

@@ -68,7 +68,7 @@ def disdrodb_run_l0b(
         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'
+        To specify multiple data sources, write i.e.: --data_sources 'NASA EPFL NCAR'
     campaign_names : str
         Name of the campaign(s) to process.
         The name(s) must be UPPER CASE.

disdrodb/cli/disdrodb_run_l0c.py

@@ -69,7 +69,7 @@ def disdrodb_run_l0c(
         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'
+        To specify multiple data sources, write i.e.: --data_sources 'NASA EPFL NCAR'
     campaign_names : str
         Name of the campaign(s) to process.
         The name(s) must be UPPER CASE.

disdrodb/cli/disdrodb_run_l1.py

@@ -65,7 +65,7 @@ def disdrodb_run_l1(
         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'
+        To specify multiple data sources, write i.e.: --data_sources 'NASA EPFL NCAR'
     campaign_names : str
         Name of the campaign(s) to process.
         The name(s) must be UPPER CASE.

disdrodb/cli/disdrodb_run_l2e.py

@@ -65,7 +65,7 @@ def disdrodb_run_l2e(
         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'
+        To specify multiple data sources, write i.e.: --data_sources 'NASA EPFL NCAR'
     campaign_names : str
         Name of the campaign(s) to process.
         The name(s) must be UPPER CASE.

disdrodb/cli/disdrodb_run_l2m.py

@@ -65,7 +65,7 @@ def disdrodb_run_l2m(
         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'
+        To specify multiple data sources, write i.e.: --data_sources 'NASA EPFL NCAR'
     campaign_names : str
         Name of the campaign(s) to process.
         The name(s) must be UPPER CASE.

disdrodb/configs.py

@@ -37,7 +37,7 @@ def define_configs(
     data_archive_dir: Optional[str] = None,
     metadata_archive_dir: Optional[str] = None,
     scattering_table_dir: Optional[str] = None,
-    configs_path: Optional[str] = None,
+    products_configs_dir: Optional[str] = None,
     folder_partitioning: Optional[str] = None,
     zenodo_token: Optional[str] = None,
     zenodo_sandbox_token: Optional[str] = None,
@@ -53,7 +53,7 @@ def define_configs(
         The directory path where the DISDRODB Metadata Archive is located.
     scattering_table_dir : str
         The directory path where to store DISDRODB T-Matrix scattering tables.
-    configs_path : str
+    products_configs_dir : str
         The directory path where the custom DISDRODB products configurations files are defined.
     folder_partitioning : str
         The folder partitioning scheme used in the DISDRODB Data Archive.
@@ -64,7 +64,7 @@ def define_configs(
         - "year/month/day": Files are stored under subdirectories by year, month and day (<station_dir>/2025/04/01).
         - "year/month_name": Files are stored under subdirectories by year and month name (<station_dir>/2025/April).
         - "year/quarter": Files are stored under subdirectories by year and quarter (<station_dir>/2025/Q2).
-    zenodo__token: str
+    zenodo_token: str
         Zenodo Access Token. It is required to upload stations data to Zenodo.
     zenodo_sandbox_token: str
         Zenodo Sandbox Access Token. It is required to upload stations data to Zenodo Sandbox.
@@ -118,8 +118,8 @@ def define_configs(
     if zenodo_sandbox_token is not None:
         config_dict["zenodo_sandbox_token"] = zenodo_sandbox_token
 
-    if configs_path is not None:
-        config_dict["configs_path"] = configs_path
+    if products_configs_dir is not None:
+        config_dict["products_configs_dir"] = products_configs_dir
 
     # Write the DISDRODB config file
     write_yaml(config_dict, filepath, sort_keys=False)
@@ -238,105 +238,52 @@ def get_zenodo_token(sandbox: bool):
     return token
 
 
-def get_product_default_configs_path():
-    """Return the paths where DISDRODB products configuration files are stored."""
+def get_default_products_configs_dir():
+    """Return the directory path where DISDRODB products default configuration files are stored."""
     import disdrodb
 
-    configs_path = os.path.join(disdrodb.__root_path__, "disdrodb", "etc", "products")
-    return configs_path
+    products_configs_dir = os.path.join(disdrodb.package_dir, "etc", "products")
+    return products_configs_dir
 
 
-def check_availability_radar_simulations(options):
-    """Check radar simulations are possible for L2E and L2M products."""
+def get_products_configs_dir():
+    """Return the DISDRODB products configuration directory."""
     import disdrodb
 
-    if "radar_enabled" in options and not disdrodb.is_pytmatrix_available():
-        options["radar_enabled"] = False
-    return options
+    if os.environ.get("PYTEST_CURRENT_TEST"):
+        products_configs_dir = os.path.join(disdrodb.package_dir, "tests", "products")
+    else:
+        products_configs_dir = disdrodb.config.get("products_configs_dir", None)
+        if products_configs_dir is None:
+            products_configs_dir = get_default_products_configs_dir()
+    return products_configs_dir
 
 
-def copy_product_default_configs(configs_path):
+def copy_default_products_configs(products_configs_dir):
     """Copy the default DISDRODB products configuration directory to a custom location.
 
-    This function duplicates the entire directory of default product settings
+    This function duplicates the entire directory of default products settings
     (located at ``disdrodb/etc/products``) into the user-specified
-    ``configs_path``. Once copied, you can safely edit these files without
+    ``products_configs_dir``. Once copied, you can safely edit these files without
     modifying the library's built-in defaults. To have DISDRODB use your
     custom settings, point the global configuration at this new directory
-    (e.g by specifying ``configs_path`` with the ``disdrodb.define_configs`` function).
+    (e.g by specifying ``products_configs_dir`` with the ``disdrodb.define_configs`` function).
 
     Parameters
     ----------
-    configs_path:
-        Destination directory where the default product configuration files
+    products_configs_dir:
+        Directory where the default products configuration files
         will be copied. This directory must not already exist, and later
         needs to be referenced in your DISDRODB global configuration.
 
     Returns
     -------
-    configs_path
+    products_configs_dir
         The path to the newly created custom product configuration directory.
 
     """
-    source_dir_path = get_product_default_configs_path()
-    if os.path.exists(configs_path):
-        raise FileExistsError(f"The {configs_path} directory already exists!")
-    configs_path = shutil.copytree(source_dir_path, configs_path)
-    return configs_path
-
-
-def get_product_options(product, temporal_resolution=None):
-    """Get options for DISDRODB products."""
-    import disdrodb
-    from disdrodb.api.checks import check_product
-
-    # Define configs path
-    if os.environ.get("PYTEST_CURRENT_TEST"):
-        configs_path = os.path.join(disdrodb.__root_path__, "disdrodb", "tests", "products")
-    else:
-        configs_path = disdrodb.config.get("configs_path", get_product_default_configs_path())
-
-    # Validate DISDRODB products configuration
-    validate_product_configuration(configs_path)
-
-    # Check product
-    check_product(product)
-
-    # Retrieve global product options
-    global_options = read_yaml(os.path.join(configs_path, product, "global.yaml"))
-    if temporal_resolution is None:
-        global_options = check_availability_radar_simulations(global_options)
-        return global_options
-
-    # If temporal resolutions are specified, drop 'temporal_resolutions' key
-    global_options.pop("temporal_resolutions", None)
-    custom_options_path = os.path.join(configs_path, product, f"{temporal_resolution}.yaml")
-    if not os.path.exists(custom_options_path):
-        return global_options
-    custom_options = read_yaml(custom_options_path)
-    options = global_options.copy()
-    options.update(custom_options)
-    options = check_availability_radar_simulations(options)
-    return options
-
-
-def get_product_temporal_resolutions(product):
-    """Get DISDRODB L2 product temporal aggregations."""
-    # Check only L2E and L2M
-    return get_product_options(product)["temporal_resolutions"]
-
-
-def get_model_options(product, model_name):
-    """Get DISDRODB L2M model options."""
-    import disdrodb
-
-    configs_path = disdrodb.config.get("configs_path", get_product_default_configs_path())
-    model_options_path = os.path.join(configs_path, product, f"{model_name}.yaml")
-    model_options = read_yaml(model_options_path)
-    return model_options
-
-
-def validate_product_configuration(configs_path):
-    """Validate the DISDRODB products configuration files."""
-    # TODO: Implement validation of DISDRODB products configuration files with pydantic
-    pass
+    source_dir_path = get_default_products_configs_dir()
+    if os.path.exists(products_configs_dir):
+        raise FileExistsError(f"The {products_configs_dir} directory already exists!")
+    products_configs_dir = shutil.copytree(source_dir_path, products_configs_dir)
+    return products_configs_dir

disdrodb/constants.py

@@ -41,14 +41,15 @@ COORDINATES = [
     "time",
     "sample_interval",
 ]
-OPTICAL_SENSORS = ["PARSIVEL", "PARSIVEL2", "LPM", "PWS100"]
+OPTICAL_SENSORS = ["PARSIVEL", "PARSIVEL2", "LPM", "PWS100", "SWS250"]
 IMPACT_SENSORS = ["RD80"]
 
 PRODUCTS = ["RAW", "L0A", "L0B", "L0C", "L1", "L2E", "L2M"]
 
 PRODUCTS_ARGUMENTS = {
-    "L2E": ["rolling", "sample_interval"],
-    "L2M": ["rolling", "sample_interval", "model_name"],
+    "L1": ["temporal_resolution"],
+    "L2E": ["temporal_resolution"],
+    "L2M": ["temporal_resolution", "model_name"],
 }
 
 PRODUCTS_REQUIREMENTS = {

disdrodb/data_transfer/download_data.py

@@ -166,8 +166,8 @@ def download_archive(
                 metadata_archive_dir=metadata_archive_dir,
                 force=force,
             )
-        except Exception:
-            print(" - Download error: {e}")
+        except Exception as e:
+            print(f" - Download error: {e}")
             print(" ")
 
 
@@ -397,6 +397,8 @@ def build_webserver_wget_command(url: str, cut_dirs: int, dst_dir: str, force: b
         "-r",
         "-np",
         "-nH",
+        "--reject",
+        "index.html*",  # avoid to download Apache autoindex index.html
         f"--cut-dirs={cut_dirs}",
     ]
     if force:

disdrodb/docs.py

@@ -26,10 +26,10 @@ from disdrodb.api.checks import check_sensor_name
 
 def open_sensor_documentation(sensor_name):
     """Open the sensor documentation PDF in the browser."""
-    from disdrodb import __root_path__
+    from disdrodb import package_dir
 
     check_sensor_name(sensor_name)
-    docs_filepath = os.path.join(__root_path__, "disdrodb", "l0", "manuals", sensor_name + ".pdf")
+    docs_filepath = os.path.join(package_dir, "l0", "manuals", sensor_name + ".pdf")
     webbrowser.open(docs_filepath)
 
 

disdrodb/etc/products/L1/1MIN.yaml

@@ -0,0 +1,13 @@
+product_options:
+  fall_velocity_model: "Beard1976"
+  minimum_diameter: 0
+  maximum_diameter: 10
+  minimum_velocity: 0
+  maximum_velocity: 12
+  above_velocity_fraction: 0.5
+  above_velocity_tolerance: null
+  below_velocity_fraction: 0.5
+  below_velocity_tolerance: null
+  small_diameter_threshold: 1
+  small_velocity_threshold: 2.5
+  maintain_smallest_drops: True

disdrodb/etc/products/L1/LPM/1MIN.yaml

@@ -0,0 +1,13 @@
+product_options:
+  fall_velocity_model: "Beard1976"
+  minimum_diameter: 0
+  maximum_diameter: 10
+  minimum_velocity: 0
+  maximum_velocity: 12
+  above_velocity_fraction: 0.5
+  above_velocity_tolerance: null
+  below_velocity_fraction: 0.5
+  below_velocity_tolerance: null
+  small_diameter_threshold: 1
+  small_velocity_threshold: 2.5
+  maintain_smallest_drops: True

disdrodb/etc/products/L1/PARSIVEL/1MIN.yaml

@@ -0,0 +1,13 @@
+product_options:
+  fall_velocity_model: "Beard1976"
+  minimum_diameter: 0
+  maximum_diameter: 10
+  minimum_velocity: 0
+  maximum_velocity: 12
+  above_velocity_fraction: 0.6
+  above_velocity_tolerance: null
+  below_velocity_fraction: 0.6
+  below_velocity_tolerance: null
+  small_diameter_threshold: 1
+  small_velocity_threshold: 2.5
+  maintain_smallest_drops: True

disdrodb/etc/products/L1/PARSIVEL2/1MIN.yaml

@@ -0,0 +1,13 @@
+product_options:
+  fall_velocity_model: "Beard1976"
+  minimum_diameter: 0
+  maximum_diameter: 10
+  minimum_velocity: 0
+  maximum_velocity: 12
+  above_velocity_fraction: 0.5
+  above_velocity_tolerance: null
+  below_velocity_fraction: 0.5
+  below_velocity_tolerance: null
+  small_diameter_threshold: 1
+  small_velocity_threshold: 2.5
+  maintain_smallest_drops: True

disdrodb/etc/products/L1/PWS100/1MIN.yaml

@@ -0,0 +1,13 @@
+product_options:
+  fall_velocity_model: "Beard1976"
+  minimum_diameter: 0
+  maximum_diameter: 10
+  minimum_velocity: 0
+  maximum_velocity: 12
+  above_velocity_fraction: 0.5
+  above_velocity_tolerance: null
+  below_velocity_fraction: 0.5
+  below_velocity_tolerance: null
+  small_diameter_threshold: 1
+  small_velocity_threshold: 2.5
+  maintain_smallest_drops: True

disdrodb/etc/products/L1/RD80/1MIN.yaml

@@ -0,0 +1,13 @@
+product_options:
+  fall_velocity_model: "Beard1976"
+  minimum_diameter: 0
+  maximum_diameter: 10
+  minimum_velocity: 0
+  maximum_velocity: 12
+  above_velocity_fraction: 0.5
+  above_velocity_tolerance: null
+  below_velocity_fraction: 0.5
+  below_velocity_tolerance: null
+  small_diameter_threshold: 1
+  small_velocity_threshold: 2.5
+  maintain_smallest_drops: True

disdrodb/etc/products/L1/SWS250/1MIN.yaml

@@ -0,0 +1,13 @@
+product_options:
+  fall_velocity_model: "Beard1976"
+  minimum_diameter: 0
+  maximum_diameter: 10
+  minimum_velocity: 0
+  maximum_velocity: 12
+  above_velocity_fraction: 0.5
+  above_velocity_tolerance: null
+  below_velocity_fraction: 0.5
+  below_velocity_tolerance: null
+  small_diameter_threshold: 1
+  small_velocity_threshold: 2.5
+  maintain_smallest_drops: True

disdrodb/etc/products/L1/global.yaml

@@ -1,5 +1,11 @@
+temporal_resolutions: ["1MIN", "5MIN", "10MIN", "ROLL1MIN", "5MIN"]
+archive_options:
+  strategy: time_block
+  strategy_options:
+    freq: day
+  folder_partitioning: "year"
 product_options:
-  fall_velocity_method: "Beard1976"
+  fall_velocity_model: "Beard1976"
   minimum_diameter: 0
   maximum_diameter: 10
   minimum_velocity: 0

disdrodb/etc/products/L2E/10MIN.yaml

@@ -1,12 +1 @@
-archive_options:
-  strategy: event
-  strategy_options:
-    min_drops: 5
-    neighbor_min_size: 2
-    neighbor_time_interval: "5MIN"
-    event_max_time_gap: "6H"
-    event_min_duration: "5MIN"
-    event_min_size: 3
-  folder_partitioning: "year/month"
-product_options:
-  minimum_ndrops: 0
+radar_enabled: True

disdrodb/etc/products/L2E/5MIN.yaml

@@ -0,0 +1 @@
+radar_enabled: True

disdrodb/etc/products/L2E/global.yaml

@@ -1,4 +1,4 @@
-temporal_resolutions: ["1MIN", "5MIN", "10MIN", "ROLL1MIN"]
+temporal_resolutions: ["1MIN"] # "5MIN", "10MIN", "ROLL1MIN"]
 archive_options:
   strategy: time_block
   strategy_options:

disdrodb/etc/products/L2M/MODELS/GAMMA_GS_ND_MAE.yaml

@@ -0,0 +1,6 @@
+psd_model: "GammaPSD"
+optimization: "GS"
+optimization_kwargs:
+  target: "ND"
+  transformation: "identity"
+  error_order: 1

disdrodb/etc/products/L2M/{GAMMA_ML.yaml → MODELS/GAMMA_ML.yaml}

@@ -1,7 +1,7 @@
 psd_model: "GammaPSD"
 optimization: "ML"
 optimization_kwargs:
-  init_method: "M346"
+  init_method: "None"
   probability_method: "cdf"
   likelihood: "multinomial"
   truncated_likelihood: True

disdrodb/etc/products/L2M/MODELS/LOGNORMAL_GS_LOG_ND_MAE.yaml

@@ -0,0 +1,6 @@
+psd_model: "LognormalPSD"
+optimization: "GS"
+optimization_kwargs:
+  target: "ND"
+  transformation: "log"
+  error_order: 1

disdrodb/etc/products/L2M/MODELS/LOGNORMAL_GS_ND_MAE.yaml

@@ -0,0 +1,6 @@
+psd_model: "LognormalPSD"
+optimization: "GS"
+optimization_kwargs:
+  target: "ND"
+  transformation: "identity"
+  error_order: 1

disdrodb/etc/products/L2M/MODELS/LOGNORMAL_ML.yaml

@@ -0,0 +1,8 @@
+psd_model: "LognormalPSD"
+optimization: "ML"
+optimization_kwargs:
+  init_method: "None"
+  probability_method: "cdf"
+  likelihood: "multinomial"
+  truncated_likelihood: True
+  optimizer: "Nelder-Mead"

disdrodb/etc/products/L2M/MODELS/NGAMMA_GS_R_MAE.yaml

@@ -0,0 +1,6 @@
+psd_model: "NormalizedGammaPSD"
+optimization: "GS"
+optimization_kwargs:
+  target: "R"
+  transformation: "identity"
+  error_order: 1

disdrodb/etc/products/L2M/global.yaml

@@ -1,12 +1,20 @@
-temporal_resolutions: ["1MIN", "5MIN", "10MIN"]
-models: ["GAMMA_ML", "NGAMMA_GS_LOG_ND_MAE"]
+temporal_resolutions: ["1MIN"] #, "5MIN", "10MIN"]
+models:
+  [
+    "GAMMA_ML",
+    "GAMMA_GS_ND_MAE",
+    "NGAMMA_GS_LOG_ND_MAE",
+    "NGAMMA_GS_ND_MAE",
+    "LOGNORMAL_ML",
+    "LOGNORMAL_GS_ND_MAE",
+  ]
 archive_options:
   strategy: time_block
   strategy_options:
     freq: month
   folder_partitioning: ""
 product_options:
-  fall_velocity_method: "Beard1976"
+  fall_velocity_model: "Beard1976"
   diameter_min: 0
   diameter_max: 10
   diameter_spacing: 0.05