disdrodb 0.2.1__py3-none-any.whl → 0.4.0__py3-none-any.whl

disdrodb/issue/__init__.py

@@ -1,7 +1,5 @@
-#!/usr/bin/env python3
-
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 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

disdrodb/issue/checks.py

@@ -1,7 +1,5 @@
-#!/usr/bin/env python3
-
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 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
@@ -17,6 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
 """Checks for issue YAML files."""
+
 import logging
 
 import numpy as np

disdrodb/issue/reader.py

@@ -1,7 +1,5 @@
-#!/usr/bin/env python3
-
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 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
@@ -17,6 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
 """Issue YAML File Reader."""
+
 import logging
 
 import yaml

disdrodb/issue/writer.py

@@ -1,7 +1,5 @@
-#!/usr/bin/env python3
-
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 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
@@ -20,7 +18,6 @@
 
 import logging
 import os
-from typing import Optional
 
 import yaml
 
@@ -52,7 +49,7 @@ def _write_issue_docs(f):
     )
 
 
-def write_issue(filepath: str, timesteps: Optional[list] = None, time_periods: Optional[list] = None) -> None:
+def write_issue(filepath: str, timesteps: list | None = None, time_periods: list | None = None) -> None:
     """Write the issue YAML file.
 
     Parameters

disdrodb/l0/__init__.py

@@ -1,5 +1,5 @@
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 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
@@ -15,6 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
 """DISDRODB L0 software."""
+
 from disdrodb.l0.l0_reader import available_readers, get_reader, get_station_reader
 from disdrodb.l0.l0a_processing import generate_l0a
 from disdrodb.l0.l0b_nc_processing import generate_l0b_from_nc

disdrodb/l0/check_configs.py

@@ -1,7 +1,5 @@
-#!/usr/bin/env python3
-
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 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
@@ -19,10 +17,9 @@
 """Check configuration files."""
 
 import os
-from typing import Optional, Union
 
 import numpy as np
-from pydantic import BaseModel, Field, ValidationError, field_validator, model_validator
+from pydantic import Field, field_validator, model_validator
 
 from disdrodb.api.configs import available_sensor_names, get_sensor_configs_dir, read_config_file
 from disdrodb.l0.standards import (
@@ -36,6 +33,7 @@ from disdrodb.l0.standards import (
     get_velocity_bin_width,
 )
 from disdrodb.utils.directories import list_files
+from disdrodb.utils.pydantic import CustomBaseModel
 
 CONFIG_FILES_LIST = [
     "bins_diameter.yml",
@@ -104,28 +102,24 @@ def check_variable_consistency(sensor_name: str) -> None:
             raise ValueError(msg)
 
 
-class SchemaValidationException(Exception):
-    """Exception raised when schema validation fails."""
-
-
-def _schema_error(object_to_validate: Union[str, list], schema: BaseModel, message) -> bool:
+def _schema_error(object_to_validate: str | list, schema: CustomBaseModel, message) -> bool:
     """Function that validate the schema of a given object with a given schema.
 
     Parameters
     ----------
     object_to_validate : Union[str,list]
         Object to validate.
-    schema : BaseModel
+    schema : CustomBaseModel
         Base model.
 
     """
     try:
         schema(**object_to_validate)
-    except ValidationError as e:
-        raise SchemaValidationException(f"Schema validation failed. {message} {e}")
+    except ValueError as e:
+        raise ValueError(f"{message} {e!s}") from None
 
 
-class L0BEncodingSchema(BaseModel):
+class L0BEncodingSchema(CustomBaseModel):
     """Pydantic model for DISDRODB netCDF encodings."""
 
     contiguous: bool
@@ -134,8 +128,10 @@ class L0BEncodingSchema(BaseModel):
     complevel: int
     shuffle: bool
     fletcher32: bool
-    FillValue: Optional[Union[int, float]] = Field(default=None, alias="_FillValue")
-    chunksizes: Optional[Union[int, list[int]]]
+    FillValue: int | float | None = Field(default=None, alias="_FillValue")
+    chunksizes: int | list[int] | None
+    add_offset: float | None = None
+    scale_factor: float | None = None
 
     # if contiguous=False, chunksizes specified, otherwise should be not !
     @model_validator(mode="before")
@@ -200,6 +196,17 @@ class L0BEncodingSchema(BaseModel):
 
         return values
 
+    @model_validator(mode="after")
+    def remove_offset_and_scale_if_not_int(self):
+        """Ensure add_offset and scale_factor only apply to integer/uint dtypes."""
+        integer_types = {"int8", "int16", "int32", "int64", "uint8", "uint16", "uint32", "uint64"}
+
+        if self.dtype not in integer_types:
+            self.add_offset = None
+            self.scale_factor = None
+
+        return self
+
 
 def check_l0b_encoding(sensor_name: str) -> None:
     """Check ``l0b_encodings.yml`` file based on the schema defined in the class ``L0BEncodingSchema``.
@@ -216,7 +223,7 @@ def check_l0b_encoding(sensor_name: str) -> None:
         _schema_error(
             object_to_validate=value,
             schema=L0BEncodingSchema,
-            message=f"Sensore name : {sensor_name}. Key : {key}.",
+            message=f"Invalid {sensor_name} L0B Encoding YAML file '{key}' settings.",
         )
 
 
@@ -243,19 +250,19 @@ def check_l0a_encoding(sensor_name: str) -> None:
             raise TypeError(f"Expecting a string for {key} in l0a_encodings.yml for sensor {sensor_name}.")
 
 
-class RawDataFormatSchema(BaseModel):
+class RawDataFormatSchema(CustomBaseModel):
     """Pydantic model for the DISDRODB RAW Data Format YAML files."""
 
-    n_digits: Optional[int]
-    n_characters: Optional[int]
-    n_decimals: Optional[int]
-    n_naturals: Optional[int]
-    data_range: Optional[list[float]]
-    nan_flags: Optional[Union[int, float, str]] = None
-    valid_values: Optional[list[float]] = None
-    dimension_order: Optional[list[str]] = None
-    n_values: Optional[int] = None
-    field_number: Optional[str] = None
+    n_digits: int | None
+    n_characters: int | None
+    n_decimals: int | None
+    n_naturals: int | None
+    data_range: list[float] | None
+    nan_flags: int | float | str | None = None
+    valid_values: list[float] | None = None
+    dimension_order: list[str] | None = None
+    n_values: int | None = None
+    field_number: str | None = None
 
     @field_validator("data_range")
     def check_list_length(cls, value):
@@ -282,7 +289,7 @@ def check_raw_data_format(sensor_name: str) -> None:
         _schema_error(
             object_to_validate=value,
             schema=RawDataFormatSchema,
-            message=f"Sensore name : {sensor_name}. Key : {key}.",
+            message=f"Invalid {sensor_name} RawDataFormat YAML file '{key}' settings.",
         )
 
 

disdrodb/l0/check_standards.py

@@ -1,7 +1,5 @@
-#!/usr/bin/env python3
-
 # -----------------------------------------------------------------------------.
-# Copyright (c) 2021-2023 DISDRODB developers
+# Copyright (c) 2021-2026 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
@@ -18,7 +16,6 @@
 # -----------------------------------------------------------------------------.
 """Check data standards."""
 
-
 import logging
 
 import numpy as np

disdrodb/l0/configs/LPM/l0a_encodings.yml

@@ -53,23 +53,23 @@ number_particles_min_diameter_internal_data: "float32"
 number_particles_no_hydrometeor: "float32" # 'uint16'
 number_particles_no_hydrometeor_internal_data: "float32"
 number_particles_unknown_classification: "float32" # 'uint16'
-number_particles_unknown_classification_internal_data: "float32"
-number_particles_class_1: "float32" #  'uint16'
-number_particles_class_1_internal_data: "float32"
-number_particles_class_2: "float32" # 'uint16'
-number_particles_class_2_internal_data: "float32"
-number_particles_class_3: "float32" # 'uint16'
-number_particles_class_3_internal_data: "float32"
-number_particles_class_4: "float32" # 'uint16'
-number_particles_class_4_internal_data: "float32"
-number_particles_class_5: "float32" # 'uint16'
-number_particles_class_5_internal_data: "float32"
-number_particles_class_6: "float32" # 'uint16'
-number_particles_class_6_internal_data: "float32"
-number_particles_class_7: "float32" # 'uint16'
-number_particles_class_7_internal_data: "float32"
-number_particles_class_8: "float32" # 'uint16'
-number_particles_class_8_internal_data: "float32"
+total_gross_volume_unknown_classification: "float32"
+number_particles_hail: "float32" #  'uint16'
+total_gross_volume_hail: "float32"
+number_particles_solid_precipitation: "float32" # 'uint16'
+total_gross_volume_solid_precipitation: "float32"
+number_particles_large_pellet: "float32" # 'uint16'
+total_gross_volume_large_pellet: "float32"
+number_particles_small_pellet: "float32" # 'uint16'
+total_gross_volume_small_pellet: "float32"
+number_particles_snowgrain: "float32" # 'uint16'
+total_gross_volume_snowgrain: "float32"
+number_particles_rain: "float32" # 'uint16'
+total_gross_volume_rain: "float32"
+number_particles_small_rain: "float32" # 'uint16'
+total_gross_volume_small_rain: "float32"
+number_particles_drizzle: "float32" # 'uint16'
+total_gross_volume_drizzle: "float32"
 number_particles_class_9: "float32" # 'uint16'
 number_particles_class_9_internal_data: "float32"
 raw_drop_number: "str"

disdrodb/l0/configs/LPM/l0b_cf_attrs.yml

@@ -224,81 +224,81 @@ number_particles_unknown_classification:
   description: Number of particles with unknown classification
   long_name: Number of particles with unknown classification
   units: ""
-number_particles_unknown_classification_internal_data:
-  description: Total volume (gross) of this class
-  long_name: Number of particles with unknown classification internal data
+total_gross_volume_unknown_classification:
+  description: Total (gross) volume of particles classified as unknown
+  long_name: Total (gross) volume of particles classified as unknown
   units: ""
-number_particles_class_1:
-  description: Number of particles class 1
-  long_name: Number of particles class 1
+number_particles_hail:
+  description: Number of particles classified as hail
+  long_name: Number of particles classified as hail
   units: ""
-number_particles_class_1_internal_data:
-  description: Total volume (gross) of class 1
-  long_name: Total volume of class 1
+total_gross_volume_hail:
+  description: Total (gross) volume of particles classified as hail
+  long_name: Total (gross) volume of particles classified as hail
   units: ""
-number_particles_class_2:
-  description: Number of particles class 2
-  long_name: Number of particles class 2
+number_particles_solid_precipitation:
+  description: Number of particles classified as solid precipitation
+  long_name: Number of particles classified as solid precipitation
   units: ""
-number_particles_class_2_internal_data:
-  description: Total volume (gross) of class 2
-  long_name: Total volume of class 2
+total_gross_volume_solid_precipitation:
+  description: Total (gross) volume of particles classified as solid precipitation
+  long_name: Total (gross) volume of particles classified as solid precipitation
   units: ""
-number_particles_class_3:
-  description: Number of particles class 3
-  long_name: Number of particles class 3
+number_particles_large_pellet:
+  description: Number of particles classified as great pellet
+  long_name: Number of particles classified as great pellet
   units: ""
-number_particles_class_3_internal_data:
-  description: Total volume (gross) of class 3
-  long_name: Total volume of class 3
+total_gross_volume_large_pellet:
+  description: Total (gross) volume of particles classified as great pellet
+  long_name: Total (gross) volume of particles classified as great pellet
   units: ""
-number_particles_class_4:
-  description: Number of particles class 4
-  long_name: Number of particles class 4
+number_particles_small_pellet:
+  description: Number of particles classified as small pellet
+  long_name: Number of particles classified as small pellet
   units: ""
-number_particles_class_4_internal_data:
-  description: Total volume (gross) of class 4
-  long_name: Total volume of class 4
+total_gross_volume_small_pellet:
+  description: Total (gross) volume of particles classified as small pellet
+  long_name: Total (gross) volume of particles classified as small pellet
   units: ""
-number_particles_class_5:
-  description: Number of particles class 5
-  long_name: Number of particles class 5
+number_particles_snowgrain:
+  description: Number of particles classified as snowgrain
+  long_name: Number of particles classified as snowgrain
   units: ""
-number_particles_class_5_internal_data:
-  description: Total volume (gross) of class 5
-  long_name: Total volume of class 5
+total_gross_volume_snowgrain:
+  description: Total (gross) volume of particles classified as snowgrain
+  long_name: Total (gross) volume of particles classified as snowgrain
   units: ""
-number_particles_class_6:
-  description: Number of particles class 6
-  long_name: Number of particles class 6
+number_particles_rain:
+  description: Number of particles classified as rain
+  long_name: Number of particles classified as rain
   units: ""
-number_particles_class_6_internal_data:
-  description: Total volume (gross) of class 6
-  long_name: Total volume of class 6
+total_gross_volume_rain:
+  description: Total (gross) volume of particles classified as rain
+  long_name: Total (gross) volume of particles classified as rain
   units: ""
-number_particles_class_7:
-  description: Number of particles class 7
-  long_name: Number of particles class 7
+number_particles_small_rain:
+  description: Number of particles classified as small rain
+  long_name: Number of particles classified as small rain
   units: ""
-number_particles_class_7_internal_data:
-  description: Total volume (gross) of class 7
-  long_name: Total volume of class 7
+total_gross_volume_small_rain:
+  description: Total (gross) volume of particles classified as small rain
+  long_name: Total (gross) volume of particles classified as small rain
   units: ""
-number_particles_class_8:
-  description: Number of particles class 8
-  long_name: Number of particles class 8
+number_particles_drizzle:
+  description: Number of particles classified as drizzle
+  long_name: Number of particles classified as drizzle
   units: ""
-number_particles_class_8_internal_data:
-  description: Total volume (gross) of class 8
-  long_name: Total volume of class 8
+total_gross_volume_drizzle:
+  description: Total (gross) volume of particles classified as drizzle
+  long_name: Total (gross) volume of particles classified as drizzle
   units: ""
 number_particles_class_9:
-  description: Number of particles class 9
-  long_name: Number of particles class 9
+  description: Number of particles for reserved class 9
+  long_name: Number of particles for reserved class 9
   units: ""
 number_particles_class_9_internal_data:
-  description: Total volume (gross) of class 9
-  long_name: Total volume of class 9
+  description: Total volume (gross) for reserved class 9
+  long_name: Total volume of reserved class 9
   units: ""
 raw_drop_number:
   description: Precipitation spectrum

disdrodb/l0/configs/LPM/l0b_encodings.yml

@@ -520,7 +520,7 @@ number_particles_unknown_classification:
   contiguous: false
   chunksizes: 5000
   _FillValue: 65535
-number_particles_unknown_classification_internal_data:
+total_gross_volume_unknown_classification:
   dtype: float32
   zlib: true
   complevel: 3
@@ -528,7 +528,7 @@ number_particles_unknown_classification_internal_data:
   fletcher32: false
   contiguous: false
   chunksizes: 5000
-number_particles_class_1:
+number_particles_hail:
   dtype: uint16
   zlib: true
   complevel: 3
@@ -537,7 +537,7 @@ number_particles_class_1:
   contiguous: false
   chunksizes: 5000
   _FillValue: 65535
-number_particles_class_1_internal_data:
+total_gross_volume_hail:
   dtype: float32
   zlib: true
   complevel: 3
@@ -545,7 +545,7 @@ number_particles_class_1_internal_data:
   fletcher32: false
   contiguous: false
   chunksizes: 5000
-number_particles_class_2:
+number_particles_solid_precipitation:
   dtype: uint16
   zlib: true
   complevel: 3
@@ -554,7 +554,7 @@ number_particles_class_2:
   contiguous: false
   chunksizes: 5000
   _FillValue: 65535
-number_particles_class_2_internal_data:
+total_gross_volume_solid_precipitation:
   dtype: float32
   zlib: true
   complevel: 3
@@ -562,7 +562,7 @@ number_particles_class_2_internal_data:
   fletcher32: false
   contiguous: false
   chunksizes: 5000
-number_particles_class_3:
+number_particles_large_pellet:
   dtype: uint16
   zlib: true
   complevel: 3
@@ -571,7 +571,7 @@ number_particles_class_3:
   contiguous: false
   chunksizes: 5000
   _FillValue: 65535
-number_particles_class_3_internal_data:
+total_gross_volume_large_pellet:
   dtype: float32
   zlib: true
   complevel: 3
@@ -579,7 +579,7 @@ number_particles_class_3_internal_data:
   fletcher32: false
   contiguous: false
   chunksizes: 5000
-number_particles_class_4:
+number_particles_small_pellet:
   dtype: uint16
   zlib: true
   complevel: 3
@@ -588,7 +588,7 @@ number_particles_class_4:
   contiguous: false
   chunksizes: 5000
   _FillValue: 65535
-number_particles_class_4_internal_data:
+total_gross_volume_small_pellet:
   dtype: float32
   zlib: true
   complevel: 3
@@ -596,7 +596,7 @@ number_particles_class_4_internal_data:
   fletcher32: false
   contiguous: false
   chunksizes: 5000
-number_particles_class_5:
+number_particles_snowgrain:
   dtype: uint16
   zlib: true
   complevel: 3
@@ -605,7 +605,7 @@ number_particles_class_5:
   contiguous: false
   chunksizes: 5000
   _FillValue: 65535
-number_particles_class_5_internal_data:
+total_gross_volume_snowgrain:
   dtype: float32
   zlib: true
   complevel: 3
@@ -613,7 +613,7 @@ number_particles_class_5_internal_data:
   fletcher32: false
   contiguous: false
   chunksizes: 5000
-number_particles_class_6:
+number_particles_rain:
   dtype: uint16
   zlib: true
   complevel: 3
@@ -622,7 +622,7 @@ number_particles_class_6:
   contiguous: false
   chunksizes: 5000
   _FillValue: 65535
-number_particles_class_6_internal_data:
+total_gross_volume_rain:
   dtype: float32
   zlib: true
   complevel: 3
@@ -630,7 +630,7 @@ number_particles_class_6_internal_data:
   fletcher32: false
   contiguous: false
   chunksizes: 5000
-number_particles_class_7:
+number_particles_small_rain:
   dtype: uint16
   zlib: true
   complevel: 3
@@ -639,7 +639,7 @@ number_particles_class_7:
   contiguous: false
   chunksizes: 5000
   _FillValue: 65535
-number_particles_class_7_internal_data:
+total_gross_volume_small_rain:
   dtype: float32
   zlib: true
   complevel: 3
@@ -647,7 +647,7 @@ number_particles_class_7_internal_data:
   fletcher32: false
   contiguous: false
   chunksizes: 5000
-number_particles_class_8:
+number_particles_drizzle:
   dtype: uint16
   zlib: true
   complevel: 3
@@ -656,7 +656,7 @@ number_particles_class_8:
   contiguous: false
   chunksizes: 5000
   _FillValue: 65535
-number_particles_class_8_internal_data:
+total_gross_volume_drizzle:
   dtype: float32
   zlib: true
   complevel: 3