easy_vic_build.build_Param

Build VIC parameter datasets and scale level-0 parameters to level-1.

Public functions

buildParam_level0: Build and update level-0 parameter dataset through interface methods.
buildParam_level1: Build and update level-1 parameter dataset through interface methods.
scaling_level0_to_level1_search_grids: Create level-0 to level-1 grid mapping.
scaling_level0_to_level1: Resample level-0 parameters onto level-1 grids.

Functions

`buildParam_level0`(evb_dir, g_params, ...[, ...])	Build level-0 parameter dataset using the configured interface class.
`buildParam_level1`(evb_dir, dpc_VIC_level1[, ...])	Build level-1 parameter dataset using the configured interface class.
`scaling_level0_to_level1`(...[, ...])	Scaling level-0 parameters onto level-1 grid cells.
`scaling_level0_to_level1_search_grids`(...)	Build level-0 to level-1 grid mapping by rectangular neighborhood search.

easy_vic_build.build_Param.buildParam_level0(evb_dir, g_params, soillayerresampler, dpc_VIC_level0, TF_VIC_class=<class 'easy_vic_build.tools.params_func.TransferFunction.TF_VIC'>, buildParam_level0_interface_class=<class 'easy_vic_build.tools.params_func.build_Param_interface.buildParam_level0_interface'>, reverse_lat=True, stand_grids_lat_level0=None, stand_grids_lon_level0=None, rows_index_level0=None, cols_index_level0=None, basin_hierarchy=None)[source]

Build level-0 parameter dataset using the configured interface class.

Parameters:

evb_dir (Evb_dir) – Case directory manager.
g_params (dict) – Parameter vector/group used by transfer functions at level-0.
soillayerresampler (object) – Soil-layer resampler used by the level-0 interface.
dpc_VIC_level0 (object) – DPC instance for level-0 processing.
TF_VIC_class (type, optional) – Transfer-function class used by the interface.
buildParam_level0_interface_class (type, optional) – Interface class implementing buildParam_level0_basic and buildParam_level0_by_g_tf.
reverse_lat (bool, optional) – Whether latitude axis is arranged north-to-south.
stand_grids_lat_level0 (optional) – Precomputed grid metadata to reuse for faster repeated runs.
stand_grids_lon_level0 (optional) – Precomputed grid metadata to reuse for faster repeated runs.
rows_index_level0 (optional) – Precomputed grid metadata to reuse for faster repeated runs.
cols_index_level0 (optional) – Precomputed grid metadata to reuse for faster repeated runs.
basin_hierarchy (optional) – Optional basin hierarchy information passed to interface constructor.

Returns:

The created level-0 interface instance.

Return type:

object

easy_vic_build.build_Param.buildParam_level1(evb_dir, dpc_VIC_level1, TF_VIC_class=<class 'easy_vic_build.tools.params_func.TransferFunction.TF_VIC'>, buildParam_level1_interface_class=<class 'easy_vic_build.tools.params_func.build_Param_interface.buildParam_level1_interface'>, reverse_lat=True, domain_dataset=None, stand_grids_lat_level1=None, stand_grids_lon_level1=None, rows_index_level1=None, cols_index_level1=None)[source]

Build level-1 parameter dataset using the configured interface class.

Parameters:

evb_dir (Evb_dir) – Case directory manager.
dpc_VIC_level1 (object) – DPC instance for level-1 processing.
TF_VIC_class (type, optional) – Transfer-function class used by the interface.
buildParam_level1_interface_class (type, optional) – Interface class implementing buildParam_level1_basic and buildParam_level1_by_tf.
reverse_lat (bool, optional) – Whether latitude axis is arranged north-to-south.
domain_dataset (netCDF4.Dataset, optional) – Domain dataset used by level-1 interface.
stand_grids_lat_level1 (optional) – Precomputed grid metadata to reuse for faster repeated runs.
stand_grids_lon_level1 (optional) – Precomputed grid metadata to reuse for faster repeated runs.
rows_index_level1 (optional) – Precomputed grid metadata to reuse for faster repeated runs.
cols_index_level1 (optional) – Precomputed grid metadata to reuse for faster repeated runs.

Returns:

The created level-1 interface instance.

Return type:

object

easy_vic_build.build_Param.scaling_level0_to_level1_search_grids(params_dataset_level0, params_dataset_level1)[source]

Build level-0 to level-1 grid mapping by rectangular neighborhood search.

Parameters:

params_dataset_level0 (netCDF4.Dataset) – Source level-0 parameter dataset.
params_dataset_level1 (netCDF4.Dataset) – Target level-1 parameter dataset.

Returns:

(searched_grids_index, searched_grids_bool_index).

Return type:

tuple

easy_vic_build.build_Param.scaling_level0_to_level1(params_dataset_level0, params_dataset_level1, searched_grids_bool_index=None, nlayer_list=[1, 2, 3], elev_scaling=None)[source]

Scaling level-0 parameters onto level-1 grid cells.

Parameters:

params_dataset_level0 (netCDF4.Dataset) – Source level-0 dataset.
params_dataset_level1 (netCDF4.Dataset) – Target level-1 dataset to be updated in place.
searched_grids_bool_index (array-like, optional) – Precomputed level-0 search masks for each level-1 cell.
nlayer_list (list, optional) – Soil-layer indices used for 3D variables.
elev_scaling (str, optional) – If set to "Arithmetic_min", elevation uses min aggregation; otherwise arithmetic mean is used.

Returns:

(params_dataset_level1, searched_grids_bool_index).

Return type:

tuple