cloudnetpy-qc 1.24.1__tar.gz → 1.30.0__tar.gz

{cloudnetpy_qc-1.24.1/cloudnetpy_qc.egg-info → cloudnetpy_qc-1.30.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudnetpy_qc
-Version: 1.24.1
+Version: 1.30.0
 Summary: Quality control routines for CloudnetPy products
 Author-email: Finnish Meteorological Institute <actris-cloudnet@fmi.fi>
 License: MIT License
@@ -28,12 +28,12 @@ License: MIT License
 Project-URL: Homepage, https://github.com/actris-cloudnet/cloudnetpy-qc
 Project-URL: Repository, https://github.com/actris-cloudnet/cloudnetpy-qc
 Project-URL: Changelog, https://github.com/actris-cloudnet/cloudnetpy-qc/blob/main/CHANGELOG.md
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Topic :: Scientific/Engineering
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -80,6 +80,7 @@ print(json_object)
 - `timestamp`: UTC timestamp of the test
 - `qcVersion`: `cloudnetpy-qc` version
 - `tests`: `Test[]`
+- `data_coverage`: float
 
 ### `Test`
 
@@ -137,6 +138,7 @@ print(json_object)
 | `TestBrightnessTemperature` | Test that brightness temperature data are valid.                                        |
 | `TestCFConvention`          | Test compliance with the CF metadata conventions.                                       |
 | `TestComment`               | Check that variables have expected comments.                                            |
+| `TestCompression`           | Test netCDF compression.                                                                |
 | `TestCoordinateVariables`   | Test dimensions of coordinate variables are correct.                                    |
 | `TestCoordinates`           | Check that file coordinates match site coordinates.                                     |
 | `TestDataCoverage`          | Test that file contains enough data.                                                    |
@@ -155,13 +157,15 @@ print(json_object)
 | `TestMask`                  | Test that data are not completely masked.                                               |
 | `TestMedianLwp`             | Test that LWP data are valid.                                                           |
 | `TestModelData`             | Test that model data are valid.                                                         |
-| `TestRainfallConsistency`   | Test that rainfall rate and rainfall amount are consistent.                             |
+| `TestRainfallConsistency`   | Test that precipitation rate and amount are consistent.                                 |
+| `TestRangeAndHeight`        | Test that range and height data are valid.                                              |
 | `TestStandardNames`         | Check that variable have expected standard names.                                       |
 | `TestTimeVector`            | Test that time vector is continuous.                                                    |
 | `TestUnexpectedMask`        | Test if data contain unexpected masked values.                                          |
 | `TestUnits`                 | Check that variables have expected units.                                               |
 | `TestVariableNames`         | Check that file contains required variables.                                            |
 | `TestVariableNamesDefined`  | Check that variables have expected names.                                               |
+| `TestZenithAngle`           | Test lidar zenith angle.                                                                |
 
 ## License
 

{cloudnetpy_qc-1.24.1 → cloudnetpy_qc-1.30.0}/README.md

@@ -27,6 +27,7 @@ print(json_object)
 - `timestamp`: UTC timestamp of the test
 - `qcVersion`: `cloudnetpy-qc` version
 - `tests`: `Test[]`
+- `data_coverage`: float
 
 ### `Test`
 
@@ -84,6 +85,7 @@ print(json_object)
 | `TestBrightnessTemperature` | Test that brightness temperature data are valid.                                        |
 | `TestCFConvention`          | Test compliance with the CF metadata conventions.                                       |
 | `TestComment`               | Check that variables have expected comments.                                            |
+| `TestCompression`           | Test netCDF compression.                                                                |
 | `TestCoordinateVariables`   | Test dimensions of coordinate variables are correct.                                    |
 | `TestCoordinates`           | Check that file coordinates match site coordinates.                                     |
 | `TestDataCoverage`          | Test that file contains enough data.                                                    |
@@ -102,13 +104,15 @@ print(json_object)
 | `TestMask`                  | Test that data are not completely masked.                                               |
 | `TestMedianLwp`             | Test that LWP data are valid.                                                           |
 | `TestModelData`             | Test that model data are valid.                                                         |
-| `TestRainfallConsistency`   | Test that rainfall rate and rainfall amount are consistent.                             |
+| `TestRainfallConsistency`   | Test that precipitation rate and amount are consistent.                                 |
+| `TestRangeAndHeight`        | Test that range and height data are valid.                                              |
 | `TestStandardNames`         | Check that variable have expected standard names.                                       |
 | `TestTimeVector`            | Test that time vector is continuous.                                                    |
 | `TestUnexpectedMask`        | Test if data contain unexpected masked values.                                          |
 | `TestUnits`                 | Check that variables have expected units.                                               |
 | `TestVariableNames`         | Check that file contains required variables.                                            |
 | `TestVariableNamesDefined`  | Check that variables have expected names.                                               |
+| `TestZenithAngle`           | Test lidar zenith angle.                                                                |
 
 ## License
 

cloudnetpy_qc-1.30.0/cloudnetpy_qc/coverage.py

@@ -0,0 +1,69 @@
+import datetime
+
+import netCDF4
+import numpy as np
+
+from cloudnetpy_qc.variables import Product
+
+RESOLUTIONS = {
+    Product.DISDROMETER: datetime.timedelta(minutes=1),
+    Product.L3_CF: datetime.timedelta(hours=1),
+    Product.L3_IWC: datetime.timedelta(hours=1),
+    Product.L3_LWC: datetime.timedelta(hours=1),
+    Product.MWR: datetime.timedelta(minutes=5),
+    Product.MWR_MULTI: datetime.timedelta(minutes=30),
+    Product.MWR_SINGLE: datetime.timedelta(minutes=5),
+    Product.WEATHER_STATION: datetime.timedelta(minutes=10),
+    Product.RAIN_GAUGE: datetime.timedelta(minutes=1),
+    Product.DOPPLER_LIDAR_WIND: datetime.timedelta(hours=1.5),
+    Product.CPR_VALIDATION: datetime.timedelta(hours=1.5),
+}
+DEFAULT_RESOLUTION = datetime.timedelta(seconds=30)
+
+
+def data_coverage(
+    nc: netCDF4.Dataset,
+) -> tuple[float | np.floating, datetime.timedelta, datetime.timedelta] | None:
+    time = np.array(nc["time"][:])
+    time_unit = datetime.timedelta(hours=1)
+    try:
+        n_time = len(time)
+    except (TypeError, ValueError):
+        return None
+    if n_time < 2:
+        return None
+    if nc.cloudnet_file_type == "model":
+        expected_res = _model_resolution(nc)
+    elif "da10" in getattr(nc, "source", "").lower():
+        expected_res = datetime.timedelta(minutes=2)
+    else:
+        product = Product(nc.cloudnet_file_type)
+        expected_res = RESOLUTIONS.get(product, DEFAULT_RESOLUTION)
+    duration = get_duration(nc)
+    bins = max(1, duration // expected_res)
+    hist, _ = np.histogram(time, bins=bins, range=(0, duration / time_unit))
+    coverage = np.count_nonzero(hist > 0) / len(hist)
+    actual_res = float(np.median(np.diff(time))) * time_unit
+    return coverage, expected_res, actual_res
+
+
+def _model_resolution(nc: netCDF4.Dataset) -> datetime.timedelta:
+    source = nc.source.lower()
+    if "gdas" in source or "ecmwf open" in source:
+        return datetime.timedelta(hours=3)
+    return datetime.timedelta(hours=1)
+
+
+def get_duration(nc: netCDF4.Dataset) -> datetime.timedelta:
+    now = datetime.datetime.now(tz=datetime.timezone.utc)
+    if now.date() == _get_date(nc):
+        midnight = now.replace(hour=0, minute=0, second=0, microsecond=0)
+        duration = now - midnight
+    else:
+        duration = datetime.timedelta(days=1)
+    return duration
+
+
+def _get_date(nc: netCDF4.Dataset) -> datetime.date:
+    date_in_file = [int(getattr(nc, x)) for x in ("year", "month", "day")]
+    return datetime.date(*date_in_file)