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

cloudnetpy/cloudnetarray.py

@@ -14,7 +14,6 @@ class CloudnetArray:
     """Stores netCDF4 variables, numpy arrays and scalars as CloudnetArrays.
 
     Args:
-    ----
         variable: The netCDF4 :class:`Variable` instance,
             numpy array (masked or regular), or scalar (float, int).
         name: Name of the variable.
@@ -59,12 +58,10 @@ class CloudnetArray:
         """Rebins `data` in time.
 
         Args:
-        ----
             time: 1D time array.
             time_new: 1D new time array.
 
         Returns:
-        -------
             Time indices without data.
 
         """
@@ -149,12 +146,10 @@ class CloudnetArray:
         """Calculates std of radar velocity.
 
         Args:
-        ----
             time: 1D time array.
             time_new: 1D new time array.
 
         Notes:
-        -----
             The result is masked if the bin contains masked values.
         """
         data_as_float = self.data.astype(float)
@@ -171,7 +166,6 @@ class CloudnetArray:
         """Rebins Doppler velocity in polar coordinates.
 
         Args:
-        ----
             time: 1D time array.
             time_new: 1D new time array.
             folding_velocity: Folding velocity (m/s). Can be a float when

cloudnetpy/concat_lib.py

@@ -47,16 +47,13 @@ def update_nc(old_file: str, new_file: str) -> int:
     """Appends data to existing netCDF file.
 
     Args:
-    ----
         old_file: Filename of an existing netCDF file.
         new_file: Filename of a new file whose data will be appended to the end.
 
     Returns:
-    -------
         1 = success, 0 = failed to add new data.
 
     Notes:
-    -----
         Requires 'time' variable with unlimited dimension.
 
     """
@@ -86,7 +83,6 @@ def concatenate_files(
     """Concatenate netCDF files in one dimension.
 
     Args:
-    ----
         filenames: List of files to be concatenated.
         output_file: Output file name.
         concat_dimension: Dimension name for concatenation. Default is 'time'.
@@ -98,7 +94,6 @@ def concatenate_files(
             another (value from the first file is saved).
 
     Notes:
-    -----
         Arrays without 'concat_dimension', scalars, and global attributes will be taken
         from the first file. Groups, possibly present in a NETCDF4 formatted file,
         are ignored.

cloudnetpy/datasource.py

@@ -16,12 +16,10 @@ class DataSource:
     """Base class for all Cloudnet measurements and model data.
 
     Args:
-    ----
         full_path: Calibrated instrument / model NetCDF file.
         radar: Indicates if data is from cloud radar. Default is False.
 
     Attributes:
-    ----------
         filename (str): Filename of the input file.
         dataset (netCDF4.Dataset): A netCDF4 Dataset instance.
         source (str): Global attribute `source` read from the input file.
@@ -65,15 +63,12 @@ class DataSource:
             variables dictionary, fetched from the input netCDF file.
 
         Args:
-        ----
             *args: possible names of the variable. The first match is returned.
 
         Returns:
-        -------
             ndarray: The actual data.
 
         Raises:
-        ------
              RuntimeError: The variable is not found.
 
         """
@@ -93,7 +88,6 @@ class DataSource:
         """Adds new CloudnetVariable or RadarVariable into `data` attribute.
 
         Args:
-        ----
             variable: netCDF variable or data array to be added.
             key: Key used with *variable* when added to `data`
                 attribute (dictionary).
@@ -107,11 +101,9 @@ class DataSource:
         """Returns date components.
 
         Returns
-        -------
             list: Date components [YYYY, MM, DD].
 
         Raises
-        ------
              RuntimeError: Not found or invalid date.
 
         """
@@ -191,13 +183,11 @@ class DataSource:
         """Transforms netCDF4-variables into CloudnetArrays.
 
         Args:
-        ----
             keys: netCDF4-variables to be converted. The results
                 are saved in *self.data* dictionary with *fields*
                 strings as keys.
 
         Notes:
-        -----
             The attributes of the variables are not copied. Just the data.
 
         """
@@ -215,7 +205,6 @@ class DataSource:
         """Transforms single netCDF4 variable into CloudnetArray.
 
         Args:
-        ----
             possible_names: Tuple of strings containing the possible
                 names of the variable in the input NetCDF file.
             key: Key for self.data dictionary and name-attribute
@@ -224,7 +213,6 @@ class DataSource:
             ignore_mask: If true, always writes an ordinary numpy array.
 
         Raises:
-        ------
             RuntimeError: No variable found.
 
         """

cloudnetpy/instruments/basta.py

@@ -22,7 +22,6 @@ def basta2nc(
     steps.
 
     Args:
-    ----
         basta_file: Filename of a daily BASTA .nc file.
         output_file: Output filename.
         site_meta: Dictionary containing information about the site. Required key
@@ -31,15 +30,12 @@ def basta2nc(
         date: Expected date of the measurements as YYYY-MM-DD.
 
     Returns:
-    -------
         UUID of the generated file.
 
     Raises:
-    ------
         ValueError: Timestamps do not match the expected date.
 
     Examples:
-    --------
           >>> from cloudnetpy.instruments import basta2nc
           >>> site_meta = {'name': 'Palaiseau', 'latitude': 48.718, 'longitude': 2.207}
           >>> basta2nc('basta_file.nc', 'radar.nc', site_meta)
@@ -74,7 +70,6 @@ class Basta(NcRadar):
     """Class for BASTA raw radar data. Child of NcRadar().
 
     Args:
-    ----
         full_path: BASTA netCDF filename.
         site_meta: Site properties in a dictionary. Required key is `name`.
 

cloudnetpy/instruments/ceilo.py

@@ -40,7 +40,6 @@ def ceilo2nc(
     of weak aerosol layers and supercooled liquid clouds.
 
     Args:
-    ----
         full_path: Ceilometer file name.
         output_file: Output file name, e.g. 'ceilo.nc'.
         site_meta: Dictionary containing information about the site and instrument.
@@ -54,15 +53,12 @@ def ceilo2nc(
         date: Expected date as YYYY-MM-DD of all profiles in the file.
 
     Returns:
-    -------
         UUID of the generated file.
 
     Raises:
-    ------
         RuntimeError: Failed to read or process raw ceilometer data.
 
     Examples:
-    --------
         >>> from cloudnetpy.instruments import ceilo2nc
         >>> site_meta = {'name': 'Mace-Head', 'altitude': 5}
         >>> ceilo2nc('vaisala_raw.txt', 'vaisala.nc', site_meta)

cloudnetpy/instruments/ceilometer.py

@@ -317,14 +317,12 @@ def calc_sigma_units(
     how many steps in time and height corresponds to this smoothing.
 
     Args:
-    ----
         time_vector: 1D vector (fraction hour).
         range_los: 1D vector (m).
         sigma_minutes: Smoothing in minutes.
         sigma_metres: Smoothing in metres.
 
     Returns:
-    -------
         tuple: Two element tuple containing number of steps in time and height to
             achieve wanted smoothing.
 

cloudnetpy/instruments/copernicus.py

@@ -21,7 +21,6 @@ def copernicus2nc(
     """Converts 'Copernicus' cloud radar data into Cloudnet Level 1b netCDF file.
 
     Args:
-    ----
         raw_files: Input file name or folder containing multiple input files.
         output_file: Output filename.
         site_meta: Dictionary containing information about the site. Required key
@@ -31,15 +30,12 @@ def copernicus2nc(
         date: Expected date as YYYY-MM-DD of all profiles in the file.
 
     Returns:
-    -------
         UUID of the generated file.
 
     Raises:
-    ------
         ValidTimeStampError: No valid timestamps found.
 
     Examples:
-    --------
           >>> from cloudnetpy.instruments import copernicus2nc
           >>> site_meta = {'name': 'Chilbolton'}
           >>> copernicus2nc('raw_radar.nc', 'radar.nc', site_meta)
@@ -109,7 +105,6 @@ class Copernicus(ChilboltonRadar):
     """Class for Copernicus raw radar data. Child of ChilboltonRadar().
 
     Args:
-    ----
         full_path: Filename of a daily Copernicus .nc NetCDF file.
         site_meta: Site properties in a dictionary. Required keys are: `name`.
 
@@ -129,7 +124,6 @@ class Copernicus(ChilboltonRadar):
         """Experimental masking of corrupted Copernicus data.
 
         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

@@ -33,7 +33,6 @@ def parsivel2nc(
     file.
 
     Args:
-    ----
         disdrometer_file: Filename of disdrometer file or list of filenames.
         output_file: Output filename.
         site_meta: Dictionary containing information about the site. Required key
@@ -47,16 +46,13 @@ def parsivel2nc(
         timestamps:
 
     Returns:
-    -------
         UUID of the generated file.
 
     Raises:
-    ------
         DisdrometerDataError: Timestamps do not match the expected date, or unable
             to read the disdrometer file.
 
     Examples:
-    --------
         >>> from cloudnetpy.instruments import parsivel2nc
         >>> site_meta = {'name': 'Lindenberg', 'altitude': 104, 'latitude': 52.2,
         'longitude': 14.1}
@@ -436,7 +432,6 @@ def _read_toa5(filename: str | PathLike) -> dict[str, list]:
     """Read ASCII data from Campbell Scientific datalogger such as CR1000.
 
     References
-    ----------
         CR1000 Measurement and Control System.
         https://s.campbellsci.com/documents/us/manuals/cr1000.pdf
     """

cloudnetpy/instruments/disdrometer/thies.py

@@ -15,7 +15,6 @@ def thies2nc(
     """Converts Thies-LNM disdrometer data into Cloudnet Level 1b netCDF file.
 
     Args:
-    ----
         disdrometer_file: Filename of disdrometer .log file.
         output_file: Output filename.
         site_meta: Dictionary containing information about the site. Required key
@@ -24,16 +23,13 @@ def thies2nc(
         date: Expected date of the measurements as YYYY-MM-DD.
 
     Returns:
-    -------
         UUID of the generated file.
 
     Raises:
-    ------
         DisdrometerDataError: Timestamps do not match the expected date, or unable
             to read the disdrometer file.
 
     Examples:
-    --------
         >>> from cloudnetpy.instruments import thies2nc
         >>> site_meta = {'name': 'Lindenberg', 'altitude': 104, 'latitude': 52.2,
         'longitude': 14.1}

cloudnetpy/instruments/galileo.py

@@ -20,7 +20,6 @@ def galileo2nc(
     """Converts 'Galileo' cloud radar data into Cloudnet Level 1b netCDF file.
 
     Args:
-    ----
         raw_files: Input file name or folder containing multiple input files.
         output_file: Output filename.
         site_meta: Dictionary containing information about the site. Required key
@@ -30,15 +29,12 @@ def galileo2nc(
         date: Expected date as YYYY-MM-DD of all profiles in the file.
 
     Returns:
-    -------
         UUID of the generated file.
 
     Raises:
-    ------
         ValidTimeStampError: No valid timestamps found.
 
     Examples:
-    --------
           >>> from cloudnetpy.instruments import galileo2nc
           >>> site_meta = {'name': 'Chilbolton'}
           >>> galileo2nc('raw_radar.nc', 'radar.nc', site_meta)
@@ -105,7 +101,6 @@ class Galileo(ChilboltonRadar):
     """Class for Galileo raw radar data. Child of ChilboltonRadar().
 
     Args:
-    ----
         full_path: Filename of a daily Galileo .nc NetCDF file.
         site_meta: Site properties in a dictionary. Required keys are: `name`.
 

cloudnetpy/instruments/hatpro.py

@@ -34,7 +34,6 @@ def hatpro2l1c(
     """Converts RPG HATPRO microwave radiometer data into Cloudnet Level 1c netCDF file.
 
     Args:
-    ----
         mwr_dir: Folder containing one day of HATPRO files.
         output_file: Output file name.
         site_meta: Dictionary containing information about the site and instrument
@@ -42,7 +41,6 @@ def hatpro2l1c(
         date: Expected date in the input files.
 
     Returns:
-    -------
         UUID of the generated file.
     """
     coeff_files = site_meta.get("coefficientFiles", None)
@@ -123,7 +121,6 @@ def hatpro2nc(
     concatenates the data and writes it into netCDF file.
 
     Args:
-    ----
         path_to_files: Folder containing one day of RPG HATPRO files.
         output_file: Output file name.
         site_meta: Dictionary containing information about the site with keys:
@@ -140,18 +137,15 @@ def hatpro2nc(
             only files that match the date will be used.
 
     Returns:
-    -------
         2-element tuple containing
 
         - UUID of the generated file.
         - Files used in the processing.
 
     Raises:
-    ------
         ValidTimeStampError: No valid timestamps found.
 
     Examples:
-    --------
         >>> from cloudnetpy.instruments import hatpro2nc
         >>> site_meta = {'name': 'Hyytiala', 'altitude': 174}
         >>> hatpro2nc('/path/to/files/', 'hatpro.nc', site_meta)

cloudnetpy/instruments/mira.py

@@ -27,7 +27,6 @@ def mira2nc(
     steps.
 
     Args:
-    ----
         raw_mira: Filename of a daily MIRA .mmclx or .zncfile. Can be also a folder
             containing several non-concatenated .mmclx or .znc files from one day
             or list of files. znc files take precedence because they are the newer
@@ -39,18 +38,15 @@ def mira2nc(
         date: Expected date as YYYY-MM-DD of all profiles in the file.
 
     Returns:
-    -------
         UUID of the generated file.
 
     Raises:
-    ------
         ValidTimeStampError: No valid timestamps found.
         FileNotFoundError: No suitable input files found.
         ValueError: Wrong suffix in input file(s).
         TypeError: Mixed mmclx and znc files.
 
     Examples:
-    --------
           >>> from cloudnetpy.instruments import mira2nc
           >>> site_meta = {'name': 'Vehmasmaki'}
           >>> mira2nc('raw_radar.mmclx', 'radar.nc', site_meta)
@@ -89,7 +85,6 @@ class Mira(NcRadar):
     """Class for MIRA-35 raw radar data. Child of NcRadar().
 
     Args:
-    ----
         full_path: Filename of a daily MIRA .mmclx NetCDF file.
         site_meta: Site properties in a dictionary. Required keys are: `name`.
 

cloudnetpy/instruments/mrr.py

@@ -29,7 +29,6 @@ def mrr2nc(
     contains only the relevant data.
 
     Args:
-    ----
         input_file: Filename of a daily MMR-PRO .nc file, path to directory
             containing several non-concatenated .nc files from one day, or list
             of filenames.
@@ -40,15 +39,12 @@ def mrr2nc(
         date: Expected date as YYYY-MM-DD of all profiles in the file.
 
     Returns:
-    -------
         UUID of the generated file.
 
     Raises:
-    ------
         ValidTimeStampError: No valid timestamps found.
 
     Examples:
-    --------
           >>> from cloudnetpy.instruments import mira2nc
           >>> site_meta = {'name': 'LIM', 'latitude': 51.333, 'longitude': 12.389}
           >>> mrr2nc('input.nc', 'output.nc', site_meta)
@@ -124,7 +120,6 @@ class MrrPro(NcRadar):
     """Class for MRR-PRO raw data. Child of NcRadar().
 
     Args:
-    ----
         full_path: MRR-PRO netCDF filename.
         site_meta: Site properties in a dictionary. Required keys are `name`,
             `latitude`, `longitude` and `altitude`.

cloudnetpy/instruments/nc_radar.py

@@ -20,12 +20,10 @@ class NcRadar(DataSource, CloudnetInstrument):
     """Class for radars providing netCDF files. Child of DataSource().
 
     Args:
-    ----
         full_path: Filename of a radar-produced netCDF file.
         site_meta: Some metadata of the site.
 
     Notes:
-    -----
         Used with BASTA, MIRA and Copernicus radars.
     """
 

cloudnetpy/instruments/pollyxt.py

@@ -25,7 +25,6 @@ def pollyxt2nc(
     """Converts PollyXT Raman lidar data into Cloudnet Level 1b netCDF file.
 
     Args:
-    ----
         input_folder: Path to pollyxt netCDF files.
         output_file: Output filename.
         site_meta: Dictionary containing information about the site with keys:
@@ -40,11 +39,9 @@ def pollyxt2nc(
         date: Expected date of the measurements as YYYY-MM-DD.
 
     Returns:
-    -------
         UUID of the generated file.
 
     Examples:
-    --------
         >>> from cloudnetpy.instruments import pollyxt2nc
         >>> site_meta = {'name': 'Mindelo', 'altitude': 13, 'zenith_angle': 6,
         'snr_limit': 3}

cloudnetpy/instruments/radiometrics.py

@@ -24,7 +24,6 @@ def radiometrics2nc(
     """Converts Radiometrics .csv file into Cloudnet Level 1b netCDF file.
 
     Args:
-    ----
         full_path: Input file name or folder containing multiple input files.
         output_file: Output file name, e.g. 'radiometrics.nc'.
         site_meta: Dictionary containing information about the site and instrument.
@@ -34,11 +33,9 @@ def radiometrics2nc(
         date: Expected date as YYYY-MM-DD of all profiles in the file.
 
     Returns:
-    -------
         UUID of the generated file.
 
     Examples:
-    --------
         >>> from cloudnetpy.instruments import radiometrics2nc
         >>> site_meta = {'name': 'Soverato', 'altitude': 21}
         >>> radiometrics2nc('radiometrics.csv', 'radiometrics.nc', site_meta)
@@ -84,7 +81,6 @@ class Radiometrics:
     """Reader for level 2 files of Radiometrics microwave radiometers.
 
     References
-    ----------
         Radiometrics (2008). Profiler Operator's Manual: MP-3000A, MP-2500A,
         MP-1500A, MP-183A.
     """

cloudnetpy/instruments/rpg.py

@@ -35,7 +35,6 @@ def rpg2nc(
     concatenates the data and writes a netCDF file.
 
     Args:
-    ----
         path_to_l1_files: Folder containing one day of RPG LV1 files.
         output_file: Output file name.
         site_meta: Dictionary containing information about the
@@ -48,18 +47,15 @@ def rpg2nc(
             only files that match the date will be used.
 
     Returns:
-    -------
         2-element tuple containing
 
         - UUID of the generated file.
         - Files used in the processing.
 
     Raises:
-    ------
         ValidTimeStampError: No valid timestamps found.
 
     Examples:
-    --------
         >>> from cloudnetpy.instruments import rpg2nc
         >>> site_meta = {'name': 'Hyytiala', 'altitude': 174}
         >>> rpg2nc('/path/to/files/', 'test.nc', site_meta)
@@ -116,7 +112,6 @@ def _stack_rpg_data(rpg_objects: RpgObjects) -> tuple[dict, dict]:
     """Combines data from hourly RPG objects.
 
     Notes
-    -----
         Ignores variable names starting with an underscore.
 
     """

cloudnetpy/instruments/rpg_reader.py

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

cloudnetpy/instruments/vaisala.py

@@ -301,7 +301,6 @@ class Ct25k(VaisalaCeilo):
     """Class for Vaisala CT25k ceilometer.
 
     References
-    ----------
         https://www.manualslib.com/manual/1414094/Vaisala-Ct25k.html
 
     """
@@ -364,12 +363,10 @@ def split_string(string: str, indices: list) -> list:
     """Splits string between indices.
 
     Notes
-    -----
         It is possible to skip characters from the beginning and end of the
         string but not from the middle.
 
     Examples
-    --------
         >>> s = 'abcde'
         >>> indices = [1, 2, 4]
         >>> split_string(s, indices)
@@ -383,7 +380,6 @@ def values_to_dict(keys: tuple, values: list) -> dict:
     """Converts list elements to dictionary.
 
     Examples
-    --------
         >>> keys = ('a', 'b')
         >>> values = [[1, 2], [1, 2], [1, 2], [1, 2]]
         >>> values_to_dict(keys, values)

cloudnetpy/instruments/weather_station.py

@@ -22,7 +22,6 @@ def ws2nc(
     """Converts weather-station data into Cloudnet Level 1b netCDF file.
 
     Args:
-    ----
         weather_station_file: Filename of weather-station ASCII file.
         output_file: Output filename.
         site_meta: Dictionary containing information about the site. Required key
@@ -31,11 +30,9 @@ def ws2nc(
         date: Expected date of the measurements as YYYY-MM-DD.
 
     Returns:
-    -------
         UUID of the generated file.
 
     Raises:
-    ------
         WeatherStationDataError : Unable to read the file.
         ValidTimeStampError: No valid timestamps found.
     """

cloudnetpy/model_evaluation/file_handler.py

@@ -20,7 +20,6 @@ def update_attributes(model_downsample_variables: dict, attributes: dict) -> Non
         New attributes are added.
 
     Args:
-    ----
         model_downsample_variables (dict): Array instances.
         attributes (dict): Product-specific attributes.
     """
@@ -71,7 +70,6 @@ def save_downsampled_file(
     """Saves a standard downsampled day product file.
 
     Args:
-    ----
         id_mark (str): File identifier, format "(product name)_(model name)"
         file_name (str): Name of the output file to be generated
         objects (tuple): Include two objects: The :class:'ModelManager' and
@@ -165,12 +163,10 @@ def add_time_attribute(date: datetime) -> dict:
     """ "Adds time attribute with correct units.
 
     Args:
-    ----
         attributes: Attributes of variables.
         date: Date as Y M D 0 0 0.
 
     Returns:
-    -------
         dict: Same attributes with 'time' attribute added.
     """
     return {