disdrodb 0.1.2__tar.gz → 0.1.4__tar.gz

{disdrodb-0.1.2/disdrodb.egg-info → disdrodb-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: disdrodb
-Version: 0.1.2
+Version: 0.1.4
 Summary: disdrodb provides tools to download, standardize, share and analyze global disdrometer data.
 Author: Gionata Ghiggi
 Project-URL: homepage, https://github.com/ltelab/disdrodb
@@ -33,6 +33,7 @@ Requires-Dist: numpy
 Requires-Dist: scipy
 Requires-Dist: dask[distributed]
 Requires-Dist: xarray
+Requires-Dist: matplotlib
 Provides-Extra: dev
 Requires-Dist: jupyter; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
@@ -190,9 +191,9 @@ disdrodb_run_l2e
 disdrodb_run_l2m
 ```
 
-### 💫 Analyze Analysis‐Ready Products
+### 💫 Analyze Analysis-Ready Products
 
-The software’s `open_dataset` function **lazily** opens all station files of a given product:
+The software's `open_dataset` function **lazily** opens all station files of a given product:
 
 ```python
 import disdrodb

{disdrodb-0.1.2 → disdrodb-0.1.4}/README.md

@@ -141,9 +141,9 @@ disdrodb_run_l2e
 disdrodb_run_l2m
 ```
 
-### 💫 Analyze Analysis‐Ready Products
+### 💫 Analyze Analysis-Ready Products
 
-The software’s `open_dataset` function **lazily** opens all station files of a given product:
+The software's `open_dataset` function **lazily** opens all station files of a given product:
 
 ```python
 import disdrodb

{disdrodb-0.1.2 → disdrodb-0.1.4}/disdrodb/__init__.py

@@ -17,10 +17,10 @@
 """DISDRODB software."""
 
 import contextlib
-import importlib
 import os
 from importlib.metadata import PackageNotFoundError, version
 
+import disdrodb.accessor  # noqa
 from disdrodb._config import config  # noqa
 from disdrodb.api.configs import available_sensor_names
 from disdrodb.api.io import (
@@ -35,11 +35,26 @@ from disdrodb.api.search import (
     available_data_sources,
     available_stations,
 )
-from disdrodb.configs import define_disdrodb_configs as define_configs
-from disdrodb.configs import get_data_archive_dir, get_metadata_archive_dir
+from disdrodb.configs import (
+    define_configs,
+    get_data_archive_dir,
+    get_metadata_archive_dir,
+    get_model_options,
+    get_product_options,
+    get_scattering_table_dir,
+)
 from disdrodb.data_transfer.download_data import download_archive, download_station
 from disdrodb.docs import open_documentation, open_sensor_documentation
-from disdrodb.l0.l0_reader import available_readers, get_reader, get_station_reader
+from disdrodb.l0 import (
+    available_readers,
+    generate_l0a,
+    generate_l0b,
+    generate_l0b_from_nc,
+    get_reader,
+    get_station_reader,
+)
+from disdrodb.l1 import generate_l1
+from disdrodb.l2 import generate_l2_radar, generate_l2e, generate_l2m
 from disdrodb.metadata import download_metadata_archive, read_metadata_archive, read_station_metadata
 from disdrodb.metadata.checks import (
     check_metadata_archive,
@@ -47,6 +62,8 @@ from disdrodb.metadata.checks import (
     check_station_metadata,
 )
 from disdrodb.routines import (
+    create_summary,
+    create_summary_station,
     run_l0,
     run_l0_station,
     run_l0a,
@@ -62,22 +79,25 @@ from disdrodb.routines import (
     run_l2m,
     run_l2m_station,
 )
-
-ARCHIVE_VERSION = "V0"
-SOFTWARE_VERSION = "V" + importlib.metadata.version("disdrodb")
-CONVENTIONS = "CF-1.10, ACDD-1.3"
-
-# Define coordinates names
-# TODO: make it configurable
-DIAMETER_COORDS = ["diameter_bin_center", "diameter_bin_width", "diameter_bin_lower", "diameter_bin_upper"]
-VELOCITY_COORDS = ["velocity_bin_center", "velocity_bin_width", "velocity_bin_lower", "velocity_bin_upper"]
-VELOCITY_DIMENSION = "velocity_bin_center"
-DIAMETER_DIMENSION = "diameter_bin_center"
-OPTICAL_SENSORS = ["PARSIVEL", "PARSIVEL2", "LPM", "PWS100"]
-IMPACT_SENSORS = ["RD80"]
-
-
-PRODUCTS = ["RAW", "L0A", "L0B", "L0C", "L1", "L2E", "L2M"]
+from disdrodb.utils.manipulations import convert_from_decibel as idecibel
+from disdrodb.utils.manipulations import convert_to_decibel as decibel
+
+from .constants import (
+    ARCHIVE_VERSION,
+    CONVENTIONS,
+    COORDINATES,
+    DIAMETER_COORDS,
+    DIAMETER_DIMENSION,
+    GEOLOCATION_COORDS,
+    IMPACT_SENSORS,
+    OPTICAL_SENSORS,
+    PRODUCTS,
+    PRODUCTS_ARGUMENTS,
+    PRODUCTS_REQUIREMENTS,
+    SOFTWARE_VERSION,
+    VELOCITY_COORDS,
+    VELOCITY_DIMENSION,
+)
 
 
 def available_products():
@@ -85,21 +105,21 @@ def available_products():
     return PRODUCTS
 
 
-PRODUCTS_ARGUMENTS = {
-    "L2E": ["rolling", "sample_interval"],
-    "L2M": ["rolling", "sample_interval", "model_name"],
-}
-
-PRODUCTS_REQUIREMENTS = {
-    "L0A": "RAW",
-    "L0B": "L0A",
-    "L0C": "L0B",
-    "L1": "L0C",
-    "L2E": "L1",
-    "L2M": "L2E",
-}
-
 __all__ = [
+    "ARCHIVE_VERSION",
+    "CONVENTIONS",
+    "COORDINATES",
+    "DIAMETER_COORDS",
+    "DIAMETER_DIMENSION",
+    "GEOLOCATION_COORDS",
+    "IMPACT_SENSORS",
+    "OPTICAL_SENSORS",
+    "PRODUCTS",
+    "PRODUCTS_ARGUMENTS",
+    "PRODUCTS_REQUIREMENTS",
+    "SOFTWARE_VERSION",
+    "VELOCITY_COORDS",
+    "VELOCITY_DIMENSION",
     "available_campaigns",
     "available_data_sources",
     "available_readers",
@@ -108,15 +128,29 @@ __all__ = [
     "check_metadata_archive",
     "check_metadata_archive_geolocation",
     "check_station_metadata",
+    "create_summary",
+    "create_summary_station",
+    "decibel",
     "define_configs",
     "download_archive",
     "download_metadata_archive",
     "download_station",
     "find_files",
+    "generate_l0a",
+    "generate_l0b",
+    "generate_l0b_from_nc",
+    "generate_l1",
+    "generate_l2_radar",
+    "generate_l2e",
+    "generate_l2m",
     "get_data_archive_dir",
     "get_metadata_archive_dir",
+    "get_model_options",
+    "get_product_options",
     "get_reader",
+    "get_scattering_table_dir",
     "get_station_reader",
+    "idecibel",
     "open_dataset",
     "open_documentation",
     "open_logs_directory",

{disdrodb-0.1.2 → disdrodb-0.1.4}/disdrodb/_config.py

@@ -22,13 +22,13 @@ See https://donfig.readthedocs.io/en/latest/configuration.html for more info.
 """
 from donfig import Config
 
-from disdrodb.configs import read_disdrodb_configs
+from disdrodb.configs import read_configs
 
 
-def _get_disdrodb_default_configs():
+def _get_default_configs():
     """Retrieve the default DISDRODB settings from the ``.config_disdrodb.yml`` file."""
     try:
-        config_dict = read_disdrodb_configs()
+        config_dict = read_configs()
         config_dict = {key: value for key, value in config_dict.items() if value is not None}
     except Exception:
         config_dict = {}
@@ -38,11 +38,12 @@ def _get_disdrodb_default_configs():
 _CONFIG_DEFAULTS = {
     "data_archive_dir": None,
     "metadata_archive_dir": None,
+    "scattering_table_dir": None,
     "zenodo_sandbox_token": None,
     "zenodo_token": None,
     "folder_partitioning": "year/month",
 }
-_CONFIG_DEFAULTS.update(_get_disdrodb_default_configs())
+_CONFIG_DEFAULTS.update(_get_default_configs())
 
 _CONFIG_PATHS = []
 

{disdrodb-0.1.2 → disdrodb-0.1.4}/disdrodb/_version.py

@@ -1,7 +1,14 @@
 # file generated by setuptools-scm
 # don't change, don't track in version control
 
-__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
 
 TYPE_CHECKING = False
 if TYPE_CHECKING:
@@ -9,13 +16,19 @@ if TYPE_CHECKING:
     from typing import Union
 
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
 
-__version__ = version = '0.1.2'
-__version_tuple__ = version_tuple = (0, 1, 2)
+__version__ = version = '0.1.4'
+__version_tuple__ = version_tuple = (0, 1, 4)
+
+__commit_id__ = commit_id = 'gdceb2f453'

disdrodb-0.1.4/disdrodb/accessor/__init__.py

@@ -0,0 +1,20 @@
+# -----------------------------------------------------------------------------.
+# 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/>.
+# -----------------------------------------------------------------------------.
+"""This directory defines DISDRODB xarray accessors."""
+from .methods import DISDRODB_DataArray_Accessor, DISDRODB_Dataset_Accessor
+
+__all__ = ["DISDRODB_DataArray_Accessor", "DISDRODB_Dataset_Accessor"]

disdrodb-0.1.4/disdrodb/accessor/methods.py

@@ -0,0 +1,125 @@
+# -----------------------------------------------------------------------------.
+# 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/>.
+# -----------------------------------------------------------------------------.
+"""This module defines DISDRODB xarray accessors."""
+import xarray as xr
+
+
+class DISDRODB_Base_Accessor:
+    """DISDRODB Xarray Base Accessor."""
+
+    def __init__(self, xarray_obj):
+        if not isinstance(xarray_obj, (xr.DataArray, xr.Dataset)):
+            raise TypeError("The 'gpm' accessor is available only for xarray.Dataset and xarray.DataArray.")
+        self._obj = xarray_obj
+
+    @property
+    def start_time(self):
+        """Return start time."""
+        from disdrodb.api.checks import check_time
+
+        if "time" in self._obj.coords:
+            start_time = self._obj["time"].to_numpy()[0]
+        else:
+            raise ValueError("Time coordinate not found")
+        return check_time(start_time)
+
+    @property
+    def end_time(self):
+        """Return end time."""
+        from disdrodb.api.checks import check_time
+
+        if "time" in self._obj.coords:
+            end_time = self._obj["time"].to_numpy()[-1]
+        else:
+            raise ValueError("Time coordinate not found")
+        return check_time(end_time)
+
+    @property
+    def sample_interval(self):
+        """Return the sample interval in seconds."""
+        from disdrodb.utils.time import ensure_sample_interval_in_seconds
+
+        if "sample_interval" not in self._obj.coords:
+            raise ValueError("The sample interval is not specified in the xarray object.")
+        return int(ensure_sample_interval_in_seconds(self._obj["sample_interval"].to_numpy()))
+
+    @property
+    def diameter_bin_edges(self):
+        """Return diameter bin edges."""
+        from disdrodb.utils.manipulations import get_diameter_bin_edges
+
+        return get_diameter_bin_edges(self._obj)
+
+    def regularize(self):
+        """Regularize timesteps."""
+        from disdrodb.utils.time import regularize_dataset
+
+        sample_interval = self._obj.disdrodb.sample_interval
+        return regularize_dataset(self._obj, freq=f"{sample_interval}s")
+
+    def isel(self, indexers=None, drop=False, **indexers_kwargs):
+        """Perform index-based dimension selection."""
+        from disdrodb.utils.subsetting import isel
+
+        return isel(self._obj, indexers=indexers, drop=drop, **indexers_kwargs)
+
+    def sel(self, indexers=None, drop=False, method=None, **indexers_kwargs):
+        """Perform value-based coordinate selection."""
+        from disdrodb.utils.subsetting import sel
+
+        return sel(self._obj, indexers=indexers, drop=drop, method=method, **indexers_kwargs)
+
+    def align(self, *args):
+        """Align DISDRODB products over time, velocity and diameter dimensions."""
+        from disdrodb.utils.subsetting import align
+
+        return align(self._obj, *args)
+
+
+@xr.register_dataset_accessor("disdrodb")
+class DISDRODB_Dataset_Accessor(DISDRODB_Base_Accessor):
+    """DISDRODB Xarray Dataset Accessor."""
+
+    def __init__(self, xarray_obj):
+        super().__init__(xarray_obj)
+
+    def resample(self, accumulation_interval, rolling=True):
+        """Resample a L1 or L2 DISDRODB Product."""
+        from disdrodb.l1.resampling import resample_dataset
+
+        sample_interval = self._obj.disdrodb.sample_interval
+        ds = resample_dataset(
+            self._obj,
+            sample_interval=sample_interval,
+            accumulation_interval=accumulation_interval,
+            rolling=rolling,
+        )
+        return ds
+
+    def plot_nd(self, **kwargs):
+        """Plot drop number concentration N(D) timeseries."""
+        from disdrodb.viz.plots import plot_nd
+
+        plot_nd(self._obj, **kwargs)
+
+
+@xr.register_dataarray_accessor("disdrodb")
+class DISDRODB_DataArray_Accessor(DISDRODB_Base_Accessor):
+    """DISDRODB Xarray DataArray Accessor."""
+
+    def __init__(self, xarray_obj):
+        super().__init__(xarray_obj)