cloudnetpy 1.61.15__py3-none-any.whl → 1.61.16__py3-none-any.whl

cloudnetpy/categorize/atmos.py

@@ -1,6 +1,7 @@
 """This module contains functions to calculate
 various atmospheric parameters.
 """
+
 from typing import Final
 
 import numpy as np

cloudnetpy/categorize/atmos_utils.py

@@ -129,5 +129,5 @@ def k2c(temp: np.ndarray) -> np.ndarray:
 
 
 def mmh2ms(data: np.ndarray) -> np.ndarray:
-    """Converts mm h-1 to m s-1"""
+    """Converts mm h-1 to m s-1."""
     return data / con.SEC_IN_HOUR * con.MM_TO_M

cloudnetpy/categorize/categorize.py

@@ -1,4 +1,5 @@
 """Module that generates Cloudnet categorize file."""
+
 import logging
 
 from cloudnetpy import output, utils

cloudnetpy/categorize/classify.py

@@ -1,6 +1,7 @@
 """Module containing low-level functions to classify gridded
 radar / lidar measurements.
 """
+
 import numpy as np
 import skimage
 from numpy import ma

cloudnetpy/categorize/containers.py

@@ -9,7 +9,7 @@ from cloudnetpy.constants import MM_H_TO_M_S
 
 @dataclass
 class ClassificationResult:
-    """Result of classification"""
+    """Result of classification."""
 
     category_bits: np.ndarray
     is_rain: np.ndarray
@@ -103,6 +103,8 @@ def _find_clutter(
     """Estimates clutter from doppler velocity.
 
     Args:
+        v: 2D radar velocity.
+        is_rain: 2D boolean array denoting rain.
         n_gates: Number of range gates from the ground where clutter is expected
             to be found. Default is 10.
         v_lim: Velocity threshold. Smaller values are classified as clutter.

cloudnetpy/categorize/disdrometer.py

@@ -1,4 +1,5 @@
 """Mwr module, containing the :class:`Mwr` class."""
+
 import logging
 
 import numpy as np

cloudnetpy/categorize/droplet.py

@@ -1,5 +1,5 @@
-"""This module has functions for liquid layer detection.
-"""
+"""This module has functions for liquid layer detection."""
+
 import numpy as np
 import scipy.signal
 from numpy import ma

cloudnetpy/categorize/falling.py

@@ -1,4 +1,5 @@
 """Module to find falling hydrometeors from data."""
+
 import numpy as np
 from numpy import ma
 

cloudnetpy/categorize/freezing.py

@@ -1,4 +1,5 @@
 """Module to find freezing region from data."""
+
 import logging
 
 import numpy as np

cloudnetpy/categorize/insects.py

@@ -1,4 +1,5 @@
 """Module to find insects from data."""
+
 import numpy as np
 from numpy import ma
 from scipy.ndimage import gaussian_filter

cloudnetpy/categorize/lidar.py

@@ -1,4 +1,5 @@
 """Lidar module, containing the :class:`Lidar` class."""
+
 import logging
 from typing import Literal
 

cloudnetpy/categorize/melting.py

@@ -1,4 +1,5 @@
 """Functions to find melting layer from data."""
+
 import numpy as np
 from numpy import ma
 from scipy.ndimage import gaussian_filter

cloudnetpy/categorize/model.py

@@ -1,4 +1,5 @@
 """Model module, containing the :class:`Model` class."""
+
 import numpy as np
 from numpy import ma
 from scipy.interpolate import interp1d

cloudnetpy/categorize/mwr.py

@@ -1,4 +1,5 @@
 """Mwr module, containing the :class:`Mwr` class."""
+
 import numpy as np
 
 from cloudnetpy import utils

cloudnetpy/categorize/radar.py

@@ -1,4 +1,5 @@
 """Radar module, containing the :class:`Radar` class."""
+
 import logging
 import math
 

cloudnetpy/cloudnetarray.py

@@ -1,4 +1,5 @@
 """CloudnetArray class."""
+
 import math
 from collections.abc import Sequence
 
@@ -62,6 +63,7 @@ class CloudnetArray:
         Args:
             time: 1D time array.
             time_new: 1D new time array.
+            mask_zeros: Whether to mask 0 values in the returned array. Default is True.
 
         Returns:
             Time indices without data.

cloudnetpy/concat_lib.py

@@ -1,4 +1,5 @@
 """Module for concatenating netCDF files."""
+
 import netCDF4
 import numpy as np
 

cloudnetpy/constants.py

@@ -1,4 +1,5 @@
 """Constants used in Cloudnet processing."""
+
 from typing import Final
 
 # Triple point of water

cloudnetpy/datasource.py

@@ -1,4 +1,5 @@
-"""Datasource module, containing the :class:`DataSource class.`"""
+"""Datasource module, containing the :class:`DataSource` class."""
+
 import logging
 import os
 from collections.abc import Callable
@@ -94,6 +95,7 @@ class DataSource:
                 attribute (dictionary).
             name: CloudnetArray.name attribute. Default value is *key*.
             units: CloudnetArray.units attribute.
+            dtype: CloudnetArray.data_type attribute.
 
         """
         self.data[key] = CloudnetArray(variable, name or key, units, data_type=dtype)
@@ -101,10 +103,10 @@ class DataSource:
     def get_date(self) -> list:
         """Returns date components.
 
-        Returns
+        Returns:
             list: Date components [YYYY, MM, DD].
 
-        Raises
+        Raises:
              RuntimeError: Not found or invalid date.
 
         """

cloudnetpy/instruments/basta.py

@@ -1,4 +1,5 @@
 """Module for reading / converting BASTA radar data."""
+
 import numpy as np
 
 from cloudnetpy import output

cloudnetpy/instruments/ceilo.py

@@ -1,4 +1,5 @@
 """Module for reading and processing Vaisala / Lufft ceilometers."""
+
 from itertools import islice
 
 import netCDF4
@@ -45,7 +46,7 @@ def ceilo2nc(
         site_meta: Dictionary containing information about the site and instrument.
             Required key value pairs are `name` and `altitude` (metres above mean
             sea level). Also, 'calibration_factor' is recommended because the default
-            value is probably incorrect. If the backround noise is *not*
+            value is probably incorrect. If the background noise is *not*
             range-corrected, you must define: {'range_corrected': False}.
             You can also explicitly set the instrument model with
             e.g. {'model': 'cl61d'}.

cloudnetpy/instruments/cl61d.py

@@ -1,4 +1,5 @@
 """Module with a class for Lufft chm15k ceilometer."""
+
 import logging
 
 import netCDF4

cloudnetpy/instruments/copernicus.py

@@ -1,4 +1,5 @@
 """Module for reading raw cloud radar data."""
+
 import os
 import tempfile
 from tempfile import TemporaryDirectory
@@ -126,7 +127,7 @@ class Copernicus(ChilboltonRadar):
     def mask_corrupted_values(self) -> None:
         """Experimental masking of corrupted Copernicus data.
 
-        Notes
+        Notes:
             This method is based on a few days of test data only. Should be improved
             and tested more carefully in the future.
         """

cloudnetpy/instruments/disdrometer/parsivel.py

@@ -43,7 +43,7 @@ def parsivel2nc(
             the instrument's operating instructions. Unknown values are indicated
             with None. Telegram is required if the input file doesn't contain a
             header.
-        timestamps:
+        timestamps: Specify list of timestamps if they are missing in the input file.
 
     Returns:
         UUID of the generated file.
@@ -450,7 +450,7 @@ def _parse_row(row_in: str, headers: list[str]) -> list:
 def _read_toa5(filename: str | PathLike) -> dict[str, list]:
     """Read ASCII data from Campbell Scientific datalogger such as CR1000.
 
-    References
+    References:
         CR1000 Measurement and Control System.
         https://s.campbellsci.com/documents/us/manuals/cr1000.pdf
     """
@@ -616,8 +616,10 @@ def _read_typ_op4a(lines: list[str]) -> dict[str, Any]:
 
 
 def _read_fmi(content: str):
-    """Read format used by Finnish Meteorological Institute and University of
-    Helsinki:
+    r"""Read format used by Finnish Meteorological Institute and University of
+    Helsinki.
+
+    Format consists of sequence of the following:
     - "[YYYY-MM-DD HH:MM:SS\n"
     - output of "CS/PA" command without non-printable characters at the end
     - "]\n"

cloudnetpy/instruments/galileo.py

@@ -1,4 +1,5 @@
 """Module for reading raw Galileo cloud radar data."""
+
 import os
 from tempfile import NamedTemporaryFile, TemporaryDirectory
 

cloudnetpy/instruments/hatpro.py

@@ -1,4 +1,5 @@
 """This module contains RPG Cloud Radar related functions."""
+
 import datetime
 import logging
 from collections import defaultdict

cloudnetpy/instruments/lufft.py

@@ -1,4 +1,5 @@
 """Module with a class for Lufft chm15k ceilometer."""
+
 import logging
 
 import netCDF4

cloudnetpy/instruments/mira.py

@@ -1,4 +1,5 @@
 """Module for reading raw cloud radar data."""
+
 import logging
 import os
 from collections import OrderedDict

cloudnetpy/instruments/mrr.py

@@ -134,7 +134,7 @@ class MrrPro(NcRadar):
         if m := re.search(
             r"serial number:\s*(\w+)",
             self.dataset.instrument_name,
-            re.I,
+            re.IGNORECASE,
         ):
             self.serial_number = m[1]
 

cloudnetpy/instruments/nc_lidar.py

@@ -1,4 +1,5 @@
 """Module with a class for Lufft chm15k ceilometer."""
+
 import logging
 from typing import TYPE_CHECKING, Literal
 

cloudnetpy/instruments/nc_radar.py

@@ -1,4 +1,5 @@
 """Module for reading raw cloud radar data."""
+
 import logging
 from os import PathLike
 from typing import TYPE_CHECKING

cloudnetpy/instruments/pollyxt.py

@@ -1,4 +1,5 @@
 """Module for reading / converting pollyxt data."""
+
 import glob
 import logging
 

cloudnetpy/instruments/radiometrics.py

@@ -1,4 +1,5 @@
 """Module for reading Radiometrics MP3014 microwave radiometer data."""
+
 import csv
 import datetime
 import logging
@@ -80,7 +81,7 @@ class Record(NamedTuple):
 class Radiometrics:
     """Reader for level 2 files of Radiometrics microwave radiometers.
 
-    References
+    References:
         Radiometrics (2008). Profiler Operator's Manual: MP-3000A, MP-2500A,
         MP-1500A, MP-183A.
     """

cloudnetpy/instruments/rpg.py

@@ -1,4 +1,5 @@
 """This module contains RPG Cloud Radar related functions."""
+
 import logging
 import math
 from collections.abc import Sequence
@@ -111,7 +112,7 @@ def create_one_day_data_record(rpg_objects: RpgObjects) -> dict:
 def _stack_rpg_data(rpg_objects: RpgObjects) -> tuple[dict, dict]:
     """Combines data from hourly RPG objects.
 
-    Notes
+    Notes:
         Ignores variable names starting with an underscore.
 
     """

cloudnetpy/instruments/rpg_reader.py

@@ -164,7 +164,7 @@ def _decode_angles(
 class HatproBin:
     """HATPRO binary file reader. Byte order is assumed to be little endian.
 
-    References
+    References:
         Radiometer Physics (2014): Instrument Operation and Software Guide
         Operation Principles and Software Description for RPG standard single
         polarization radiometers (G5 series).

cloudnetpy/instruments/toa5.py

@@ -9,7 +9,7 @@ def read_toa5(
 ) -> tuple[dict[str, str], dict[str, str], list[dict[str, Any]]]:
     """Read ASCII data from Campbell Scientific datalogger such as CR1000.
 
-    References
+    References:
         CR1000 Measurement and Control System.
         https://s.campbellsci.com/documents/us/manuals/cr1000.pdf
     """

cloudnetpy/instruments/vaisala.py

@@ -1,4 +1,5 @@
 """Module with classes for Vaisala ceilometers."""
+
 import itertools
 import logging
 
@@ -139,7 +140,7 @@ class VaisalaCeilo(Ceilometer):
 
     @staticmethod
     def _calc_date(time_lines) -> list:
-        """Returns the date [yyyy, mm, dd]"""
+        """Returns the date [yyyy, mm, dd]."""
         return time_lines[0].split()[0].strip("-").split("-")
 
     @classmethod
@@ -305,7 +306,7 @@ class ClCeilo(VaisalaCeilo):
 class Ct25k(VaisalaCeilo):
     """Class for Vaisala CT25k ceilometer.
 
-    References
+    References:
         https://www.manualslib.com/manual/1414094/Vaisala-Ct25k.html
 
     """
@@ -367,11 +368,11 @@ class Ct25k(VaisalaCeilo):
 def split_string(string: str, indices: list) -> list:
     """Splits string between indices.
 
-    Notes
+    Notes:
         It is possible to skip characters from the beginning and end of the
         string but not from the middle.
 
-    Examples
+    Examples:
         >>> s = 'abcde'
         >>> indices = [1, 2, 4]
         >>> split_string(s, indices)
@@ -384,7 +385,7 @@ def split_string(string: str, indices: list) -> list:
 def values_to_dict(keys: tuple, values: list) -> dict:
     """Converts list elements to dictionary.
 
-    Examples
+    Examples:
         >>> keys = ('a', 'b')
         >>> values = [[1, 2], [1, 2], [1, 2], [1, 2]]
         >>> values_to_dict(keys, values)
@@ -398,6 +399,6 @@ def values_to_dict(keys: tuple, values: list) -> dict:
 
 
 def time_to_fraction_hour(time: str) -> float:
-    """Returns time (hh:mm:ss) as fraction hour"""
+    """Returns time (hh:mm:ss) as fraction hour."""
     hour, minute, sec = time.split(":")
     return int(hour) + (int(minute) * SEC_IN_MINUTE + int(sec)) / SEC_IN_HOUR

cloudnetpy/instruments/weather_station.py

@@ -320,11 +320,10 @@ class KenttarovaWS(WS):
 
 
 class HyytialaWS(WS):
-    """
-    Hyytiälä rain-gauge variables: a = Pluvio400 and b = Pluvio200.
+    """Hyytiälä rain-gauge variables: a = Pluvio400 and b = Pluvio200.
     E.g.
     - AaRNRT/mm = amount of non-real-time rain total (Pluvio400) [mm]
-    - BbRT/mm = Bucket content in real-time (Pluvio200) [mm]
+    - BbRT/mm = Bucket content in real-time (Pluvio200) [mm].
     """
 
     def __init__(self, filenames: list[str], site_meta: dict):

cloudnetpy/model_evaluation/file_handler.py

@@ -145,7 +145,7 @@ def _augment_global_attributes(root_group: netCDF4.Dataset) -> None:
 
 
 def _add_source(root_ground: netCDF4.Dataset, objects: tuple, files: tuple) -> None:
-    """Generates source info for multiple files"""
+    """Generates source info for multiple files."""
     model, obs = objects
     model_files, obs_file = files
     source = f"Observation file: {os.path.basename(obs_file)}"
@@ -160,7 +160,7 @@ def _add_source(root_ground: netCDF4.Dataset, objects: tuple, files: tuple) -> N
 
 
 def add_time_attribute(date: datetime) -> dict:
-    """ "Adds time attribute with correct units.
+    """Adds time attribute with correct units.
 
     Args:
         attributes: Attributes of variables.

cloudnetpy/model_evaluation/metadata.py

@@ -114,7 +114,7 @@ REGRID_PRODUCT_ATTRIBUTES = {
         comment=(
             "Cloud fraction generated from observations and by volume,\n"
             "averaged onto the models grid with height and time. Volume is\n"
-            "space withing four grid points."
+            "space within four grid points."
         ),
     ),
     "cf_A": MetaData(

cloudnetpy/model_evaluation/plotting/plot_tools.py

@@ -13,7 +13,7 @@ def parse_wanted_names(
     *,
     advance: bool = False,
 ) -> tuple[list, list]:
-    """Returns standard and advection lists of product types to plot"""
+    """Returns standard and advection lists of product types to plot."""
     if variables:
         names = variables
     else:
@@ -76,7 +76,7 @@ def sort_cycles(names: list, model: str) -> tuple[list, list]:
 
 
 def read_data_characters(nc_file: str, name: str, model: str) -> tuple:
-    """Gets dimensions and data for plotting"""
+    """Gets dimensions and data for plotting."""
     nc = netCDF4.Dataset(nc_file)
     data = nc.variables[name][:]
     data = mask_small_values(data, name)

cloudnetpy/model_evaluation/plotting/plotting.py

@@ -7,9 +7,11 @@ import matplotlib as mpl
 import matplotlib.pyplot as plt
 import netCDF4
 import numpy as np
+from matplotlib.axes import Axes
 from matplotlib.colorbar import Colorbar
 from matplotlib.colors import ListedColormap
 from matplotlib.patches import Patch
+from matplotlib.pyplot import Figure
 from mpl_toolkits.axes_grid1 import make_axes_locatable
 from numpy import ma
 
@@ -187,6 +189,7 @@ def get_group_plots(
         show (bool): Show figure before saving if True
         cycle (str): Name of cycle if exists
         title (bool): True or False if wanted to add title to subfig
+        include_xlimits (bool): Show labels at the ends of x-axis
     """
     fig, ax = initialize_figure(len(names))
     model_run = model
@@ -248,6 +251,7 @@ def get_pair_plots(
         show (bool): Show figure before saving if True
         cycle (str): Name of cycle if exists
         title (bool): True or False if wanted add title to subfig
+        include_xlimits (bool): Show labels at the ends of x-axis
     """
     variable_info = ATTRIBUTES[product]
     model_ax = names[0]
@@ -306,6 +310,7 @@ def get_single_plots(
         show (bool): Show figure before saving if True
         cycle (str): Name of cycle if exists
         title (bool): True or False if wanted to add title to subfig
+        include_xlimits (bool): Show labels at the ends of x-axis
     """
     figs = []
     axes = []
@@ -387,6 +392,7 @@ def get_statistic_plots(
         image_name (str, optional): Saving name of generated fig
         show (bool): Show figure before saving if True
         cycle (str): Name of cycle if exists
+        title (bool): True or False if wanted to add title to subfig
     """
     model_run = model
     name = ""
@@ -687,8 +693,8 @@ def plot_vertical_profile(
     ax.xaxis.grid(which="major")
 
 
-def initialize_figure(n_subplots: int, stat: str = "") -> tuple:
-    """Set up fig and ax object, if subplot"""
+def initialize_figure(n_subplots: int, stat: str = "") -> tuple[Figure, list[Axes]]:
+    """Set up fig and ax object, if subplot."""
     if n_subplots <= 0:
         n_subplots = 1
     fig, axes = plt.subplots(n_subplots, 1, figsize=(16, 4 + (n_subplots - 1) * 4.8))
@@ -714,7 +720,6 @@ def initialize_figure(n_subplots: int, stat: str = "") -> tuple:
                 right=0.75,
                 hspace=0.2,
             )
-            axes = axes.flatten()
     if stat == "vertical" and n_subplots > 1:
         fig, axes = plt.subplots(
             int(n_subplots / 2),
@@ -731,10 +736,8 @@ def initialize_figure(n_subplots: int, stat: str = "") -> tuple:
             right=0.75,
             hspace=0.16,
         )
-        axes = axes.flatten()
-    if n_subplots == 1:
-        axes = [axes]
-    return fig, axes
+    axes_list = [axes] if isinstance(axes, Axes) else axes.flatten().tolist()
+    return fig, axes_list
 
 
 def init_colorbar(plot, axis) -> Colorbar:
@@ -750,7 +753,7 @@ def _set_title(
     variable_info,
     model_name: str = "",
 ) -> None:
-    """Generates subtitles for different product types"""
+    """Generates subtitles for different product types."""
     parts = field_name.split("_")
     if parts[0] == product:
         title = _get_product_title(variable_info)

cloudnetpy/model_evaluation/products/grid_methods.py

@@ -154,7 +154,7 @@ class ProductGrid:
         x_ind: np.ndarray,
         y_ind: np.ndarray,
     ) -> np.ndarray | None:
-        """Reshapes True observation values to windows shape"""
+        """Reshapes True observation values to windows shape."""
         window_size = tl.get_obs_window_size(x_ind, y_ind)
         if window_size is not None:
             return self._obs_data[ind].reshape(window_size)

cloudnetpy/model_evaluation/products/model_products.py

@@ -54,7 +54,7 @@ class ModelManager(DataSource):
         self.resolution_h = self._get_horizontal_resolution()
 
     def _read_cycle_name(self, model_file: str) -> str:
-        """Get cycle name from model_metadata.py for saving variable name(s)"""
+        """Get cycle name from model_metadata.py for saving variable name(s)."""
         try:
             cycles = self.model_info.cycle
             if cycles is None:
@@ -68,7 +68,7 @@ class ModelManager(DataSource):
         return ""
 
     def _generate_products(self) -> None:
-        """Process needed data of model to a ModelManager object"""
+        """Process needed data of model to a ModelManager object."""
         cls = importlib.import_module(__name__).ModelManager
         try:
             name = f"_get_{self._product}"
@@ -123,10 +123,10 @@ class ModelManager(DataSource):
         return q * p / (287 * t)
 
     def _add_variables(self) -> None:
-        """Add basic variables off model and cycle"""
+        """Add basic variables off model and cycle."""
 
         def _add_common_variables() -> None:
-            """Model variables that are always the same within cycles"""
+            """Model variables that are always the same within cycles."""
             wanted_vars = self.model_vars.common_var
             if wanted_vars is None:
                 msg = f"Model {self.model} has no common variables"
@@ -140,7 +140,7 @@ class ModelManager(DataSource):
                     self.append_data(data, f"{var}")
 
         def _add_cycle_variables() -> None:
-            """Add cycle depending variables"""
+            """Add cycle depending variables."""
             wanted_vars = self.model_vars.cycle_var
             if wanted_vars is None:
                 msg = f"Model {self.model} has no cycle variables"
@@ -160,7 +160,7 @@ class ModelManager(DataSource):
         _add_cycle_variables()
 
     def cut_off_extra_levels(self, data: np.ndarray) -> np.ndarray:
-        """Remove unused levels (over 22km) from model data"""
+        """Remove unused levels (over 22km) from model data."""
         try:
             level = self.model_info.level
         except KeyError:
@@ -169,7 +169,7 @@ class ModelManager(DataSource):
         return data[:, :level] if data.ndim > 1 else data[:level]
 
     def _calculate_wind_speed(self) -> np.ndarray:
-        """Real wind from x- and y-components"""
+        """Real wind from x- and y-components."""
         u = self.getvar("uwind")
         v = self.getvar("vwind")
         u = self.cut_off_extra_levels(u)