reV.handlers.multi_year.MultiYearGroup

class MultiYearGroup(name, out_dir, source_files=None, source_dir=None, source_prefix=None, source_pattern=None, dsets=('cf_mean',), pass_through_dsets=None)[source]

Bases: object

Handle group parameters

Parameters:

  • name (str) – Group name. Can be "none" for no collection groups.

  • out_dir (str) – Output directory - used for Pipeline handling.

  • source_files (str | list, optional) – Explicit list of source files. Use either this input OR source_dir + source_prefix. If this input is "PIPELINE", the source_files input is determined from the status file of the previous pipeline step. If None, use source_dir and source_prefix. By default, None.

  • source_dir (str, optional) – Directory to extract source files from (must be paired with source_prefix). By default, None.

  • source_prefix (str, optional) – File prefix to search for in source directory (must be paired with source_dir). By default, None.

  • source_pattern (str, optional) – Optional unix-style /filepath/pattern*.h5 to specify the source files. This takes priority over source_dir and source_prefix but is not used if source_files are specified explicitly. By default, None.

  • dsets (str | list | tuple, optional) – List of datasets to collect. This can be set to "PIPELINE" if running from the command line as part of a reV pipeline. In this case, all the datasets from the previous pipeline step will be collected. By default, ('cf_mean',).

  • pass_through_dsets (list | tuple, optional) – Optional list of datasets that are identical in the multi-year files (e.g. input datasets that don’t vary from year to year) that should be copied to the output multi-year file once without a year suffix or means/stdev calculation. By default, None.

Methods

Attributes

dsets

name

pass_through_dsets

Optional list of datasets that are identical in the multi-year files (e.g. input datasets that don't vary from year to year) that should be copied to the output multi-year file once without a year suffix or means/stdev calculation.

source_files

property name
Returns:

name (str) – Group name

property source_files
Returns:

source_files (list) – list of source files to collect from

property dsets
Returns:

_dsets (list | tuple) – Datasets to collect

property pass_through_dsets

Optional list of datasets that are identical in the multi-year files (e.g. input datasets that don’t vary from year to year) that should be copied to the output multi-year file once without a year suffix or means/stdev calculation

Returns:

list | tuple | None