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

disdrodb/__init__.py

@@ -1,43 +1,160 @@
+# -----------------------------------------------------------------------------.
+# 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/>.
+# -----------------------------------------------------------------------------.
+"""DISDRODB software."""
+
+import contextlib
+import importlib
 import os
 from importlib.metadata import PackageNotFoundError, version
 
 from disdrodb._config import config  # noqa
 from disdrodb.api.configs import available_sensor_names
 from disdrodb.api.io import (
+    find_files,
+    open_dataset,
+    open_logs_directory,
+    open_metadata_directory,
+    open_product_directory,
+)
+from disdrodb.api.search import (
     available_campaigns,
     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.data_transfer.download_data import download_archive, download_station
 from disdrodb.docs import open_documentation, open_sensor_documentation
-from disdrodb.metadata import read_station_metadata
+from disdrodb.l0.l0_reader import available_readers, get_reader, get_station_reader
+from disdrodb.metadata import download_metadata_archive, read_metadata_archive, read_station_metadata
 from disdrodb.metadata.checks import (
-    check_archive_metadata_compliance,
-    check_archive_metadata_geolocation,
+    check_metadata_archive,
+    check_metadata_archive_geolocation,
+    check_station_metadata,
 )
+from disdrodb.routines import (
+    run_l0,
+    run_l0_station,
+    run_l0a,
+    run_l0a_station,
+    run_l0b,
+    run_l0b_station,
+    run_l0c,
+    run_l0c_station,
+    run_l1,
+    run_l1_station,
+    run_l2e,
+    run_l2e_station,
+    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"]
+IMPACT_SENSORS = ["RD80"]
+
+
+PRODUCTS = ["RAW", "L0A", "L0B", "L0C", "L1", "L2E", "L2M"]
+
+
+def available_products():
+    """Return the list of available DISDRODB 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__ = [
-    "define_configs",
-    "available_stations",
     "available_campaigns",
     "available_data_sources",
+    "available_readers",
     "available_sensor_names",
-    "check_archive_metadata_compliance",
-    "check_archive_metadata_geolocation",
+    "available_stations",
+    "check_metadata_archive",
+    "check_metadata_archive_geolocation",
+    "check_station_metadata",
+    "define_configs",
+    "download_archive",
+    "download_metadata_archive",
+    "download_station",
+    "find_files",
+    "get_data_archive_dir",
+    "get_metadata_archive_dir",
+    "get_reader",
+    "get_station_reader",
+    "open_dataset",
     "open_documentation",
+    "open_logs_directory",
+    "open_metadata_directory",
+    "open_product_directory",
     "open_sensor_documentation",
-    "open_documentation",
+    "read_metadata_archive",
     "read_station_metadata",
-    "download_archive",
-    "download_station",
+    # Functions invoking the disdrodb_run_* scripts in the terminals
+    "run_l0",
+    "run_l0_station",
+    "run_l0a",
+    "run_l0a_station",
+    "run_l0b",
+    "run_l0b_station",
+    "run_l0c",
+    "run_l0c_station",
+    "run_l1",
+    "run_l1_station",
+    "run_l2e",
+    "run_l2e_station",
+    "run_l2m",
+    "run_l2m_station",
 ]
 
-__root_path__ = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))  # noqa
+
+__root_path__ = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
+
+
+def is_pytmatrix_available():
+    """Check if the pytmatrix package is correctly installed and available."""
+    try:
+        import pytmatrix
+    except Exception:
+        return False
+    return hasattr(pytmatrix, "psd")
+
 
 # Get version
-try:
+with contextlib.suppress(PackageNotFoundError):
     __version__ = version("disdrodb")
-except PackageNotFoundError:
-    # package is not installed
-    pass

disdrodb/_config.py

@@ -26,7 +26,7 @@ from disdrodb.configs import read_disdrodb_configs
 
 
 def _get_disdrodb_default_configs():
-    """Retrieve the default DISDRODB settings from the .config_disdrodb.yml file."""
+    """Retrieve the default DISDRODB settings from the ``.config_disdrodb.yml`` file."""
     try:
         config_dict = read_disdrodb_configs()
         config_dict = {key: value for key, value in config_dict.items() if value is not None}
@@ -36,9 +36,11 @@ def _get_disdrodb_default_configs():
 
 
 _CONFIG_DEFAULTS = {
-    "base_dir": None,
+    "data_archive_dir": None,
+    "metadata_archive_dir": None,
     "zenodo_sandbox_token": None,
     "zenodo_token": None,
+    "folder_partitioning": "year/month",
 }
 _CONFIG_DEFAULTS.update(_get_disdrodb_default_configs())
 

disdrodb/_version.py

@@ -1,8 +1,13 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
 else:
     VERSION_TUPLE = object
@@ -12,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.0.21'
-__version_tuple__ = version_tuple = (0, 0, 21)
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)