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

disdrodb/metadata/standards.py

@@ -27,18 +27,19 @@ def get_valid_metadata_keys() -> list:
     list
         List of valid metadata keys
     """
-    # NOTE: When updating one of these keys, one need to update the yaml in/at:
-    # - the disdrodb-data repository
-    # - disdrodb/data/DISDRODB/Raw/DATA_SOURCE/CAMPAIGN_NAME/metadata/*.yml
-    # - disdrodb/tests/data/check_readers/DISDRODB/Raw/*/*/metadata/10.yml
-    # - disdrodb/tests/data/test_dir_structure/DISDRODB/Raw/DATA_SOURCE/CAMPAIGN_NAME/metadata/STATION_NAME.yml
+    # NOTE: When updating one of these keys, one need to update the yaml files in/at:
+    # - the DISDRODB-METADATA repository
+    # - disdrodb/data/DISDRODB/RAW/DATA_SOURCE/CAMPAIGN_NAME/metadata/*.yml
     list_attrs = [
         ## Mandatory fields
         "data_source",
         "campaign_name",
         "station_name",
         "sensor_name",
+        "measurement_interval",  # sampling_interval ? [in seconds]
+        # DISDRODB reader info
         "reader",
+        "raw_data_glob_pattern",
         "raw_data_format",  # 'txt', 'netcdf'
         "platform_type",  # 'fixed', 'mobile'
         ## DISDRODB keys
@@ -77,9 +78,7 @@ def get_valid_metadata_keys() -> list:
         "firmware_version",
         "sensor_beam_length",
         "sensor_beam_width",
-        "sensor_nominal_width",  # ?
-        ## effective_measurement_area ?  # 0.54 m^2
-        "measurement_interval",  # sampling_interval ? [in seconds]
+        "sensor_nominal_width",
         "calibration_sensitivity",
         "calibration_certification_date",
         "calibration_certification_url",

disdrodb/metadata/writer.py

@@ -36,7 +36,7 @@ def get_default_metadata_dict() -> dict:
     """
     # Get valid metadata keys
     list_attrs = get_valid_metadata_keys()
-    attrs = {key: "" for key in list_attrs}
+    attrs = dict.fromkeys(list_attrs, "")
 
     # Add default values for certain keys
     attrs["latitude"] = -9999
@@ -47,13 +47,16 @@ def get_default_metadata_dict() -> dict:
     return attrs
 
 
-def create_station_metadata(data_source, campaign_name, station_name, base_dir=None, product="RAW"):
+def create_station_metadata(metadata_archive_dir, data_source, campaign_name, station_name):
     """Write a default (semi-empty) YAML metadata file for a DISDRODB station.
 
     An error is raised if the file already exists !
 
     Parameters
     ----------
+    data_archive_dir : str, optional
+        The base directory of DISDRODB, expected in the format ``<...>/DISDRODB``.
+        If not specified, the path specified in the DISDRODB active configuration will be used.
     data_source : str
         The name of the institution (for campaigns spanning multiple countries) or
         the name of the country (for campaigns or sensor networks within a single country).
@@ -62,12 +65,6 @@ def create_station_metadata(data_source, campaign_name, station_name, base_dir=N
         The name of the campaign. Must be provided in UPPER CASE.
     station_name : str
         The name of the station.
-    base_dir : str, optional
-        The base directory of DISDRODB, expected in the format ``<...>/DISDRODB``.
-        If not specified, the path specified in the DISDRODB active configuration will be used.
-    product : str, optional
-        The DISDRODB product in which to search for the metadata file.
-        The default is "RAW".
 
     """
     # Define metadata filepath
@@ -75,16 +72,14 @@ def create_station_metadata(data_source, campaign_name, station_name, base_dir=N
         data_source=data_source,
         campaign_name=campaign_name,
         station_name=station_name,
-        base_dir=base_dir,
-        product=product,
-        check_exists=False,
+        metadata_archive_dir=metadata_archive_dir,
     )
     if os.path.exists(metadata_filepath):
         raise ValueError("A metadata YAML file already exists at {metadata_filepath}.")
 
     # Create metadata dir if not existing
-    metadata_dir = os.path.dirname(metadata_filepath)
-    os.makedirs(metadata_dir, exist_ok=True)
+    metadata_archive_dir = os.path.dirname(metadata_filepath)
+    os.makedirs(metadata_archive_dir, exist_ok=True)
 
     # Get default metadata dict
     metadata = get_default_metadata_dict()
@@ -99,4 +94,3 @@ def create_station_metadata(data_source, campaign_name, station_name, base_dir=N
     write_yaml(metadata, filepath=metadata_filepath, sort_keys=False)
 
     print(f"An empty default metadata YAML file for station {station_name} has been created .")
-    return None

disdrodb/psd/__init__.py

@@ -0,0 +1,38 @@
+# -----------------------------------------------------------------------------.
+# 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/>.
+# -----------------------------------------------------------------------------.
+"""Implement PSD model and fitting routines."""
+
+
+from disdrodb.psd.fitting import estimate_model_parameters
+from disdrodb.psd.models import (
+    ExponentialPSD,
+    GammaPSD,
+    LognormalPSD,
+    NormalizedGammaPSD,
+    available_psd_models,
+    create_psd,
+)
+
+__all__ = [
+    "ExponentialPSD",
+    "GammaPSD",
+    "LognormalPSD",
+    "NormalizedGammaPSD",
+    "available_psd_models",
+    "create_psd",
+    "estimate_model_parameters",
+]