cloudnetpy 1.80.6__py3-none-any.whl → 1.80.8__py3-none-any.whl

cloudnetpy/categorize/categorize.py

@@ -17,7 +17,8 @@ from cloudnetpy.categorize.mwr import Mwr
 from cloudnetpy.categorize.radar import Radar
 from cloudnetpy.datasource import DataSource
 from cloudnetpy.exceptions import DisdrometerDataError, ValidTimeStampError
-from cloudnetpy.metadata import MetaData
+from cloudnetpy.instruments.rpg import RPG_ATTRIBUTES
+from cloudnetpy.metadata import COMMON_ATTRIBUTES, MetaData
 from cloudnetpy.products.product_tools import CategoryBits, QualityBits
 
 
@@ -385,31 +386,45 @@ DEFINITIONS = {
 }
 
 CATEGORIZE_ATTRIBUTES = {
+    "height": COMMON_ATTRIBUTES["height"]._replace(dimensions=("height",)),
     # Radar variables
     "Z": MetaData(
         long_name="Radar reflectivity factor",
         units="dBZ",
         comment=COMMENTS["Z"],
         ancillary_variables="Z_error Z_bias Z_sensitivity",
+        dimensions=("time", "height"),
     ),
     "Z_error": MetaData(
         long_name="Error in radar reflectivity factor",
         units="dB",
         comment=COMMENTS["Z_error"],
+        dimensions=("time", "height"),
     ),
     "Z_bias": MetaData(
         long_name="Bias in radar reflectivity factor",
         units="dB",
         comment=COMMENTS["bias"],
+        dimensions=None,
     ),
     "Z_sensitivity": MetaData(
         long_name="Minimum detectable radar reflectivity",
         units="dBZ",
         comment=COMMENTS["Z_sensitivity"],
+        dimensions=("time", "height"),
     ),
+    "v": COMMON_ATTRIBUTES["v"]._replace(dimensions=("time", "height")),
+    "width": COMMON_ATTRIBUTES["width"]._replace(dimensions=("time", "height")),
+    "ldr": COMMON_ATTRIBUTES["ldr"]._replace(dimensions=("time", "height")),
+    "sldr": COMMON_ATTRIBUTES["sldr"]._replace(dimensions=("time", "height")),
     "v_sigma": MetaData(
         long_name="Standard deviation of mean Doppler velocity",
         units="m s-1",
+        dimensions=("time", "height"),
+    ),
+    "zdr": RPG_ATTRIBUTES["zdr"]._replace(dimensions=("time", "height")),
+    "nyquist_velocity": COMMON_ATTRIBUTES["nyquist_velocity"]._replace(
+        dimensions=("time", "height")
     ),
     # Lidar variables
     "beta": MetaData(
@@ -417,89 +432,128 @@ CATEGORIZE_ATTRIBUTES = {
         units="sr-1 m-1",
         comment="SNR-screened attenuated backscatter coefficient.",
         ancillary_variables="beta_error beta_bias",
+        dimensions=("time", "height"),
     ),
     "beta_error": MetaData(
         long_name="Error in attenuated backscatter coefficient",
         units="dB",
+        dimensions=None,
     ),
     "beta_bias": MetaData(
         long_name="Bias in attenuated backscatter coefficient",
         units="dB",
+        dimensions=None,
+    ),
+    "lidar_wavelength": MetaData(
+        long_name="Laser wavelength", units="nm", dimensions=None
     ),
-    "lidar_wavelength": MetaData(long_name="Laser wavelength", units="nm"),
     # MWR variables
     "lwp_error": MetaData(
         long_name="Error in liquid water path",
         units="kg m-2",
+        dimensions=("time",),
+    ),
+    "lwp": COMMON_ATTRIBUTES["lwp"]._replace(
+        ancillary_variables="lwp_error", dimensions=("time",)
     ),
-    "lwp": MetaData(ancillary_variables="lwp_error"),
     # Model variables
-    "Tw": MetaData(long_name="Wet-bulb temperature", units="K", comment=COMMENTS["Tw"]),
-    "model_time": MetaData(long_name="Model time UTC", calendar="standard"),
+    "Tw": MetaData(
+        long_name="Wet-bulb temperature",
+        units="K",
+        comment=COMMENTS["Tw"],
+        dimensions=("time", "height"),
+    ),
+    "model_time": MetaData(
+        long_name="Model time UTC",
+        calendar="standard",
+        dimensions=("model_time",),
+    ),
     "model_height": MetaData(
         long_name="Height of model variables above mean sea level",
         units="m",
         axis="Z",
+        dimensions=("model_height",),
+    ),
+    "temperature": MetaData(
+        long_name="Temperature", units="K", dimensions=("model_time", "model_height")
+    ),
+    "pressure": MetaData(
+        long_name="Pressure", units="Pa", dimensions=("model_time", "model_height")
     ),
     "vwind": MetaData(
         long_name="Meridional wind",
         units="m s-1",
+        dimensions=("model_time", "model_height"),
     ),
     "uwind": MetaData(
         long_name="Zonal wind",
         units="m s-1",
+        dimensions=("model_time", "model_height"),
+    ),
+    "q": MetaData(
+        long_name="Specific humidity",
+        units="1",
+        dimensions=("model_time", "model_height"),
     ),
-    "q": MetaData(long_name="Specific humidity", units="1"),
     # MISC
     "category_bits": MetaData(
         long_name="Target categorization bits",
         comment=COMMENTS["category_bits"],
         definition=DEFINITIONS["category_bits"],
         units="1",
+        dimensions=("time", "height"),
     ),
     "quality_bits": MetaData(
         long_name="Data quality bits",
         comment=COMMENTS["quality_bits"],
         definition=DEFINITIONS["quality_bits"],
         units="1",
+        dimensions=("time", "height"),
     ),
     "radar_liquid_atten": MetaData(
         long_name="Two-way radar attenuation due to liquid water",
         units="dB",
         comment=COMMENTS["radar_liquid_atten"],
         references="ITU-R P.840-9",
+        dimensions=("time", "height"),
     ),
     "radar_rain_atten": MetaData(
         long_name="Two-way radar attenuation due to rain",
         units="dB",
         references="Crane, R. (1980)",
         comment=COMMENTS["radar_rain_atten"],
+        dimensions=("time", "height"),
     ),
     "radar_melting_atten": MetaData(
         long_name="Two-way radar attenuation due to melting ice",
         units="dB",
         references="Li, H., & Moisseev, D. (2019)",
         comment=COMMENTS["radar_melting_atten"],
+        dimensions=("time", "height"),
     ),
     "radar_gas_atten": MetaData(
         long_name="Two-way radar attenuation due to atmospheric gases",
         units="dB",
         comment=COMMENTS["radar_gas_atten"],
         references="ITU-R P.676-13",
+        dimensions=("time", "height"),
     ),
     "insect_prob": MetaData(
         long_name="Insect probability",
         units="1",
         comment=COMMENTS["insect_prob"],
+        dimensions=("time", "height"),
     ),
     "liquid_prob": MetaData(
         long_name="Liquid probability",
         units="1",
         comment=COMMENTS["liquid_prob"],
+        dimensions=("time", "height"),
     ),
     "rain_detected": MetaData(
         long_name="Rain detected",
         units="1",
         comment="1 = rain detected, 0 = no rain detected",
+        dimensions=("time",),
     ),
 }

cloudnetpy/cloudnetarray.py

@@ -97,7 +97,7 @@ class CloudnetArray:
         """Overwrites existing instance attributes."""
         for key in attributes._fields:  # To iterate namedtuple fields.
             data = getattr(attributes, key)
-            if data:
+            if key == "dimensions" or data:
                 setattr(self, key, data)
 
     def filter_isolated_pixels(self) -> None:

cloudnetpy/instruments/basta.py

@@ -107,15 +107,18 @@ ATTRIBUTES = {
         long_name="Radar pitch angle",
         units="degree",
         standard_name="platform_roll",
+        dimensions=("time",),
     ),
     "radar_yaw": MetaData(
         long_name="Radar yaw angle",
         units="degree",
         standard_name="platform_yaw",
+        dimensions=("time",),
     ),
     "radar_roll": MetaData(
         long_name="Radar roll angle",
         units="degree",
         standard_name="platform_roll",
+        dimensions=("time",),
     ),
 }

cloudnetpy/instruments/bowtie.py

@@ -8,6 +8,7 @@ from cloudnetpy.constants import G_TO_KG, MM_H_TO_M_S
 from cloudnetpy.exceptions import ValidTimeStampError
 from cloudnetpy.instruments.instruments import FMCW94
 from cloudnetpy.instruments.nc_radar import NcRadar
+from cloudnetpy.instruments.rpg import RPG_ATTRIBUTES
 from cloudnetpy.metadata import MetaData
 from cloudnetpy.utils import bit_field_definition
 
@@ -97,7 +98,7 @@ class Bowtie(NcRadar):
             raise ValidTimeStampError
 
 
-ATTRIBUTES: dict = {
+ATTRIBUTES = RPG_ATTRIBUTES | {
     "v": MetaData(
         long_name="Doppler velocity",
         units="m s-1",
@@ -107,6 +108,7 @@ ATTRIBUTES: dict = {
             "motion of the ship. A rolling average over 3 time steps has been\n"
             "applied to it."
         ),
+        dimensions=("time", "range"),
     ),
     "correction_bits": MetaData(
         long_name="Correction bits",
@@ -116,5 +118,6 @@ ATTRIBUTES: dict = {
             "This parameter is a bit field that indicates which corrections have\n"
             "been applied to radar measurements."
         ),
+        dimensions=("time", "range"),
     ),
 }

cloudnetpy/instruments/ceilo.py

@@ -8,11 +8,11 @@ import numpy as np
 from ceilopyter import read_ct25k
 from numpy import ma
 
-from cloudnetpy import output, utils
+from cloudnetpy import output
 from cloudnetpy.instruments.cl61d import Cl61d
 from cloudnetpy.instruments.lufft import LufftCeilo
 from cloudnetpy.instruments.vaisala import ClCeilo, Cs135, Ct25k
-from cloudnetpy.metadata import MetaData
+from cloudnetpy.metadata import COMMON_ATTRIBUTES, MetaData
 
 
 def ceilo2nc(
@@ -205,92 +205,19 @@ ATTRIBUTES = {
         long_name="Lidar volume linear depolarisation ratio",
         units="1",
         comment="SNR-screened lidar volume linear depolarisation ratio at 910.55 nm.",
+        dimensions=("time", "range"),
     ),
     "depolarisation_raw": MetaData(
         long_name="Lidar volume linear depolarisation ratio",
         units="1",
         comment="SNR-screened lidar volume linear depolarisation ratio at 910.55 nm.",
-    ),
-    "scale": MetaData(long_name="Scale", units="%", comment="100 (%) is normal."),
-    "software_level": MetaData(
-        long_name="Software level ID",
-        units="1",
-    ),
-    "laser_temperature": MetaData(
-        long_name="Laser temperature",
-        units="C",
-    ),
-    "window_transmission": MetaData(
-        long_name="Window transmission estimate",
-        units="%",
-    ),
-    "laser_energy": MetaData(
-        long_name="Laser pulse energy",
-        units="%",
-    ),
-    "background_light": MetaData(
-        long_name="Background light",
-        units="mV",
-        comment="Measured at internal ADC input.",
-    ),
-    "backscatter_sum": MetaData(
-        long_name="Sum of detected and normalized backscatter",
-        units="sr-1",
-        comment="Multiplied by scaling factor times 1e4.",
-    ),
-    "range_resolution": MetaData(
-        long_name="Range resolution",
-        units="m",
-    ),
-    "number_of_gates": MetaData(
-        long_name="Number of range gates in profile",
-        units="1",
-    ),
-    "unit_id": MetaData(
-        long_name="Ceilometer unit number",
-        units="1",
-    ),
-    "message_number": MetaData(
-        long_name="Message number",
-        units="1",
-    ),
-    "message_subclass": MetaData(
-        long_name="Message subclass number",
-        units="1",
-    ),
-    "detection_status": MetaData(
-        long_name="Detection status",
-        units="1",
-        comment="From the internal software of the instrument.",
-    ),
-    "warning": MetaData(
-        long_name="Warning and Alarm flag",
-        units="1",
-        definition=utils.status_field_definition(
-            {
-                "0": "Self-check OK",
-                "W": "At least one warning on",
-                "A": "At least one error active.",
-            }
-        ),
-    ),
-    "warning_flags": MetaData(
-        long_name="Warning flags",
-        units="1",
-    ),
-    "receiver_sensitivity": MetaData(
-        long_name="Receiver sensitivity",
-        units="%",
-        comment="Expressed as % of nominal factory setting.",
-    ),
-    "window_contamination": MetaData(
-        long_name="Window contamination",
-        units="mV",
-        comment="Measured at internal ADC input.",
+        dimensions=("time", "range"),
     ),
     "calibration_factor": MetaData(
         long_name="Attenuated backscatter calibration factor",
         units="1",
         comment="Calibration factor applied.",
+        dimensions=None,
     ),
+    "zenith_angle": COMMON_ATTRIBUTES["zenith_angle"]._replace(dimensions=None),
 }

cloudnetpy/instruments/copernicus.py

@@ -164,13 +164,21 @@ ATTRIBUTES = {
         long_name="Radar reflectivity calibration offset",
         units="dBZ",
         comment="Calibration offset applied.",
+        dimensions=None,
     ),
     "range_offset": MetaData(
         long_name="Radar range offset",
         units="m",
         comment="Range offset applied.",
+        dimensions=None,
+    ),
+    "antenna_diameter": MetaData(
+        long_name="Antenna diameter", units="m", dimensions=("time",)
+    ),
+    "beamwidthV": MetaData(
+        long_name="Vertical angular beamwidth", units="degree", dimensions=("time",)
+    ),
+    "beamwidthH": MetaData(
+        long_name="Horizontal angular beamwidth", units="degree", dimensions=("time",)
     ),
-    "antenna_diameter": MetaData(long_name="Antenna diameter", units="m"),
-    "beamwidthV": MetaData(long_name="Vertical angular beamwidth", units="degree"),
-    "beamwidthH": MetaData(long_name="Horizontal angular beamwidth", units="degree"),
 }

cloudnetpy/instruments/disdrometer/common.py

@@ -76,56 +76,65 @@ ATTRIBUTES = {
         long_name="Center fall velocity of precipitation particles",
         units="m s-1",
         comment="Predefined velocity classes.",
+        dimensions=("velocity",),
     ),
     "velocity_spread": MetaData(
         long_name="Width of velocity interval",
         units="m s-1",
         comment="Bin size of each velocity interval.",
+        dimensions=("velocity",),
     ),
     "velocity_bnds": MetaData(
         long_name="Velocity bounds",
         units="m s-1",
         comment="Upper and lower bounds of velocity interval.",
+        dimensions=("velocity", "nv"),
     ),
     "diameter": MetaData(
         long_name="Center diameter of precipitation particles",
         units="m",
         comment="Predefined diameter classes.",
+        dimensions=("diameter",),
     ),
     "diameter_spread": MetaData(
         long_name="Width of diameter interval",
         units="m",
         comment="Bin size of each diameter interval.",
+        dimensions=("diameter",),
     ),
     "diameter_bnds": MetaData(
         long_name="Diameter bounds",
         units="m",
         comment="Upper and lower bounds of diameter interval.",
+        dimensions=("diameter", "nv"),
     ),
     "rainfall_rate_1min_total": MetaData(
-        long_name="Total precipitation rate",
-        units="m s-1",
+        long_name="Total precipitation rate", units="m s-1", dimensions=("time",)
     ),
     "rainfall_rate": MetaData(
         long_name="Rainfall rate",
         units="m s-1",
         standard_name="rainfall_rate",
+        dimensions=("time",),
     ),
     "rainfall_rate_1min_solid": MetaData(
-        long_name="Solid precipitation rate",
-        units="m s-1",
+        long_name="Solid precipitation rate", units="m s-1", dimensions=("time",)
     ),
     "snowfall_rate": MetaData(
         long_name="Snowfall rate",
         units="m s-1",
         comment="Snow depth intensity (volume equivalent)",
+        dimensions=("time",),
     ),
-    "synop_WaWa": MetaData(long_name="Synop code WaWa", units="1"),
-    "synop_WW": MetaData(long_name="Synop code WW", units="1"),
+    "synop_WaWa": MetaData(
+        long_name="Synop code WaWa", units="1", dimensions=("time",)
+    ),
+    "synop_WW": MetaData(long_name="Synop code WW", units="1", dimensions=("time",)),
     "radar_reflectivity": MetaData(
         long_name="Equivalent radar reflectivity factor",
         units="dBZ",
         standard_name="equivalent_reflectivity_factor",
+        dimensions=("time",),
     ),
     "visibility": MetaData(
         long_name="Meteorological optical range (MOR) visibility",
@@ -133,148 +142,178 @@ ATTRIBUTES = {
         standard_name="visibility_in_air",
         comment="Visibility estimation by the disdrometer is valid\n"
         "only during precipitation events.",
+        dimensions=("time",),
+    ),
+    "interval": MetaData(
+        long_name="Length of measurement interval", units="s", dimensions=("time",)
+    ),
+    "sig_laser": MetaData(
+        long_name="Signal amplitude of the laser strip", units="1", dimensions=("time",)
     ),
-    "interval": MetaData(long_name="Length of measurement interval", units="s"),
-    "sig_laser": MetaData(long_name="Signal amplitude of the laser strip", units="1"),
     "n_particles": MetaData(
         long_name="Number of particles in time interval",
         units="1",
+        dimensions=("time",),
     ),
     "T_sensor": MetaData(
-        long_name="Temperature in the sensor housing",
-        units="K",
-    ),
-    "I_heating": MetaData(
-        long_name="Heating current",
-        units="A",
+        long_name="Temperature in the sensor housing", units="K", dimensions=("time",)
     ),
+    "I_heating": MetaData(long_name="Heating current", units="A", dimensions=("time",)),
     "V_sensor_supply": MetaData(
-        long_name="Sensor supply voltage",
-        units="V",
+        long_name="Sensor supply voltage", units="V", dimensions=("time",)
     ),
     "V_power_supply": MetaData(
-        long_name="Power supply voltage",
-        units="V",
+        long_name="Power supply voltage", units="V", dimensions=("time",)
     ),
     "state_sensor": MetaData(
         long_name="State of the sensor",
         comment="0 = OK, 1 = Dirty, 2 = No measurement possible.",
         units="1",
+        dimensions=("time",),
     ),
-    "error_code": MetaData(long_name="Error code", units="1"),
+    "error_code": MetaData(long_name="Error code", units="1", dimensions=("time",)),
     "number_concentration": MetaData(
         long_name="Number of particles per diameter class",
         units="m-3 mm-1",
+        dimensions=("time", "diameter"),
     ),
     "fall_velocity": MetaData(
         long_name="Average velocity of each diameter class",
         units="m s-1",
+        dimensions=("time", "diameter"),
     ),
     "data_raw": MetaData(
         long_name="Raw data as a function of particle diameter and velocity",
         units="1",
+        dimensions=("time", "diameter", "velocity"),
     ),
     "kinetic_energy": MetaData(
         long_name="Kinetic energy of the hydrometeors",
         units="J m-2 h-1",
+        dimensions=("time",),
     ),
     # Thies-specific:
-    "T_ambient": MetaData(long_name="Ambient temperature", units="K"),
-    "T_interior": MetaData(long_name="Interior temperature", units="K"),
+    "T_ambient": MetaData(
+        long_name="Ambient temperature", units="K", dimensions=("time",)
+    ),
+    "T_interior": MetaData(
+        long_name="Interior temperature", units="K", dimensions=("time",)
+    ),
     "status_T_laser_analogue": MetaData(
         long_name="Status of laser temperature (analogue)",
         comment="0 = OK , 1 = Error",
         units="1",
+        dimensions=("time",),
     ),
     "status_T_laser_digital": MetaData(
         long_name="Status of laser temperature (digital)",
         comment="0 = OK , 1 = Error",
         units="1",
+        dimensions=("time",),
     ),
     "status_I_laser_analogue": MetaData(
         long_name="Status of laser current (analogue)",
         comment="0 = OK , 1 = Error",
         units="1",
+        dimensions=("time",),
     ),
     "status_I_laser_digital": MetaData(
         long_name="Status of laser current (digital)",
         comment="0 = OK , 1 = Error",
         units="1",
+        dimensions=("time",),
     ),
     "status_sensor_supply": MetaData(
         long_name="Status of sensor supply",
         comment="0 = OK , 1 = Error",
         units="1",
+        dimensions=("time",),
     ),
     "status_laser_heating": MetaData(
         long_name="Status of laser heating",
         comment="0 = OK , 1 = Error",
         units="1",
+        dimensions=("time",),
     ),
     "status_receiver_heating": MetaData(
         long_name="Status of receiver heating",
         comment="0 = OK , 1 = Error",
         units="1",
+        dimensions=("time",),
     ),
     "status_temperature_sensor": MetaData(
         long_name="Status of temperature sensor",
         comment="0 = OK , 1 = Error",
         units="1",
+        dimensions=("time",),
     ),
     "status_heating_supply": MetaData(
         long_name="Status of heating supply",
         comment="0 = OK , 1 = Error",
         units="1",
+        dimensions=("time",),
     ),
     "status_heating_housing": MetaData(
         long_name="Status of heating housing",
         comment="0 = OK , 1 = Error",
         units="1",
+        dimensions=("time",),
     ),
     "status_heating_heads": MetaData(
         long_name="Status of heating heads",
         comment="0 = OK , 1 = Error",
         units="1",
+        dimensions=("time",),
     ),
     "status_heating_carriers": MetaData(
         long_name="Status of heating carriers",
         comment="0 = OK , 1 = Error",
         units="1",
+        dimensions=("time",),
     ),
     "status_laser_power": MetaData(
         long_name="Status of laser power",
         comment="0 = OK , 1 = Error",
         units="1",
+        dimensions=("time",),
     ),
     "status_laser": MetaData(
         long_name="Status of laser",
         comment="0 = OK/on , 1 = Off",
         units="1",
+        dimensions=("time",),
+    ),
+    "measurement_quality": MetaData(
+        long_name="Measurement quality", units="%", dimensions=("time",)
+    ),
+    "maximum_hail_diameter": MetaData(
+        long_name="Maximum hail diameter", units="mm", dimensions=("time",)
     ),
-    "measurement_quality": MetaData(long_name="Measurement quality", units="%"),
-    "maximum_hail_diameter": MetaData(long_name="Maximum hail diameter", units="mm"),
     "static_signal": MetaData(
         long_name="Static signal",
         comment="0 = OK, 1 = ERROR",
         units="1",
+        dimensions=("time",),
+    ),
+    "T_laser_driver": MetaData(
+        long_name="Temperature of laser driver", units="K", dimensions=("time",)
+    ),
+    "I_mean_laser": MetaData(
+        long_name="Mean value of laser current", units="mA", dimensions=("time",)
     ),
-    "T_laser_driver": MetaData(long_name="Temperature of laser driver", units="K"),
-    "I_mean_laser": MetaData(long_name="Mean value of laser current", units="mA"),
     "V_control": MetaData(
         long_name="Control voltage",
         units="mV",
         comment="Reference value: 4010+-5",
+        dimensions=("time",),
     ),
     "V_optical_output": MetaData(
-        long_name="Voltage of optical control output",
-        units="mV",
+        long_name="Voltage of optical control output", units="mV", dimensions=("time",)
     ),
     "I_heating_laser_head": MetaData(
-        long_name="Laser head heating current",
-        units="mA",
+        long_name="Laser head heating current", units="mA", dimensions=("time",)
     ),
     "I_heating_receiver_head": MetaData(
-        long_name="Receiver head heating current",
-        units="mA",
+        long_name="Receiver head heating current", units="mA", dimensions=("time",)
     ),
 }