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

cloudnetpy/instruments/fd12p.py

@@ -175,23 +175,29 @@ ATTRIBUTES = {
         long_name="Meteorological optical range (MOR) visibility",
         units="m",
         standard_name="visibility_in_air",
+        dimensions=("time",),
     ),
     "precipitation_rate": MetaData(
         long_name="Precipitation rate",
         standard_name="lwe_precipitation_rate",
         units="m s-1",
+        dimensions=("time",),
     ),
     "precipitation_amount": MetaData(
         long_name="Precipitation amount",
         standard_name="lwe_thickness_of_precipitation_amount",
         units="m",
         comment="Cumulated precipitation since 00:00 UTC",
+        dimensions=("time",),
     ),
     "snowfall_amount": MetaData(
         long_name="Snowfall amount",
         units="m",
         standard_name="thickness_of_snowfall_amount",
         comment="Cumulated snow since 00:00 UTC",
+        dimensions=("time",),
+    ),
+    "synop_WaWa": MetaData(
+        long_name="Synop code WaWa", units="1", dimensions=("time",)
     ),
-    "synop_WaWa": MetaData(long_name="Synop code WaWa", units="1"),
 }

cloudnetpy/instruments/galileo.py

@@ -129,7 +129,13 @@ class Galileo(ChilboltonRadar):
 
 
 ATTRIBUTES = {
-    "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"),
+    "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",)
+    ),
 }

cloudnetpy/instruments/mira.py

@@ -285,27 +285,28 @@ def _check_file_type(filetype: str) -> None:
 
 
 ATTRIBUTES = {
-    "nfft": MetaData(
-        long_name="Number of FFT points",
-        units="1",
-    ),
+    "nfft": MetaData(long_name="Number of FFT points", units="1", dimensions=("time",)),
     "nave": MetaData(
         long_name="Number of spectral averages (not accounting for overlapping FFTs)",
         units="1",
+        dimensions=("time",),
+    ),
+    "rg0": MetaData(
+        long_name="Number of lowest range gates", units="1", dimensions=("time",)
     ),
-    "rg0": MetaData(long_name="Number of lowest range gates", units="1"),
     "prf": MetaData(
-        long_name="Pulse Repetition Frequency",
-        units="Hz",
+        long_name="Pulse Repetition Frequency", units="Hz", dimensions=("time",)
     ),
     "zenith_offset": MetaData(
         long_name="Zenith offset of the instrument",
         units="degrees",
         comment="Zenith offset applied.",
+        dimensions=None,
     ),
     "azimuth_offset": MetaData(
         long_name="Azimuth offset of the instrument (positive clockwise from north)",
         units="degrees",
         comment="Azimuth offset applied.",
+        dimensions=None,
     ),
 }

cloudnetpy/instruments/mrr.py

@@ -163,6 +163,18 @@ class MrrPro(NcRadar):
 
 
 ATTRIBUTES = {
-    "lwc": MetaData(long_name="Liquid water content", units="kg m-3"),
-    "pia": MetaData(long_name="Path integrated rain attenuation", units="dB"),
+    "lwc": MetaData(
+        long_name="Liquid water content", units="kg m-3", dimensions=("time", "range")
+    ),
+    "pia": MetaData(
+        long_name="Path integrated rain attenuation",
+        units="dB",
+        dimensions=("time", "range"),
+    ),
+    "rainfall_rate": MetaData(
+        long_name="Rainfall rate",
+        standard_name="rainfall_rate",
+        units="m s-1",
+        dimensions=("time", "range"),
+    ),
 }

cloudnetpy/instruments/nc_radar.py

@@ -162,7 +162,8 @@ class NcRadar(DataSource, CloudnetInstrument):
 
     def test_if_all_masked(self) -> None:
         """Tests if all data are masked."""
-        if np.all(self.data["v"][:].mask):
+        v = self.data["v"][:]
+        if ma.isMaskedArray(v) and np.all(v.mask):
             msg = "All radar data are masked"
             raise RadarDataError(msg)
 

cloudnetpy/instruments/pollyxt.py

@@ -13,7 +13,7 @@ from cloudnetpy import output, utils
 from cloudnetpy.exceptions import InconsistentDataError, ValidTimeStampError
 from cloudnetpy.instruments import instruments
 from cloudnetpy.instruments.ceilometer import Ceilometer
-from cloudnetpy.metadata import MetaData
+from cloudnetpy.metadata import COMMON_ATTRIBUTES, MetaData
 from cloudnetpy.utils import Epoch
 
 
@@ -247,15 +247,19 @@ ATTRIBUTES = {
         long_name="Lidar volume linear depolarisation ratio",
         units="1",
         comment="SNR-screened lidar volume linear depolarisation ratio at 532 nm.",
+        dimensions=("time", "range"),
     ),
     "depolarisation_raw": MetaData(
         long_name="Lidar volume linear depolarisation ratio",
         units="1",
         comment="Non-screened lidar volume linear depolarisation ratio at 532 nm.",
+        dimensions=("time", "range"),
     ),
     "calibration_factor": MetaData(
         long_name="Attenuated backscatter calibration factor",
         units="1",
         comment="Calibration factor applied.",
+        dimensions=("time",),
     ),
+    "zenith_angle": COMMON_ATTRIBUTES["zenith_angle"]._replace(dimensions=None),
 }

cloudnetpy/instruments/radiometrics.py

@@ -421,5 +421,15 @@ ATTRIBUTES = {
     "irt": MetaData(
         long_name="Infrared brightness temperatures",
         units="K",
+        dimensions=("time", "ir_channel"),
+    ),
+    "temperature": MetaData(
+        long_name="Temperature", units="K", dimensions=("time", "range")
+    ),
+    "relative_humidity": MetaData(
+        long_name="Relative humidity",
+        standard_name="relative_humidity",
+        units="1",
+        dimensions=("time", "range"),
     ),
 }

cloudnetpy/instruments/rpg.py

@@ -385,135 +385,154 @@ DEFINITIONS = {
 
 RPG_ATTRIBUTES = {
     # LDR-mode radars:
-    "ldr": MetaData(long_name="Linear depolarisation ratio", units="dB"),
-    "rho_cx": MetaData(long_name="Co-cross-channel correlation coefficient", units="1"),
-    "phi_cx": MetaData(long_name="Co-cross-channel differential phase", units="rad"),
+    "ldr": MetaData(
+        long_name="Linear depolarisation ratio",
+        units="dB",
+        dimensions=("time", "range"),
+    ),
+    "rho_cx": MetaData(
+        long_name="Co-cross-channel correlation coefficient",
+        units="1",
+        dimensions=("time", "range"),
+    ),
+    "phi_cx": MetaData(
+        long_name="Co-cross-channel differential phase",
+        units="rad",
+        dimensions=("time", "range"),
+    ),
     # STSR-mode radars
-    "zdr": MetaData(long_name="Differential reflectivity", units="dB"),
-    "rho_hv": MetaData(long_name="Correlation coefficient", units="1"),
-    "phi_dp": MetaData(long_name="Differential phase", units="rad"),
-    "srho_hv": MetaData(long_name="Slanted correlation coefficient", units="1"),
-    "kdp": MetaData(long_name="Specific differential phase shift", units="rad km-1"),
+    "zdr": MetaData(
+        long_name="Differential reflectivity", units="dB", dimensions=("time", "range")
+    ),
+    "rho_hv": MetaData(
+        long_name="Correlation coefficient", units="1", dimensions=("time", "range")
+    ),
+    "phi_dp": MetaData(
+        long_name="Differential phase", units="rad", dimensions=("time", "range")
+    ),
+    "srho_hv": MetaData(
+        long_name="Slanted correlation coefficient",
+        units="1",
+        dimensions=("time", "range"),
+    ),
+    "kdp": MetaData(
+        long_name="Specific differential phase shift",
+        units="rad km-1",
+        dimensions=("time", "range"),
+    ),
     "differential_attenuation": MetaData(
         long_name="Differential attenuation",
         units="dB km-1",
+        dimensions=("time", "range"),
     ),
     # All radars
     "file_code": MetaData(
         long_name="File code",
         units="1",
         comment="Indicates the RPG software version.",
+        dimensions=None,
     ),
-    "program_number": MetaData(long_name="Program number", units="1"),
+    "program_number": MetaData(long_name="Program number", units="1", dimensions=None),
     "model_number": MetaData(
         long_name="Model number",
         units="1",
         definition=DEFINITIONS["model_number"],
+        dimensions=None,
     ),
     "antenna_separation": MetaData(
-        long_name="Antenna separation",
-        units="m",
+        long_name="Antenna separation", units="m", dimensions=None
     ),
     "antenna_diameter": MetaData(
-        long_name="Antenna diameter",
-        units="m",
-    ),
-    "antenna_gain": MetaData(
-        long_name="Antenna gain",
-        units="dB",
+        long_name="Antenna diameter", units="m", dimensions=None
     ),
+    "antenna_gain": MetaData(long_name="Antenna gain", units="dB", dimensions=None),
     "half_power_beam_width": MetaData(
-        long_name="Half power beam width",
-        units="degree",
+        long_name="Half power beam width", units="degree", dimensions=None
     ),
     "dual_polarization": MetaData(
         long_name="Dual polarisation type",
         units="1",
         definition=DEFINITIONS["dual_polarization"],
+        dimensions=None,
+    ),
+    "sample_duration": MetaData(
+        long_name="Sample duration", units="s", dimensions=None
     ),
-    "sample_duration": MetaData(long_name="Sample duration", units="s"),
     "calibration_interval": MetaData(
-        long_name="Calibration interval in samples",
-        units="1",
+        long_name="Calibration interval in samples", units="1", dimensions=None
     ),
     "number_of_spectral_samples": MetaData(
         long_name="Number of spectral samples in each chirp sequence",
         units="1",
+        dimensions=("chirp_sequence",),
+    ),
+    "nyquist_velocity": MetaData(
+        long_name="Nyquist velocity", units="m s-1", dimensions=("chirp_sequence",)
     ),
     "number_of_averaged_chirps": MetaData(
         long_name="Number of averaged chirps in sequence",
         units="1",
+        dimensions=("chirp_sequence",),
+    ),
+    "chirp_start_indices": MetaData(
+        long_name="Chirp sequences start indices",
+        units="1",
+        dimensions=("chirp_sequence",),
     ),
     "integration_time": MetaData(
         long_name="Integration time",
         units="s",
         comment="Effective integration time of chirp sequence",
+        dimensions=("chirp_sequence",),
     ),
     "range_resolution": MetaData(
         long_name="Vertical resolution of range",
         units="m",
+        dimensions=("chirp_sequence",),
     ),
     "FFT_window": MetaData(
         long_name="FFT window type",
         units="1",
         definition=DEFINITIONS["FFT_window"],
+        dimensions=None,
     ),
     "input_voltage_range": MetaData(
-        long_name="ADC input voltage range (+/-)",
-        units="mV",
+        long_name="ADC input voltage range (+/-)", units="mV", dimensions=None
     ),
     "noise_threshold": MetaData(
         long_name="Noise filter threshold factor",
         units="1",
         comment="Multiple of the standard deviation of Doppler spectra.",
+        dimensions=None,
     ),
-    "time_ms": MetaData(
-        long_name="Time ms",
-        units="ms",
-    ),
+    "time_ms": MetaData(long_name="Time ms", units="ms", dimensions=("time",)),
     "quality_flag": MetaData(
         long_name="Quality flag",
         definition=DEFINITIONS["quality_flag"],
         units="1",
+        dimensions=("time",),
     ),
-    "voltage": MetaData(
-        long_name="Voltage",
-        units="V",
-    ),
+    "voltage": MetaData(long_name="Voltage", units="V", dimensions=("time",)),
     "brightness_temperature": MetaData(
-        long_name="Brightness temperature",
-        units="K",
-    ),
-    "if_power": MetaData(
-        long_name="IF power at ACD",
-        units="uW",
+        long_name="Brightness temperature", units="K", dimensions=("time",)
     ),
+    "if_power": MetaData(long_name="IF power at ACD", units="uW", dimensions=("time",)),
     "status_flag": MetaData(
-        long_name="Status flag for heater and blower",
-        units="1",
+        long_name="Status flag for heater and blower", units="1", dimensions=("time",)
     ),
     "transmitted_power": MetaData(
-        long_name="Transmitted power",
-        units="W",
+        long_name="Transmitted power", units="W", dimensions=("time",)
     ),
     "transmitter_temperature": MetaData(
-        long_name="Transmitter temperature",
-        units="K",
+        long_name="Transmitter temperature", units="K", dimensions=("time",)
     ),
     "receiver_temperature": MetaData(
-        long_name="Receiver temperature",
-        units="K",
+        long_name="Receiver temperature", units="K", dimensions=("time",)
     ),
     "pc_temperature": MetaData(
-        long_name="PC temperature",
-        units="K",
-    ),
-    "kurtosis": MetaData(
-        long_name="Kurtosis of spectra",
-        units="1",
+        long_name="PC temperature", units="K", dimensions=("time",)
     ),
     "correlation_coefficient": MetaData(
-        long_name="Correlation coefficient",
-        units="1",
+        long_name="Correlation coefficient", units="1", dimensions=None
     ),
 }

cloudnetpy/metadata.py

@@ -4,7 +4,8 @@ from typing import NamedTuple
 
 
 class MetaData(NamedTuple):
-    long_name: str | None = None
+    long_name: str
+    dimensions: tuple[str, ...] | None
     standard_name: str | None = None
     units: str | None = None
     comment: str | None = None
@@ -23,32 +24,38 @@ COMMON_ATTRIBUTES = {
         axis="T",
         standard_name="time",
         calendar="standard",
+        dimensions=("time",),
     ),
     "height": MetaData(
         long_name="Height above mean sea level",
         standard_name="height_above_mean_sea_level",
         units="m",
+        dimensions=("range",),
     ),
     "range": MetaData(
         long_name="Range from instrument",
         axis="Z",
         units="m",
         comment="Distance from instrument to centre of each range bin.",
+        dimensions=("range",),
     ),
     "latitude": MetaData(
         long_name="Latitude of site",
         units="degree_north",
         standard_name="latitude",
+        dimensions=("time",),
     ),
     "longitude": MetaData(
         long_name="Longitude of site",
         units="degree_east",
         standard_name="longitude",
+        dimensions=("time",),
     ),
     "altitude": MetaData(
         long_name="Altitude of site",
         standard_name="altitude",
         units="m",
+        dimensions=("time",),
     ),
     "Zh": MetaData(
         long_name="Radar reflectivity factor",
@@ -56,6 +63,7 @@ COMMON_ATTRIBUTES = {
         comment="Calibrated reflectivity. Calibration convention: in the absence\n"
         "of attenuation, a cloud at 273 K containing one million 100-micron droplets\n"
         "per cubic metre will have a reflectivity of 0 dBZ at all frequencies.",
+        dimensions=("time", "range"),
     ),
     "width": MetaData(
         long_name="Spectral width",
@@ -64,6 +72,7 @@ COMMON_ATTRIBUTES = {
             "This parameter is the standard deviation of the reflectivity-weighted\n"
             "velocities in the radar pulse volume."
         ),
+        dimensions=("time", "range"),
     ),
     "v": MetaData(
         long_name="Doppler velocity",
@@ -72,130 +81,147 @@ COMMON_ATTRIBUTES = {
             "This parameter is the radial component of the velocity, with positive\n"
             "velocities are away from the radar."
         ),
+        dimensions=("time", "range"),
     ),
     "ldr": MetaData(
         long_name="Linear depolarisation ratio",
         units="dB",
         comment="This parameter is the ratio of cross-polar to co-polar reflectivity.",
+        dimensions=("time", "range"),
+    ),
+    "sldr": MetaData(
+        long_name="Slanted linear depolarisation ratio",
+        units="dB",
+        dimensions=("time", "range"),
     ),
-    "sldr": MetaData(long_name="Slanted linear depolarisation ratio", units="dB"),
     "lwp": MetaData(
         long_name="Liquid water path",
         units="kg m-2",
         standard_name="atmosphere_cloud_liquid_water_content",
+        dimensions=("time",),
     ),
     "iwv": MetaData(
         long_name="Integrated water vapour",
         units="kg m-2",
         standard_name="atmosphere_mass_content_of_water_vapor",
+        dimensions=("time",),
     ),
     "kurtosis": MetaData(
         long_name="Kurtosis of spectra",
         units="1",
+        dimensions=("time", "range"),
     ),
     "skewness": MetaData(
         long_name="Skewness of spectra",
         units="1",
+        dimensions=("time", "range"),
+    ),
+    "nyquist_velocity": MetaData(
+        long_name="Nyquist velocity",
+        units="m s-1",
+        dimensions=("time", "range"),
+    ),
+    "radar_frequency": MetaData(
+        long_name="Radar transmit frequency", units="GHz", dimensions=None
     ),
-    "nyquist_velocity": MetaData(long_name="Nyquist velocity", units="m s-1"),
-    "radar_frequency": MetaData(long_name="Radar transmit frequency", units="GHz"),
     "beta": MetaData(
         long_name="Attenuated backscatter coefficient",
         units="sr-1 m-1",
         comment="SNR-screened attenuated backscatter coefficient.",
+        dimensions=("time", "range"),
     ),
     "beta_raw": MetaData(
         long_name="Attenuated backscatter coefficient",
         units="sr-1 m-1",
         comment="Non-screened attenuated backscatter coefficient.",
+        dimensions=("time", "range"),
     ),
     "beta_smooth": MetaData(
         long_name="Attenuated backscatter coefficient",
         units="sr-1 m-1",
         comment="SNR-screened attenuated backscatter coefficient.\n"
         "Weak background smoothed using Gaussian 2D-kernel.",
+        dimensions=("time", "range"),
     ),
-    "wavelength": MetaData(
-        long_name="Laser wavelength",
-        units="nm",
-    ),
+    "wavelength": MetaData(long_name="Laser wavelength", units="nm", dimensions=None),
     "zenith_angle": MetaData(
         long_name="Zenith angle",
         units="degree",
         standard_name="zenith_angle",
         comment="Angle to the local vertical. A value of zero is directly overhead.",
+        dimensions=("time",),
     ),
     "ir_zenith_angle": MetaData(
         long_name="Infrared sensor zenith angle",
         units="degree",
         comment="90=horizon, 0=zenith",
+        dimensions=("time",),
     ),
     "azimuth_angle": MetaData(
         long_name="Azimuth angle",
         standard_name="sensor_azimuth_angle",
         units="degree",
         comment="Angle between North and the line of sight, measured clockwise.",
+        dimensions=("time",),
     ),
-    "temperature": MetaData(
-        long_name="Temperature",
-        units="K",
-    ),
-    "pressure": MetaData(
-        long_name="Pressure",
-        units="Pa",
-    ),
+    "temperature": MetaData(long_name="Temperature", units="K", dimensions=("time",)),
+    "pressure": MetaData(long_name="Pressure", units="Pa", dimensions=("time",)),
     "SNR": MetaData(
-        long_name="Signal-to-noise ratio",
-        units="dB",
+        long_name="Signal-to-noise ratio", units="dB", dimensions=("time", "range")
     ),
     "relative_humidity": MetaData(
         long_name="Relative humidity",
         standard_name="relative_humidity",
         units="1",
+        dimensions=("time",),
     ),
     "absolute_humidity": MetaData(
         long_name="Absolute humidity",
         standard_name="mass_concentration_of_water_vapor_in_air",
         units="kg m-3",
+        dimensions=("time", "range"),
     ),
     "wind_speed": MetaData(
         long_name="Wind speed",
         standard_name="wind_speed",
         units="m s-1",
+        dimensions=("time",),
     ),
     "wind_direction": MetaData(
         long_name="Wind direction",
         standard_name="wind_from_direction",
         units="degree",
+        dimensions=("time",),
     ),
     "rainfall_rate": MetaData(
         long_name="Rainfall rate",
         standard_name="rainfall_rate",
         units="m s-1",
+        dimensions=("time",),
     ),
     "rainfall_amount": MetaData(
         long_name="Rainfall amount",
         standard_name="thickness_of_rainfall_amount",
         units="m",
         comment="Cumulated precipitation since 00:00 UTC",
+        dimensions=("time",),
     ),
     "air_temperature": MetaData(
         long_name="Air temperature",
         standard_name="air_temperature",
         units="K",
+        dimensions=("time",),
     ),
     "air_pressure": MetaData(
         long_name="Air pressure",
         standard_name="air_pressure",
         units="Pa",
+        dimensions=("time",),
     ),
     "snr_limit": MetaData(
         long_name="SNR limit",
         units="dB",
         comment="SNR threshold used in data screening.",
-    ),
-    "chirp_start_indices": MetaData(
-        long_name="Chirp sequences start indices",
-        units="1",
+        dimensions=None,
     ),
 }