cloudnetpy 1.93.4__tar.gz → 1.93.5__tar.gz

{cloudnetpy-1.93.4/cloudnetpy.egg-info → cloudnetpy-1.93.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudnetpy
-Version: 1.93.4
+Version: 1.93.5
 Summary: Python package for Cloudnet processing
 Author: Simo Tukiainen
 License: MIT License
@@ -106,12 +106,23 @@ python3 -m pip install .
 
 ### Verification
 
-To verify the installation:
+Verify the installation by running `cloudnetpy --help`.
+
+## Command-line usage
+
+CloudnetPy ships with a `cloudnetpy` console script that fetches data from the
+[Cloudnet data portal](https://cloudnet.fmi.fi), runs the requested processing
+steps, and writes netCDF files (and optionally plots) to disk:
 
 ```sh
-cloudnetpy --help
+cloudnetpy --site munich --date 2023-07-29 --products radar --show
+cloudnetpy --site kenttarova --date 2025-07-29 --products classification --show
+cloudnetpy -s kenttarova -d 2025-05-28 -p l3-cf -m harmonie-fmi-6-11 --show
 ```
 
+See the [command-line usage documentation](https://actris-cloudnet.github.io/cloudnetpy/cli.html)
+for instrument selection, different products, plotting, and all options.
+
 ## Citing
 
 If you wish to acknowledge CloudnetPy in your publication, please cite:

{cloudnetpy-1.93.4 → cloudnetpy-1.93.5}/README.md

@@ -41,12 +41,23 @@ python3 -m pip install .
 
 ### Verification
 
-To verify the installation:
+Verify the installation by running `cloudnetpy --help`.
+
+## Command-line usage
+
+CloudnetPy ships with a `cloudnetpy` console script that fetches data from the
+[Cloudnet data portal](https://cloudnet.fmi.fi), runs the requested processing
+steps, and writes netCDF files (and optionally plots) to disk:
 
 ```sh
-cloudnetpy --help
+cloudnetpy --site munich --date 2023-07-29 --products radar --show
+cloudnetpy --site kenttarova --date 2025-07-29 --products classification --show
+cloudnetpy -s kenttarova -d 2025-05-28 -p l3-cf -m harmonie-fmi-6-11 --show
 ```
 
+See the [command-line usage documentation](https://actris-cloudnet.github.io/cloudnetpy/cli.html)
+for instrument selection, different products, plotting, and all options.
+
 ## Citing
 
 If you wish to acknowledge CloudnetPy in your publication, please cite:

{cloudnetpy-1.93.4 → cloudnetpy-1.93.5}/cloudnetpy/categorize/containers.py

@@ -163,6 +163,6 @@ def _find_clutter(
     """
     is_clutter = np.zeros(v.shape, dtype=bool)
     filled = False
-    tiny_velocity = (np.abs(v[:, :n_gates]) < v_lim).filled(filled)
+    tiny_velocity = ma.less(ma.abs(v[:, :n_gates]), v_lim).filled(filled)
     is_clutter[:, :n_gates] = tiny_velocity * utils.transpose(~is_rain)
     return is_clutter

{cloudnetpy-1.93.4 → cloudnetpy-1.93.5}/cloudnetpy/cloudnetarray.py

@@ -111,7 +111,7 @@ class CloudnetArray:
 
     def _filter(self, fun: Callable[[npt.NDArray], npt.NDArray]) -> None:
         if not isinstance(self.data, ma.MaskedArray):
-            self.data = ma.masked_array(self.data)
+            self.data = ma.array(self.data)
         is_data = (~self.data.mask).astype(int)
         is_data_filtered = fun(is_data)
         self.data[is_data_filtered == 0] = ma.masked

{cloudnetpy-1.93.4 → cloudnetpy-1.93.5}/cloudnetpy/instruments/ceilometer.py

@@ -273,7 +273,7 @@ class NoisyData:
             ind = self._get_altitude_ind()
             snr[:, ind] *= snr_scale_factor
         if ma.isMaskedArray(array) is False:
-            array = ma.masked_array(array)
+            array = ma.array(array)
         if keep_negative is True:
             array[np.abs(snr) < snr_limit] = ma.masked
         else:

{cloudnetpy-1.93.4 → cloudnetpy-1.93.5}/cloudnetpy/instruments/instruments.py

@@ -91,6 +91,22 @@ MIRA35 = Instrument(
     frequency=35.5,
 )
 
+MIRA35S = Instrument(
+    manufacturer="METEK",
+    domain="radar",
+    category="cloud radar",
+    model="MIRA-35S",
+    frequency=35.5,
+)
+
+MIRA35C = Instrument(
+    manufacturer="METEK",
+    domain="radar",
+    category="cloud radar",
+    model="MIRA-35C",
+    frequency=35.5,
+)
+
 COPERNICUS = Instrument(
     manufacturer="RAL Space",
     domain="radar",

{cloudnetpy-1.93.4 → cloudnetpy-1.93.5}/cloudnetpy/instruments/lufft.py

@@ -43,7 +43,7 @@ class LufftCeilo(NcLidar):
             logging.warning("Using default calibration factor")
             calibration_factor = 3e-12
         beta_raw = self._getvar("beta_raw", "beta_att")
-        beta_raw = ma.masked_array(beta_raw)
+        beta_raw = ma.array(beta_raw)
         old_version = self._get_old_software_version()
         if old_version is not None:
             self.is_old_version = True
@@ -53,7 +53,7 @@ class LufftCeilo(NcLidar):
             )
             data_std = self._getvar("stddev")
             normalised_apd = self._get_nn()
-            beta_raw *= utils.transpose(ma.masked_array(data_std / normalised_apd))
+            beta_raw *= utils.transpose(ma.array(data_std / normalised_apd))
             beta_raw *= self.data["range"] ** 2
         beta_raw *= calibration_factor
         self.data["calibration_factor"] = float(calibration_factor)

{cloudnetpy-1.93.4 → cloudnetpy-1.93.5}/cloudnetpy/instruments/mira.py

@@ -14,7 +14,9 @@ import numpy as np
 from numpy import ma
 
 from cloudnetpy import concat_lib, output, utils
-from cloudnetpy.instruments.instruments import MIRA10, MIRA35
+from cloudnetpy.cloudnetarray import CloudnetArray
+from cloudnetpy.constants import HZ_TO_GHZ
+from cloudnetpy.instruments.instruments import MIRA10, MIRA35, MIRA35C, MIRA35S
 from cloudnetpy.instruments.nc_radar import NcRadar
 from cloudnetpy.metadata import MetaData
 
@@ -26,7 +28,7 @@ def mira2nc(
     uuid: str | UUID | None = None,
     date: str | datetime.date | None = None,
 ) -> UUID:
-    """Converts METEK MIRA-35 cloud radar data into Cloudnet Level 1b netCDF file.
+    """Converts METEK MIRA cloud radar data into Cloudnet Level 1b netCDF file.
 
     This function converts raw MIRA file(s) into a much smaller file that
     contains only the relevant data and can be used in further processing
@@ -38,8 +40,9 @@ def mira2nc(
             ``.znc`` files from one day, or a list of files. ``.znc`` files take
             precedence because they are the newer filetype.
         output_file: Output filename.
-        site_meta: Dictionary containing information about the site. Required key
-            value pair is `name`.
+        site_meta: Dictionary containing information about the site. Required
+            key-value pair is `name`. Optional `model` takes `mira-35` (default),
+            `mira-35s`, `mira-35c`, or `mira-10`.
         uuid: Set specific UUID for the file.
         date: Expected date as YYYY-MM-DD of all profiles in the file.
 
@@ -96,7 +99,8 @@ def mira2nc(
             mira.mask_bad_angles()
             mira.add_time_and_range()
             mira.add_site_geolocation()
-            mira.add_radar_specific_variables()
+            mira.add_radar_frequency()
+            mira.broadcast_nyquist_velocity()
             valid_indices = mira.add_zenith_and_azimuth_angles(
                 elevation_threshold=1.1,
                 elevation_diff_threshold=1e-6,
@@ -114,7 +118,7 @@ def mira2nc(
 
 
 class Mira(NcRadar):
-    """Class for MIRA-35 raw radar data. Child of NcRadar().
+    """Class for MIRA raw radar data. Child of NcRadar().
 
     Args:
         full_path: Filename of a daily MIRA .mmclx NetCDF file.
@@ -127,14 +131,44 @@ class Mira(NcRadar):
     def __init__(self, full_path: str | PathLike, site_meta: dict) -> None:
         super().__init__(full_path, site_meta)
         self.date = self._init_mira_date()
+        self.hrd = self._read_hrd()
         if "model" not in site_meta or site_meta["model"] == "mira-35":
             self.instrument = MIRA35
+        elif site_meta["model"] == "mira-35s":
+            self.instrument = MIRA35S
+        elif site_meta["model"] == "mira-35c":
+            self.instrument = MIRA35C
         elif site_meta["model"] == "mira-10":
             self.instrument = MIRA10
         else:
             msg = f"Invalid model: {site_meta['model']}"
             raise ValueError(msg)
 
+    def _read_hrd(self) -> dict[str, str]:
+        lines = self.dataset.hrd.split("\n")
+        output = {}
+        for line in lines:
+            if ":" not in line:
+                continue
+            key, value = line.split(":", maxsplit=1)
+            output[key] = value.strip()
+        return output
+
+    def add_radar_frequency(self) -> None:
+        # XMT should always be present. In newer files, there's also
+        # LO_frequency variable which doesn't match XMT exactly and sometimes
+        # contains only zeros.
+        key = "radar_frequency"
+        frequency = float(self.hrd["XMT"]) * HZ_TO_GHZ
+        self.data[key] = CloudnetArray(frequency, key)
+
+    def broadcast_nyquist_velocity(self) -> None:
+        # Scalar in original file, 1d array in concatenated file.
+        key = "nyquist_velocity"
+        nv = self.data[key].data
+        if len(nv.shape) == 1:
+            self.data[key].data = ma.getdata(nv)[:, np.newaxis]
+
     def screen_by_date(self, expected_date: datetime.date) -> None:
         """Screens incorrect time stamps."""
         time_stamps = self.getvar("time")
@@ -152,17 +186,36 @@ class Mira(NcRadar):
         return utils.seconds2date(float(time_stamps[0]), self.epoch).date()
 
     def screen_low_power(self) -> None:
-        """Screen times with average transmit power close to zero."""
+        """Screen times with low average transmit power (tpow).
+
+        The expected average power depends on the specific model:
+
+        - MIRA-35 / 35S: average power should be between 30 and 60 W according
+          to the data sheet. Based on a random sample, tpow values range from 15
+          to 25 W.
+        - MIRA-35C: average power should be around 3 W according to the data
+          sheet. Based on a random sample, tpow values range from 1.5 to 2 W.
+        - MIRA-10: average power is up to 40 W (website) or 50 W (data sheet).
+
+        Please note that the raw tpow values cannot always be trusted:
+
+        - Files with SN:fzk and without FZK100 field in 'hrd' global attribute
+          should be multiplied by 100.
+        - It looks like tpow could contain the peak power instead of the average
+          power. As of now, this has only be seen in Munich MIRA-10, but because
+          this is the only MIRA-10 in Cloudnet, let's leave it as it is.
+
+        Example case:
+
+        - Limassol 2024-10-20: https://hdl.handle.net/21.12132/1.159fe518fe5b403d
+        """
         if "tpow" not in self.data:
             logging.warning("Variable tpow is missing")
             return
         self._correct_fzk_tpow()
         tpow = self.data["tpow"][:]
-        # Threshold for abnormally low power e.g. Limassol 2024-10-20. Average
-        # power should 30 to 60 W according to MIRA-35 data sheet. Based on a
-        # random sample, typical range is 15 to 25 W. In Lampedusa, the power is
-        # constantly as low as 1.9 W.
-        is_low = tpow < 1
+        low_threshold = 0.5 if self.instrument == MIRA35C else 5
+        is_low = tpow < low_threshold
         n_removed = np.count_nonzero(is_low)
         if n_removed > 0:
             logging.warning(
@@ -171,21 +224,17 @@ class Mira(NcRadar):
             self.screen_time_indices(~is_low)
 
     def _correct_fzk_tpow(self) -> None:
-        """Corrects tpow for old FZK-serial instruments missing the FZK100 fix.
+        """Corrects tpow for old instruments missing the FZK100 fix.
+
+        In old MIRA-35 files with 'SN:fzk', tpow was reported 100x too small
+        (e.g. Schneefernerhaus 2012-01-01). The tpow was corrected in a firmware
+        update as indicated by 'FZK100:      1.00000' in the 'hrd' global
+        attribute (e.g. Schneefernerhaus 2018-01-01).
 
-        Some MIRA-35 instruments with serial number 'fzk' had a firmware bug
-        where tpow was reported 100x too small. Files produced after the
-        firmware fix contain 'FZK100' in the 'hrd' global attribute. Files
-        without this field need tpow multiplied by 100.
+        Please note that this doesn't affect all old MIRA-35 instruments (e.g.
+        'SN:dwd', Lindenberg 2007-01-01).
         """
-        hrd = getattr(self.dataset, "hrd", "")
-        if "FZK100" in hrd:
-            return
-        sn_lines = [line for line in hrd.split("\n") if line.strip().startswith("SN:")]
-        if not sn_lines:
-            return
-        sn = sn_lines[0].split(":", 1)[1].strip()
-        if sn != "fzk":
+        if self.hrd["SN"] != "fzk" or "FZK100" in self.hrd:
             return
         logging.info("Correcting tpow by factor 100 for old FZK instrument firmware")
         self.data["tpow"].data[:] *= 100
@@ -197,6 +246,11 @@ class Mira(NcRadar):
         """
         if "ldr" not in self.data:
             return
+        # Delete LDR if polarization is off. The LDR variable exists but
+        # contains no data. At least Munich MIRA-10 doesn't have polarization.
+        if self.hrd["POL"] == "0":
+            del self.data["ldr"]
+            return
         ldr = self.data["ldr"][:]
         if ma.mean(ldr) > 0:
             logging.warning(
@@ -314,6 +368,7 @@ def _get_keymap(filetype: str) -> dict[str, str]:
                 ("nave", "nave"),
                 ("prf", "prf"),
                 ("rg0", "rg0"),
+                ("NyquistVelocity", "nyquist_velocity"),
                 ("tpow", "tpow"),
             ],
         ),
@@ -331,7 +386,7 @@ def _get_keymap(filetype: str) -> dict[str, str]:
                 ("nave", "nave"),
                 ("prf", "prf"),
                 ("rg0", "rg0"),
-                ("NyquistVelocity", "NyquistVelocity"),  # variable in some mmclx files
+                ("NyquistVelocity", "nyquist_velocity"),
                 ("tpow", "tpow"),
             ]
         ),

cloudnetpy-1.93.5/cloudnetpy/model_evaluation/__init__.py

@@ -0,0 +1,6 @@
+from cloudnetpy.model_evaluation.plotting.plotting import generate_L3_day_plots
+from cloudnetpy.model_evaluation.products.product_resampling import (
+    process_L3_day_product,
+)
+
+__all__ = ["generate_L3_day_plots", "process_L3_day_product"]

{cloudnetpy-1.93.4 → cloudnetpy-1.93.5}/cloudnetpy/model_evaluation/plotting/plotting.py

@@ -103,8 +103,7 @@ def generate_L3_day_plots(
         separated from standard timegrid to their own figures.
 
     Examples:
-        >>> from cloudnetpy.model_evaluation.plotting.plotting
-        import generate_L3_day_plots
+        >>> from cloudnetpy.model_evaluation import generate_L3_day_plots
         >>> l3_day_file = 'cf_ecmwf.nc'
         >>> product = 'cf'
         >>> generate_L3_day_plots(l3_day_file, product)

{cloudnetpy-1.93.4 → cloudnetpy-1.93.5}/cloudnetpy/model_evaluation/products/product_resampling.py

@@ -55,8 +55,7 @@ def process_L3_day_product(
         FileExistsError: Output file exists and overwrite is False.
 
     Examples:
-        >>> from cloudnetpy.model_evaluation.products.product_resampling import \
-        process_L3_day_product
+        >>> from cloudnetpy.model_evaluation import process_L3_day_product
         >>> process_L3_day_product('ecmwf', 'cf', 'ecmwf.nc',
         ... 'categorize.nc', 'l3-cf.nc')
     """

{cloudnetpy-1.93.4 → cloudnetpy-1.93.5}/cloudnetpy/model_evaluation/tests/unit/test_tools.py

@@ -37,7 +37,7 @@ def test_calculate_advection_time_hour(model_file) -> None:
     expected = resolution * 1000 / wind / 60**2
     expected[expected > 1 / sampling] = 1 / sampling
     expected = np.asarray([[timedelta(hours=float(t)) for t in tt] for tt in expected])
-    result = tools.calculate_advection_time(resolution, ma.masked_array(wind), sampling)
+    result = tools.calculate_advection_time(resolution, ma.array(wind), sampling)
     assert result.all() == expected.all()
 
 
@@ -49,14 +49,14 @@ def test_calculate_advection_time_10min(model_file) -> None:
     expected = resolution * 1000 / wind / 60**2
     expected[expected > 1 / sampling] = 1 / sampling
     expected = np.asarray([[timedelta(hours=float(t)) for t in tt] for tt in expected])
-    result = tools.calculate_advection_time(resolution, ma.masked_array(wind), sampling)
+    result = tools.calculate_advection_time(resolution, ma.array(wind), sampling)
     assert result.all() == expected.all()
 
 
 def test_calculate_advection_time_fractional_resolution() -> None:
     # A sub-kilometre / fractional resolution must not be truncated to int.
     resolution = 0.5
-    wind = ma.masked_array([[2.0]])
+    wind = ma.array([[2.0]])
     sampling = 6
     result = tools.calculate_advection_time(resolution, wind, sampling)
     expected = timedelta(hours=resolution * 1000 / 2.0 / 60**2)

{cloudnetpy-1.93.4 → cloudnetpy-1.93.5}/cloudnetpy/plotting/plotting.py

@@ -671,7 +671,7 @@ class Plot2D(Plot):
         if "rain_detected" not in figure_data.file.variables:
             return
         rain = figure_data.file.variables["rain_detected"][:]
-        is_rain: ma.MaskedArray = ma.masked_array(np.zeros_like(rain), mask=(rain == 0))
+        is_rain: ma.MaskedArray = ma.array(np.zeros_like(rain), mask=(rain == 0))
         if is_rain.mask.all():
             return
         self._ax.plot(

{cloudnetpy-1.93.4 → cloudnetpy-1.93.5}/cloudnetpy/products/lwc.py

@@ -344,7 +344,7 @@ class LwcError:
 
     def _calc_lwc_gradient(self) -> npt.NDArray:
         if not isinstance(self.lwc, ma.MaskedArray):
-            self.lwc = ma.masked_array(self.lwc)
+            self.lwc = ma.array(self.lwc)
         gradient_elements = np.gradient(self.lwc.filled(0))
         return utils.l2norm(*gradient_elements)
 

{cloudnetpy-1.93.4 → cloudnetpy-1.93.5}/cloudnetpy/utils.py

@@ -146,7 +146,7 @@ def rebin_2d(
     stat_fn = REBIN_STAT_FN[statistic]
 
     shape = array.shape if keepdim else (n_bins, array.shape[1])
-    result: ma.MaskedArray = ma.masked_array(np.ones(shape, dtype="float32"), mask=True)
+    result: ma.MaskedArray = ma.array(np.ones(shape, dtype="float32"), mask=True)
 
     for bin_ind in range(n_bins):
         if counts[bin_ind] < n_min:

{cloudnetpy-1.93.4 → cloudnetpy-1.93.5}/cloudnetpy/version.py

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

{cloudnetpy-1.93.4 → cloudnetpy-1.93.5/cloudnetpy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudnetpy
-Version: 1.93.4
+Version: 1.93.5
 Summary: Python package for Cloudnet processing
 Author: Simo Tukiainen
 License: MIT License
@@ -106,12 +106,23 @@ python3 -m pip install .
 
 ### Verification
 
-To verify the installation:
+Verify the installation by running `cloudnetpy --help`.
+
+## Command-line usage
+
+CloudnetPy ships with a `cloudnetpy` console script that fetches data from the
+[Cloudnet data portal](https://cloudnet.fmi.fi), runs the requested processing
+steps, and writes netCDF files (and optionally plots) to disk:
 
 ```sh
-cloudnetpy --help
+cloudnetpy --site munich --date 2023-07-29 --products radar --show
+cloudnetpy --site kenttarova --date 2025-07-29 --products classification --show
+cloudnetpy -s kenttarova -d 2025-05-28 -p l3-cf -m harmonie-fmi-6-11 --show
 ```
 
+See the [command-line usage documentation](https://actris-cloudnet.github.io/cloudnetpy/cli.html)
+for instrument selection, different products, plotting, and all options.
+
 ## Citing
 
 If you wish to acknowledge CloudnetPy in your publication, please cite: