cloudnetpy 1.80.5__py3-none-any.whl → 1.80.7__py3-none-any.whl

cloudnetpy/model_evaluation/metadata.py

@@ -1,24 +1,24 @@
-from typing import NamedTuple
-
-
-class MetaData(NamedTuple):
-    long_name: str
-    units: str
-    comment: str | None = None
-    standard_name: str | None = None
-    axis: str | None = None
-    positive: str | None = None
-    calendar: str | None = None
-
+from cloudnetpy.metadata import MetaData
 
 MODEL_ATTRIBUTES = {
-    "time": MetaData(units="", long_name="Time UTC", axis="T", calendar="standard"),
-    "latitude": MetaData(long_name="Latitude of grid point", units="degree_north"),
-    "longitude": MetaData(long_name="Longitude of grid point", units="degree_east"),
+    "time": MetaData(
+        units="",
+        long_name="Time UTC",
+        axis="T",
+        calendar="standard",
+        dimensions=("time",),
+    ),
+    "latitude": MetaData(
+        long_name="Latitude of grid point", units="degree_north", dimensions=None
+    ),
+    "longitude": MetaData(
+        long_name="Longitude of grid point", units="degree_east", dimensions=None
+    ),
     "horizontal_resolution": MetaData(
         long_name="Horizontal resolution of model",
         units="km",
         comment="Distance between two grid point",
+        dimensions=None,
     ),
     "level": MetaData(
         long_name="Model level",
@@ -26,6 +26,7 @@ MODEL_ATTRIBUTES = {
         comment="Level 1 describes the highest height from ground.",
         axis="Z",
         positive="down",
+        dimensions=("level",),
     ),
 }
 
@@ -38,6 +39,7 @@ CYCLE_ATTRIBUTES = {
             "which it was taken. Note that the profiles in this file may be taken\n"
             "from more than one forecast."
         ),
+        dimensions=("time",),
     ),
     "height": MetaData(
         long_name="Height above ground",
@@ -47,18 +49,21 @@ CYCLE_ATTRIBUTES = {
             "specific humidity."
         ),
         positive="up",
+        dimensions=("time", "level"),
     ),
-    "pressure": MetaData(long_name="Pressure", units="Pa"),
-    "temperature": MetaData(long_name="Temperature", units="K"),
+    "pressure": MetaData(long_name="Pressure", units="Pa", dimensions=None),
+    "temperature": MetaData(long_name="Temperature", units="K", dimensions=None),
     "uwind": MetaData(
         long_name="Zonal wind",
         units="m s-1",
         standard_name="eastward_wind",
+        dimensions=None,
     ),
     "vwind": MetaData(
         long_name="Meridional wind",
         units="m s-1",
         standard_name="northward_wind",
+        dimensions=None,
     ),
     "wwind": MetaData(
         long_name="Vertical wind",
@@ -68,13 +73,15 @@ CYCLE_ATTRIBUTES = {
             "The vertical wind has been calculated from omega (Pa s-1),\n"
             "height and pressure using: w=omega*dz/dp"
         ),
+        dimensions=None,
     ),
     "omega": MetaData(
         long_name="Vertical wind in pressure coordinates",
         units="PA s-1",
         standard_name="omega",
+        dimensions=None,
     ),
-    "q": MetaData(long_name="Specific humidity", units="1"),
+    "q": MetaData(long_name="Specific humidity", units="1", dimensions=None),
     "rh": MetaData(
         long_name="Relative humidity",
         units="1",
@@ -82,28 +89,36 @@ CYCLE_ATTRIBUTES = {
             "With respect to liquid above 0 degrees C and with respect to ice\n"
             "below 0 degrees C"
         ),
+        dimensions=None,
     ),
 }
 
 MODEL_L3_ATTRIBUTES = {
-    "cf": MetaData(long_name="Cloud fraction of model grid point", units="1"),
+    "cf": MetaData(
+        long_name="Cloud fraction of model grid point",
+        units="1",
+        dimensions=("time", "level"),
+    ),
     "cf_cirrus": MetaData(
         long_name="Cloud fraction of model grid point with filtered cirrus fraction",
         units="1",
         comment="High level cirrus fraction is reduce do to lack if a radar\n"
         "capability to observe correctly particles small and high.",
+        dimensions=("time", "level"),
     ),
     "iwc": MetaData(
         long_name="Ice water content of model grid point",
         units="kg m-3",
         comment="Calculated using model ice water mixing ration, pressure\n"
         "and temperature: qi*P/287*T",
+        dimensions=("time", "level"),
     ),
     "lwc": MetaData(
         long_name="Liquid water content of model grid point",
         units="kg m-3",
         comment="Calculated using model liquid water mixing ration, pressure\n"
         "and temperature:  ql*P/287*T",
+        dimensions=("time", "level"),
     ),
 }
 
@@ -116,6 +131,7 @@ REGRID_PRODUCT_ATTRIBUTES = {
             "averaged onto the models grid with height and time. Volume is\n"
             "space within four grid points."
         ),
+        dimensions=("time", "level"),
     ),
     "cf_A": MetaData(
         long_name="Observed cloud fraction by area",
@@ -125,6 +141,7 @@ REGRID_PRODUCT_ATTRIBUTES = {
             "averaged onto the models grid with height and time. Area is\n"
             "sum of time columns with any cloud fraction."
         ),
+        dimensions=("time", "level"),
     ),
     "cf_V_adv": MetaData(
         long_name="Observed cloud fraction by advection volume",
@@ -134,6 +151,7 @@ REGRID_PRODUCT_ATTRIBUTES = {
             "except that model winds were used to estimate the time taken to advect\n"
             "airflow a distance equivalent to the models horizontal resolution."
         ),
+        dimensions=("time", "level"),
     ),
     "cf_A_adv": MetaData(
         long_name="Observed cloud fraction by advection area",
@@ -143,6 +161,7 @@ REGRID_PRODUCT_ATTRIBUTES = {
             "except that model winds were used to estimate the time taken to advect\n"
             "airflow a distance equivalent to the models horizontal resolution."
         ),
+        dimensions=("time", "level"),
     ),
     "iwc": MetaData(
         long_name="Observed ice water content reshaped to model dimensions by"
@@ -154,6 +173,7 @@ REGRID_PRODUCT_ATTRIBUTES = {
             "The formula  has been applied where the categorization data has\n"
             "diagnosed that the radar echo is due to ice."
         ),
+        dimensions=("time", "level"),
     ),
     "iwc_att": MetaData(
         long_name="Observed ice water content with attenuation reshaped to model grid"
@@ -164,6 +184,7 @@ REGRID_PRODUCT_ATTRIBUTES = {
             "except that profiles with uncorrected attenuation of the radar\n"
             "reflectivity were included."
         ),
+        dimensions=("time", "level"),
     ),
     "iwc_rain": MetaData(
         long_name="Observed ice water content with raining reshaped to model grid"
@@ -174,6 +195,7 @@ REGRID_PRODUCT_ATTRIBUTES = {
             "including attenuation, iwc_att, except that profiles with rain\n"
             "at the surface were also included."
         ),
+        dimensions=("time", "level"),
     ),
     "iwc_adv": MetaData(
         long_name="Observed ice water content reshaped to model advection grid"
@@ -184,6 +206,7 @@ REGRID_PRODUCT_ATTRIBUTES = {
             "except that model winds were used to estimate the time taken to advect\n"
             "the flow a distance equivalent to the models horizontal resolution."
         ),
+        dimensions=("time", "level"),
     ),
     "iwc_att_adv": MetaData(
         long_name="Observed ice water content with attenuation reshaped to model"
@@ -194,6 +217,7 @@ REGRID_PRODUCT_ATTRIBUTES = {
             "iwc_adv,  except that profiles with uncorrected attenuation of the radar\n"
             "reflectivity were included."
         ),
+        dimensions=("time", "level"),
     ),
     "iwc_rain_adv": MetaData(
         long_name="Observed ice water content with raining reshaped to model"
@@ -204,6 +228,7 @@ REGRID_PRODUCT_ATTRIBUTES = {
             "including attenuation, iwc_att_adv, except that profiles with rain\n"
             "at the surface were also included."
         ),
+        dimensions=("time", "level"),
     ),
     "lwc": MetaData(
         long_name="Observed liquid water content reshaped to model grid by averaging",
@@ -213,6 +238,7 @@ REGRID_PRODUCT_ATTRIBUTES = {
             "pixels where the categorization data has diagnosed that liquid water \n"
             "is present, averaged onto the model grid with height and time."
         ),
+        dimensions=("time", "level"),
     ),
     "lwc_adv": MetaData(
         long_name="Observed liquid water content reshaped to model advection grid by "
@@ -223,5 +249,6 @@ REGRID_PRODUCT_ATTRIBUTES = {
             "lwc, except that model winds were used to estimate the time taken to\n"
             "advect flow over the models grid points."
         ),
+        dimensions=("time", "level"),
     ),
 }

cloudnetpy/output.py

@@ -7,7 +7,6 @@ from os import PathLike
 from uuid import UUID
 
 import netCDF4
-import numpy as np
 from numpy import ma
 
 from cloudnetpy import utils, version
@@ -15,7 +14,7 @@ from cloudnetpy.categorize.containers import Observations
 from cloudnetpy.categorize.model import Model
 from cloudnetpy.datasource import DataSource
 from cloudnetpy.instruments.instruments import Instrument
-from cloudnetpy.metadata import COMMON_ATTRIBUTES, MetaData
+from cloudnetpy.metadata import COMMON_ATTRIBUTES
 
 
 def save_level1b(
@@ -57,10 +56,8 @@ def _get_netcdf_dimensions(obj) -> dict:
     }
     # RPG cloud radar
     if "chirp_start_indices" in obj.data:
-        if obj.data["chirp_start_indices"][:].ndim == 1:
-            dimensions["chirp_start_indices"] = len(obj.data["chirp_start_indices"][:])
-        else:
-            dimensions["chirp"] = obj.data["chirp_start_indices"][:].shape[1]
+        ind = obj.data["chirp_start_indices"][:]
+        dimensions["chirp_sequence"] = ind.shape[1] if ind.ndim > 1 else len(ind)
 
     # disdrometer
     if hasattr(obj, "n_diameter") and hasattr(obj, "n_velocity"):
@@ -340,9 +337,8 @@ def add_time_attribute(
         raise TypeError
     units = f"hours since {date_str} 00:00:00 +00:00"
     if key not in attributes:
-        attributes[key] = MetaData(units=units)
-    else:
-        attributes[key] = attributes[key]._replace(units=units)
+        attributes[key] = COMMON_ATTRIBUTES[key]
+    attributes[key] = attributes[key]._replace(units=units)
     return attributes
 
 
@@ -371,10 +367,9 @@ def add_source_attribute(attributes: dict, data: Observations) -> dict:
             continue
         source = getattr(data, instrument).dataset.source
         for key in keys:
-            if key in attributes:
-                attributes[key] = attributes[key]._replace(source=source)
-            else:
-                attributes[key] = MetaData(source=source)
+            if key not in attributes:
+                attributes[key] = COMMON_ATTRIBUTES[key]
+            attributes[key] = attributes[key]._replace(source=source)
     return attributes
 
 
@@ -403,8 +398,7 @@ def _write_vars2nc(nc: netCDF4.Dataset, cloudnet_variables: dict) -> None:
             fill_value = netCDF4.default_fillvals[obj.data_type]
         else:
             fill_value = False
-
-        size = obj.dimensions or _get_dimensions(nc, obj.data)
+        size = obj.dimensions if obj.dimensions is not None else ()
 
         nc_variable = nc.createVariable(
             obj.name,
@@ -418,19 +412,6 @@ def _write_vars2nc(nc: netCDF4.Dataset, cloudnet_variables: dict) -> None:
             setattr(nc_variable, attr, getattr(obj, attr))
 
 
-def _get_dimensions(nc: netCDF4.Dataset, data: np.ndarray) -> tuple:
-    """Finds correct dimensions for a variable."""
-    if utils.isscalar(data):
-        return ()
-    variable_size: list = []
-    file_dims = nc.dimensions
-    array_dims = data.shape
-    for length in array_dims:
-        dim = [key for key in file_dims if file_dims[key].size == length][0]  # noqa: RUF015
-        variable_size = [*variable_size, dim]
-    return tuple(variable_size)
-
-
 def _get_identifier(short_id: str) -> str:
     valid_ids = (
         "lwc",

cloudnetpy/products/classification.py

@@ -190,27 +190,33 @@ CLASSIFICATION_ATTRIBUTES = {
         comment=COMMENTS["target_classification"],
         definition=DEFINITIONS["target_classification"],
         units="1",
+        dimensions=("time", "height"),
     ),
     "detection_status": MetaData(
         long_name="Radar and lidar detection status",
         comment=COMMENTS["detection_status"],
         definition=DEFINITIONS["detection_status"],
         units="1",
+        dimensions=("time", "height"),
     ),
     "cloud_top_height_amsl": MetaData(
         long_name="Height of cloud top above mean sea level",
         units="m",
+        dimensions=("time",),
     ),
     "cloud_base_height_amsl": MetaData(
         long_name="Height of cloud base above mean sea level",
         units="m",
+        dimensions=("time",),
     ),
     "cloud_top_height_agl": MetaData(
         long_name="Height of cloud top above ground level",
         units="m",
+        dimensions=("time",),
     ),
     "cloud_base_height_agl": MetaData(
         long_name="Height of cloud base above ground level",
         units="m",
+        dimensions=("time",),
     ),
 }

cloudnetpy/products/der.py

@@ -302,32 +302,38 @@ REFF_ATTRIBUTES = {
         units="m",
         ancillary_variables="der_error",
         comment=COMMENTS["der"],
+        dimensions=("time", "height"),
     ),
     "der_error": MetaData(
         long_name="Absolute error in droplet effective radius",
         units="m",
         comment="",
+        dimensions=("time", "height"),
     ),
     "der_scaled": MetaData(
         long_name="Droplet effective radius (scaled to LWP)",
         units="m",
         ancillary_variables="der_scaled_error",
         comment=COMMENTS["der_scaled"],
+        dimensions=("time", "height"),
     ),
     "der_scaled_error": MetaData(
         long_name="Absolute error in droplet effective radius (scaled to LWP)",
         units="m",
         comment=COMMENTS["der_scaled_error"],
+        dimensions=("time", "height"),
     ),
     "N_scaled": MetaData(
         long_name="Cloud droplet number concentration",
         units="1",
         ancillary_variables="der_error der_scaled der_scaled_error",
         comment=COMMENTS["N_scaled"],
+        dimensions=("time", "height"),
     ),
     "der_retrieval_status": MetaData(
         long_name="Droplet effective radius retrieval status",
         definition=DEFINITIONS["der_retrieval_status"],
         units="1",
+        dimensions=("time", "height"),
     ),
 }

cloudnetpy/products/drizzle.py

@@ -201,55 +201,67 @@ DRIZZLE_ATTRIBUTES = {
         long_name="Drizzle number concentration",
         units="m-3",
         ancillary_variables="drizzle_N_error drizzle_N_bias",
+        dimensions=("time", "height"),
     ),
     "drizzle_N_error": MetaData(
         long_name="Random error in drizzle number concentration",
         units="dB",
+        dimensions=("time", "height"),
     ),
     "drizzle_N_bias": MetaData(
         long_name="Possible bias in drizzle number concentration",
         units="dB",
+        dimensions=("time", "height"),
     ),
     "drizzle_lwc": MetaData(
         long_name="Drizzle liquid water content",
         units="kg m-3",
         ancillary_variables="drizzle_lwc_error drizzle_lwc_bias",
         standard_name="mass_concentration_of_drizzle_in_air",
+        dimensions=("time", "height"),
     ),
     "drizzle_lwc_error": MetaData(
         long_name="Random error in drizzle liquid water content",
         units="dB",
+        dimensions=("time", "height"),
     ),
     "drizzle_lwc_bias": MetaData(
         long_name="Possible bias in drizzle liquid water content",
         units="dB",
+        dimensions=("time", "height"),
     ),
     "drizzle_lwf": MetaData(
         long_name="Drizzle liquid water flux",
         units="kg m-2 s-1",
         ancillary_variables="drizzle_lwf_error drizzle_lwf_bias",
+        dimensions=("time", "height"),
     ),
     "drizzle_lwf_error": MetaData(
         long_name="Random error in drizzle liquid water flux",
         units="dB",
+        dimensions=("time", "height"),
     ),
     "drizzle_lwf_bias": MetaData(
         long_name="Possible bias in drizzle liquid water flux",
         units="dB",
+        dimensions=("time", "height"),
     ),
     "v_drizzle": MetaData(
         long_name="Drizzle droplet fall velocity",  # TODO: should include 'terminal' ?
         units="m s-1",
         ancillary_variables="v_drizzle_error v_drizzle_bias",
         comment="Positive values are towards the ground.",
+        dimensions=("time", "height"),
     ),
     "v_drizzle_error": MetaData(
         long_name="Random error in drizzle droplet fall velocity",
         units="dB",
+        dimensions=("time", "height"),
     ),
     "v_drizzle_bias": MetaData(
         long_name="Possible bias in drizzle droplet fall velocity",
         units="dB",
+        dimensions=("time", "height"),
     ),
     "v_air": MetaData(
         long_name="Vertical air velocity",
@@ -257,45 +269,59 @@ DRIZZLE_ATTRIBUTES = {
         ancillary_variables="v_air_error",
         comment="Positive values are towards the sky.",
         standard_name="upward_air_velocity",
+        dimensions=("time", "height"),
     ),
     "v_air_error": MetaData(
         long_name="Random error in vertical air velocity",
         units="dB",
+        dimensions=("time", "height"),
     ),
     "Do": MetaData(
         long_name="Drizzle median diameter",
         units="m",
         ancillary_variables="Do_error Do_bias",
+        dimensions=("time", "height"),
     ),
     "Do_error": MetaData(
         long_name="Random error in drizzle median diameter",
         units="dB",
+        dimensions=("time", "height"),
     ),
     "Do_bias": MetaData(
         long_name="Possible bias in drizzle median diameter",
         units="dB",
+        dimensions=("time", "height"),
     ),
     "mu": MetaData(
         long_name="Drizzle droplet size distribution shape parameter",
         ancillary_variables="mu_error",
         units="1",
+        dimensions=("time", "height"),
     ),
     "mu_error": MetaData(
         long_name="Random error in drizzle droplet size distribution shape parameter",
         units="dB",
+        dimensions=("time", "height"),
     ),
     "S": MetaData(
         long_name="Lidar backscatter-to-extinction ratio",
         ancillary_variables="S_error",
         units="sr",
+        dimensions=("time", "height"),
     ),
     "S_error": MetaData(
         long_name="Random error in lidar backscatter-to-extinction ratio",
         units="dB",
+        dimensions=("time", "height"),
+    ),
+    "beta_corr": MetaData(
+        long_name="Lidar backscatter correction factor",
+        units="1",
+        dimensions=("time", "height"),
     ),
-    "beta_corr": MetaData(long_name="Lidar backscatter correction factor", units="1"),
     "drizzle_retrieval_status": MetaData(
         long_name="Drizzle parameter retrieval status",
         units="1",
+        dimensions=("time", "height"),
     ),
 }

cloudnetpy/products/ier.py

@@ -127,16 +127,19 @@ IER_ATTRIBUTES = {
         long_name="Ice effective radius",
         units="m",
         ancillary_variables="ier_error",
+        dimensions=("time", "height"),
     ),
     "ier_error": MetaData(
         long_name="Random error in ice effective radius",
         units="m",
         comment=COMMENTS["ier_error"],
+        dimensions=("time", "height"),
     ),
     "ier_retrieval_status": MetaData(
         long_name="Ice effective radius retrieval status",
         comment=COMMENTS["ier_retrieval_status"],
         definition=DEFINITIONS["ier_retrieval_status"],
         units="1",
+        dimensions=("time", "height"),
     ),
 }

cloudnetpy/products/iwc.py

@@ -189,25 +189,30 @@ IWC_ATTRIBUTES = {
         long_name="Ice water content",
         units="kg m-3",
         ancillary_variables="iwc_error iwc_sensitivity iwc_bias",
+        dimensions=("time", "height"),
     ),
     "iwc_error": MetaData(
         long_name="Random error in ice water content",
         units="dB",
+        dimensions=("time", "height"),
     ),
     "iwc_bias": MetaData(
         long_name="Possible bias in ice water content",
         units="dB",
         comment=COMMENTS["iwc_bias"],
+        dimensions=("time", "height"),
     ),
     "iwc_sensitivity": MetaData(
         long_name="Minimum detectable ice water content",
         units="kg m-3",
         comment=COMMENTS["iwc_sensitivity"],
+        dimensions=("time", "height"),
     ),
     "iwc_retrieval_status": MetaData(
         long_name="Ice water content retrieval status",
         comment=COMMENTS["iwc_retrieval_status"],
         definition=DEFINITIONS["iwc_retrieval_status"],
         units="1",
+        dimensions=("time", "height"),
     ),
 }

cloudnetpy/products/lwc.py

@@ -445,16 +445,19 @@ LWC_ATTRIBUTES = {
         comment=COMMENTS["lwc"],
         ancillary_variables="lwc_error",
         standard_name="mass_concentration_of_liquid_water_in_air",
+        dimensions=("time", "height"),
     ),
     "lwc_error": MetaData(
         long_name="Random error in liquid water content, one standard deviation",
         comment=COMMENTS["lwc_error"],
         units="dB",
+        dimensions=("time", "height"),
     ),
     "lwc_retrieval_status": MetaData(
         long_name="Liquid water content retrieval status",
         comment=COMMENTS["lwc_retrieval_status"],
         definition=DEFINITIONS["lwc_retrieval_status"],
         units="1",
+        dimensions=("time", "height"),
     ),
 }

cloudnetpy/utils.py

@@ -1100,7 +1100,12 @@ def add_site_geolocation(
 
     for key in ("latitude", "longitude", "altitude"):
         if key in tmp_data:
-            data[key] = CloudnetArray(tmp_data[key], key, source=tmp_source[key])
+            data[key] = CloudnetArray(
+                tmp_data[key],
+                key,
+                source=tmp_source[key],
+                dimensions=None if isinstance(tmp_data[key], float) else ("time",),
+            )
 
 
 def _parse_global_attribute_numeral(dataset: netCDF4.Dataset, key: str) -> float | None:

cloudnetpy/version.py

@@ -1,4 +1,4 @@
 MAJOR = 1
 MINOR = 80
-PATCH = 5
+PATCH = 7
 __version__ = f"{MAJOR}.{MINOR}.{PATCH}"

{cloudnetpy-1.80.5.dist-info → cloudnetpy-1.80.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudnetpy
-Version: 1.80.5
+Version: 1.80.7
 Summary: Python package for Cloudnet processing
 Author: Simo Tukiainen
 License: MIT License