nsrdb.config.create_configs.CreateConfigs

class CreateConfigs

Bases: object

Collection of methods to create config files for NSRDB module inputs for standard CONUS / Full Disc runs.

Methods

aggregate(kwargs)	Get config for conus and full disc high-resolution to low-resolution aggregation.
blend(kwargs)	Get config dictionary for nsrdb.cli.blend for standard NSRDB runs.
collect_aggregate(kwargs)	Create config for aggregation collection
collect_blend(kwargs)	Collect blended files into a single output file.
full(kwargs)	Modify config files for all domains with specified parameters.
init_kwargs([kwargs, default_kwargs])	Initialize config with default kwargs.
main(kwargs)	Modify config files with specified parameters
main_all(kwargs)	Modify config files for all domains with specified parameters.
post(kwargs)	Create all post processing config files for blending / aggregation / collection.
surfrad(kwargs)	Get basic config template specified parameters replaced.

Attributes

AGG_RUN_NAME
BLEND_RUN_NAME
COLLECT_AGG_RUN_NAME
COLLECT_BLEND_RUN_NAME
MAIN_RUN_NAME
SURFRAD_RUN_NAME

classmethod init_kwargs(kwargs=None, default_kwargs=None)

Initialize config with default kwargs.

classmethod surfrad(kwargs)

Get basic config template specified parameters replaced.

classmethod main(kwargs)

Modify config files with specified parameters

Parameters:

kwargs (dict) – Dictionary of parameters including year, basename, satellite, extent, freq, spatial, meta_file, doy_range

classmethod main_all(kwargs)

Modify config files for all domains with specified parameters.

Parameters:

kwargs (dict) – Dictionary of parameters including year, basename, satellite, extent, freq, spatial, meta_file, doy_range

classmethod full(kwargs)

Modify config files for all domains with specified parameters. Write all post processing config files and post processing pipeline config file for the given year

Parameters:

kwargs (dict) – Dictionary of parameters including year, basename, satellite, extent, freq, spatial, meta_file, doy_range

classmethod post(kwargs)

Create all post processing config files for blending / aggregation / collection.

classmethod aggregate(kwargs)

Get config for conus and full disc high-resolution to low-resolution aggregation. This is then used as the input to nsrdb.cli.aggregate

Parameters:

kwargs (dict) – Dictionary with keys specifying the case for which to aggregate files

classmethod blend(kwargs)

Get config dictionary for nsrdb.cli.blend for standard NSRDB runs.

Parameters:

kwargs (dict) – Dictionary with keys specifying the case for which to blend data files

classmethod collect_blend(kwargs)

Collect blended files into a single output file.

Note

This is used to combine year < 2018 dset files into single files with all dsets. e.g. clearsky, irradiance, clouds, etc -> nsrdb_{year}.h5

Parameters:

kwargs (dict) – Dictionary with keys specifying the case for blend collection

classmethod collect_aggregate(kwargs)

Create config for aggregation collection

Note

This is used to collect single dset aggregated files into a single file with all dsets. e.g. e.g. clearsky, irradiance, clouds, etc -> nsrdb_{year}.h5

Parameters:

kwargs (dict) – Dictionary with keys specifying the case for aggregation collection