cloudnetpy 1.56.1__py3-none-any.whl → 1.56.3__py3-none-any.whl

cloudnetpy/model_evaluation/plotting/plotting.py

@@ -44,7 +44,6 @@ def generate_L3_day_plots(
     in same fig.
 
     Args:
-    ----
         nc_file (str): Path to source file
         product (str): Name of product wanted to plot
         model (str): Name of model which downsampling was done with
@@ -71,7 +70,6 @@ def generate_L3_day_plots(
         figure.
 
     Examples:
-    --------
         >>> from cloudnetpy.model_evaluation.plotting.plotting
         import generate_L3_day_plots
         >>> l3_day_file = 'cf_ecmwf.nc'
@@ -166,7 +164,6 @@ def get_group_plots(
     timegrids. All model cycles if any will be generated to their own figures.
 
     Args:
-    ----
         product (str): Name of the product
         names (list): List of variables to be visualized to same fig
         nc_file (str): Path to a source file
@@ -227,7 +224,6 @@ def get_pair_plots(
     in a given nc-file in loop.
 
     Args:
-    ----
         product (str): Name of the product
         names (list): List of variables to be visualized to same fig
         nc_file (str): Path to a source file
@@ -286,7 +282,6 @@ def get_single_plots(
     """Generates figures of each product variable from given file in loop.
 
     Args:
-    ----
         product (str): Name of the product
         names (list): List of variables to be visualized to same fig
         nc_file (str): Path to a source file
@@ -362,7 +357,6 @@ def get_statistic_plots(
     as well as different cycle runs.
 
     Args:
-    ----
         product (str): Name of the product
         names (list): List of variables to be visualized to same fig
         nc_file (str): Path to a source file

cloudnetpy/model_evaluation/products/advance_methods.py

@@ -17,7 +17,6 @@ class AdvanceProductMethods(DataSource):
     assumptions of model or observation data.
 
     Args:
-    ----
         model_obj (object): The :class:'ModelManager' object.
         obs_obj (object): The :class:'ObservationManager' object.
     """

cloudnetpy/model_evaluation/products/grid_methods.py

@@ -11,12 +11,10 @@ class ProductGrid:
     """Class to generate downsampling of observation product to model grid.
 
     Args:
-    ----
         model_obj (object): The :class:'ModelManager' object.
         obs_obj (object): The :class:'ObservationManager' object.
 
     Notes:
-    -----
         Downsampled observation products data is added to a ModelManager
         object which is used for nc-file creation and writing
     """

cloudnetpy/model_evaluation/products/model_products.py

@@ -14,14 +14,12 @@ class ModelManager(DataSource):
     """Class to collect and manage model data.
 
     Args:
-    ----
         model_file (str): Path to source model file.
         model (str): Name of model
         output_file (str): name of output file name and path to save data
         product (str): name of product to generate
 
     Notes:
-    -----
         For this class to work, needed information of model in use should be found in
         model_metadata.py
 

cloudnetpy/model_evaluation/products/observation_products.py

@@ -13,12 +13,10 @@ class ObservationManager(DataSource):
     """Class to collect and manage observations for downsampling.
 
     Args:
-    ----
         obs (str): Name of observation product
         obs_file (str): Path to source observation file
 
     Notes:
-    -----
         Output is ObservationManager object where all product data and
         information is included.
 

cloudnetpy/model_evaluation/products/product_resampling.py

@@ -31,7 +31,6 @@ def process_L3_day_product(
     and other variables of each cycles.
 
     Args:
-    ----
         model (str): Name of model
         obs (str): Name of product to generate
         model_files (list): List of model + cycles file path(s) to be generated
@@ -44,19 +43,16 @@ def process_L3_day_product(
                           default False
 
     Raises:
-    ------
         RuntimeError: Failed to create the L3 product file.
         ValueError (Warning): No ice clouds in model data
 
     Notes:
-    -----
         Model file(s) are given as a list to make all different cycles to be at same
         nc-file. If list includes more than one model file, nc-file is created within
         the first round. With rest of rounds, downsample observation and model data
         is added to same L3 day nc-file.
 
     Examples:
-    --------
         >>> from cloudnetpy.model_evaluation.products.product_resampling import \
         process_L3_day_product
         >>> product = 'cf'

cloudnetpy/model_evaluation/products/tools.py

@@ -38,7 +38,6 @@ def calculate_advection_time(
     """Calculates time which variable takes to go through the time window
 
     Notes
-    -----
         Wind speed is stronger in upper levels, so advection time is more
         there then lower levels. Effect is small in a mid-latitudes,
         but visible in a tropics.
@@ -46,7 +45,6 @@ def calculate_advection_time(
         sampling = 1 -> hour, sampling 1/6 -> 10min
 
     References
-    ----------
     """
     t_adv = resolution * 1000 / wind / 60**2
     t_adv[t_adv.mask] = 0

cloudnetpy/model_evaluation/statistics/statistical_methods.py

@@ -15,7 +15,6 @@ class DayStatistics:
     and observation data of wanted product.
 
     Args:
-    ----
         method (str): Name on statistical method to be calculated
         product_info (list): List of information of statistical analysis is
             done with. A list includes observed product name (str), model variable (str)
@@ -25,15 +24,12 @@ class DayStatistics:
         observation (np.ndarray): Ndrray of Downsampled observation of product
 
     Raises:
-    ------
         RuntimeError: A function of given method not found
 
     Returns:
-    -------
         day_statistic (object): The :class:'DayStatistic' object.
 
     Examples:
-    --------
         >>> from cloudnetpy.model_evaluation.products.product_resampling import \
         process_L3_day_product
         >>> method = 'error'

cloudnetpy/output.py

@@ -76,7 +76,6 @@ def save_product_file(
     """Saves a standard Cloudnet product file.
 
     Args:
-    ----
         short_id: Short file identifier, e.g. 'lwc', 'iwc', 'drizzle', 'classification'.
         obj: Instance containing product specific attributes: `time`, `dataset`, `data`.
         file_name: Name of the output file to be generated.
@@ -143,7 +142,6 @@ def get_references(identifier: str | None = None, extra: list | None = None) ->
     """ "Returns references.
 
     Args:
-    ----
         identifier: Cloudnet file type, e.g., 'iwc'.
 
     """
@@ -175,11 +173,9 @@ def get_source_uuids(*sources) -> str:
     """Returns file_uuid attributes of objects.
 
     Args:
-    ----
         *sources: Objects whose file_uuid attributes are read (if exist).
 
     Returns:
-    -------
         str: UUIDs separated by comma.
 
     """
@@ -196,7 +192,6 @@ def merge_history(nc: netCDF4.Dataset, file_type: str, data: dict) -> None:
     """Merges history fields from one or several files and creates a new record.
 
     Args:
-    ----
         nc: The netCDF Dataset instance.
         file_type: Long description of the file.
         data: Dictionary of objects with history attribute.
@@ -235,7 +230,6 @@ def init_file(
     """Initializes a Cloudnet file for writing.
 
     Args:
-    ----
         file_name: File name to be generated.
         dimensions: Dictionary containing dimension for this file.
         cloudnet_arrays: Dictionary containing :class:`CloudnetArray` instances.
@@ -258,7 +252,6 @@ def copy_variables(
     """Copies variables (and their attributes) from one file to another.
 
     Args:
-    ----
         source: Source object.
         target: Target object.
         keys: Variable names to be copied.
@@ -292,7 +285,6 @@ def copy_global(
     """Copies global attributes from one file to another.
 
     Args:
-    ----
         source: Source object.
         target: Target object.
         attributes: List of attributes to be copied.
@@ -360,7 +352,6 @@ def update_attributes(cloudnet_variables: dict, attributes: dict) -> None:
     New attributes are added.
 
     Args:
-    ----
         cloudnet_variables: CloudnetArray instances.
         attributes: Product-specific attributes.
 

cloudnetpy/products/classification.py

@@ -22,17 +22,14 @@ def generate_classification(
     netCDF file.
 
     Args:
-    ----
         categorize_file: Categorize file name.
         output_file: Output file name.
         uuid: Set specific UUID for the file.
 
     Returns:
-    -------
         str: UUID of the generated file.
 
     Examples:
-    --------
         >>> from cloudnetpy.products import generate_classification
         >>> generate_classification('categorize.nc', 'classification.nc')
 

cloudnetpy/products/der.py

@@ -41,7 +41,6 @@ def generate_der(
     liquid water path. The results are written in a netCDF file.
 
     Args:
-    ----
         categorize_file: Categorize file name.
         output_file: Output file name.
         uuid: Set specific UUID for the file.
@@ -50,11 +49,9 @@ def generate_der(
         used in Frisch approach.
 
     Returns:
-    -------
         UUID of the generated file.
 
     Examples:
-    --------
         >>> from cloudnetpy.products import generate_der
         >>> generate_der('categorize.nc', 'der.nc')
         >>>
@@ -63,7 +60,6 @@ def generate_der(
         >>> generate_der('categorize.nc', 'der.nc', parameters=params)
 
     References:
-    ----------
         Frisch, S., Shupe, M., Djalalova, I., Feingold, G., & Poellot, M. (2002).
         The Retrieval of Stratus Cloud Droplet Effective Radius with Cloud Radars,
         Journal of Atmospheric and Oceanic Technology, 19(6), 835-842.

cloudnetpy/products/drizzle.py

@@ -26,22 +26,18 @@ def generate_drizzle(
     cloud radar and lidar measurements. The results are written in a netCDF file.
 
     Args:
-    ----
         categorize_file: Categorize file name.
         output_file: Output file name.
         uuid: Set specific UUID for the file.
 
     Returns:
-    -------
         str: UUID of the generated file.
 
     Examples:
-    --------
         >>> from cloudnetpy.products import generate_drizzle
         >>> generate_drizzle('categorize.nc', 'drizzle.nc')
 
     References:
-    ----------
         O’Connor, E.J., R.J. Hogan, and A.J. Illingworth, 2005:
         Retrieving Stratocumulus Drizzle Parameters Using Doppler Radar and Lidar.
         J. Appl. Meteor., 44, 14–27, https://doi.org/10.1175/JAM-2181.1
@@ -72,12 +68,10 @@ class DrizzleProducts:
     """Calculates additional quantities from the drizzle properties.
 
     Args:
-    ----
         drizzle_source: The :class:`DrizzleSource` instance.
         drizzle_solver: The :class:`DrizzleSolver` instance.
 
     Attributes:
-    ----------
         derived_products (dict): Dictionary containing derived drizzle products:
             'drizzle_N', 'drizzle_lwc', 'drizzle_lwf', 'v_drizzle', 'v_air'.
 
@@ -154,11 +148,9 @@ class RetrievalStatus:
     """Estimates the status of drizzle retrievals.
 
     Args:
-    ----
         drizzle_class: The :class:`DrizzleClassification` instance.
 
     Attributes:
-    ----------
         drizzle_class: The :class:`DrizzleClassification` instance.
         retrieval_status (ndarray): 2D array containing drizzle retrieval
             status information.

cloudnetpy/products/drizzle_error.py

@@ -15,12 +15,10 @@ def get_drizzle_error(
     """Estimates error and bias for drizzle classification.
 
     Args:
-    ----
         categorize: The :class:`DrizzleSource` instance.
         drizzle_parameters: The :class:`DrizzleSolver` instance.
 
     Returns:
-    -------
         dict: Dictionary containing information of estimated error and bias for drizzle
 
     """

cloudnetpy/products/drizzle_tools.py

@@ -16,11 +16,9 @@ class DrizzleSource(DataSource):
     """Class holding the input data for drizzle calculations.
 
     Args:
-    ----
         categorize_file: Categorize file name.
 
     Attributes:
-    ----------
         mie (dict): Mie look-up table data.
         dheight (float): Median difference of height array.
         z (ndarray): 2D radar echo (linear units).
@@ -82,11 +80,9 @@ class DrizzleClassification(ProductClassification):
     child of  :class:`ProductClassification`.
 
     Args:
-    ----
         categorize_file: Categorize file name.
 
     Attributes:
-    ----------
         is_v_sigma (ndarray): 2D array denoting finite v_sigma.
         warm_liquid (ndarray): 2D array denoting warm liquid.
         drizzle (ndarray): 2D array denoting drizzle presence.
@@ -150,11 +146,9 @@ class SpectralWidth:
     spectral broadening of the Doppler velocity.
 
     Args:
-    ----
         categorize_file: Categorize file name.
 
     Attributes:
-    ----------
         categorize_file (str): Categorize file name.
         width_ht (ndarray): Spectral width containing the correction for turbulence
             broadening.
@@ -191,7 +185,6 @@ class SpectralWidth:
         """Calculates magnitude of horizontal wind.
 
         Returns
-        -------
             ndarray: Horizontal wind (m s-1).
 
         """
@@ -205,13 +198,11 @@ class DrizzleSolver:
     """Estimates drizzle parameters.
 
     Args:
-    ----
         drizzle_source: The :class:`DrizzleSource` instance.
         drizzle_class: The :class:`DrizzleClassification` instance.
         spectral_width: The :class:`SpectralWidth` instance.
 
     Attributes:
-    ----------
         params (dict): Dictionary of retrieved drizzle parameters 'Do', 'mu', 'S',
             'beta_corr'.
 
@@ -296,18 +287,15 @@ class DrizzleSolver:
         """Drizzle diameter calculation.
 
         Args:
-        ----
             beta_z_ratio: Beta to z ratio, multiplied by (2 / pi).
             mu: Shape parameter for gamma calculations. Default is 0.
             ray: Mie to Rayleigh ratio for z. Default is 1.
             k: Alpha to beta ratio . Default is 1.
 
         Returns:
-        -------
             ndarray: Drizzle diameter.
 
         References:
-        ----------
             https://journals.ametsoc.org/doi/pdf/10.1175/JAM-2181.1
 
         """

cloudnetpy/products/ier.py

@@ -21,22 +21,18 @@ def generate_ier(
     and model temperature. The results are written in a netCDF file.
 
     Args:
-    ----
         categorize_file: Categorize file name.
         output_file: Output file name.
         uuid: Set specific UUID for the file.
 
     Returns:
-    -------
         UUID of the generated file.
 
     Examples:
-    --------
         >>> from cloudnetpy.products import generate_ier
         >>> generate_ier('categorize.nc', 'ier.nc')
 
     References:
-    ----------
         Hogan, R. J., Mittermaier, M. P., & Illingworth, A. J. (2006). The Retrieval
         of Ice Water Content from Radar Reflectivity Factor and Temperature and Its
         Use in Evaluating a Mesoscale Model, Journal of Applied Meteorology and

cloudnetpy/products/iwc.py

@@ -21,22 +21,18 @@ def generate_iwc(
     netCDF file.
 
     Args:
-    ----
         categorize_file: Categorize file name.
         output_file: Output file name.
         uuid: Set specific UUID for the file.
 
     Returns:
-    -------
         UUID of the generated file.
 
     Examples:
-    --------
         >>> from cloudnetpy.products import generate_iwc
         >>> generate_iwc('categorize.nc', 'iwc.nc')
 
     References:
-    ----------
         Hogan, R.J., M.P. Mittermaier, and A.J. Illingworth, 2006:
         The Retrieval of Ice Water Content from Radar Reflectivity Factor and
         Temperature and Its Use in Evaluating a Mesoscale Model.

cloudnetpy/products/lwc.py

@@ -25,22 +25,18 @@ def generate_lwc(
     content of observed liquid clouds. The results are written in a netCDF file.
 
     Args:
-    ----
         categorize_file: Categorize file name.
         output_file: Output file name.
         uuid: Set specific UUID for the file.
 
     Returns:
-    -------
         str: UUID of the generated file.
 
     Examples:
-    --------
         >>> from cloudnetpy.products import generate_lwc
         >>> generate_lwc('categorize.nc', 'lwc.nc')
 
     References:
-    ----------
         Illingworth, A.J., R.J. Hogan, E. O'Connor, D. Bouniol, M.E. Brooks,
         J. Delanoé, D.P. Donovan, J.D. Eastment, N. Gaussiat, J.W. Goddard,
         M. Haeffelin, H.K. Baltink, O.A. Krasnov, J. Pelon, J. Piriou, A. Protat,
@@ -76,11 +72,9 @@ class LwcSource(DataSource):
     structures and methods for holding the results.
 
     Args:
-    ----
         categorize_file: Categorize file name.
 
     Attributes:
-    ----------
         lwp (ndarray): 1D liquid water path.
         lwp_error (ndarray): 1D error of liquid water path.
         is_rain (ndarray): 1D array denoting presence of rain.
@@ -122,11 +116,9 @@ class Lwc:
     """Class handling the actual LWC calculations.
 
     Args:
-    ----
         lwc_source: The :class:`LwcSource` instance.
 
     Attributes:
-    ----------
         lwc_source (LwcSource): The :class:`LwcSource` instance.
         dheight (float): Median difference in height vector.
         is_liquid (ndarray): 2D array denoting liquid.
@@ -175,12 +167,10 @@ class CloudAdjustor:
     """Adjusts clouds (where possible) so that theoretical and measured LWP agree.
 
     Args:
-    ----
         lwc_source: The :class:`LwcSource` instance.
         lwc:  The :class:`Lwc` instance.
 
     Attributes:
-    ----------
         lwc_source (LwcSource): The :class:`LwcSource` instance.
         lwc (ndarray): Liquid water content data.
         is_liquid (ndarray): 2D array denoting liquid.
@@ -272,11 +262,9 @@ class CloudAdjustor:
         """Finds top clouds that contain only lidar-detected pixels.
 
         Args:
-        ----
             detection: Array of integers where 1=lidar, 2=radar, 3=both.
 
         Returns:
-        -------
             Boolean array containing top-clouds that are detected only by lidar.
 
         """
@@ -313,12 +301,10 @@ class LwcError:
     """Calculates liquid water content error.
 
     Args:
-    ----
         lwc_source: The :class:`LwcSource` instance.
         lwc: The :class:`Lwc` instance.
 
     Attributes:
-    ----------
         lwc_source (LwcSource): The :class:`LwcSource` instance.
         lwc (ndarray): Liquid water content data.
         error (ndarray): 2D array storing lwc_error.

cloudnetpy/products/product_tools.py

@@ -26,11 +26,9 @@ class CategorizeBits:
     """Class holding information about category and quality bits.
 
     Args:
-    ----
         categorize_file (str): Categorize file name.
 
     Attributes:
-    ----------
         category_bits (dict): Dictionary containing boolean fields for `droplet`,
             `falling`, `cold`, `melting`, `aerosol`, `insect`.
 
@@ -78,11 +76,9 @@ class ProductClassification(CategorizeBits):
     of various Cloudnet products. Child of CategorizeBits class.
 
     Args:
-    ----
         categorize_file (str): Categorize file name.
 
     Attributes:
-    ----------
         is_rain (ndarray): 1D array denoting rainy profiles.
 
     """
@@ -190,7 +186,6 @@ class IceSource(DataSource):
         """Returns coefficients for ice effective radius retrieval.
 
         References
-        ----------
             Hogan et.al. 2006, https://doi.org/10.1175/JAM2340.1
         """
         if self.product == "ier":
@@ -251,12 +246,10 @@ def read_nc_fields(nc_file: str, names: str | list) -> ma.MaskedArray | list:
     """Reads selected variables from a netCDF file.
 
     Args:
-    ----
         nc_file: netCDF file name.
         names: Variables to be read, e.g. 'temperature' or ['ldr', 'lwp'].
 
     Returns:
-    -------
         ndarray/list: Array in case of one variable passed as a string.
         List of arrays otherwise.
 
@@ -271,13 +264,11 @@ def interpolate_model(cat_file: str, names: str | list) -> dict[str, np.ndarray]
     """Interpolates 2D model field into dense Cloudnet grid.
 
     Args:
-    ----
         cat_file: Categorize file name.
         names: Model variable to be interpolated, e.g. 'temperature' or ['temperature',
             'pressure'].
 
     Returns:
-    -------
         dict: Interpolated variables.
 
     """