fetch3.nhl_transpiration.main.main#

main(cfg: ConfigParams, output_dir, data_dir, to_model_res=True, write_output=False)#

Calculate NHL transpiration.

Parameters:

  • cfg (FETCH3 config object) – Model configuration

  • output_dir (pathlib.Path) – Directory to write output files to. If output_dir is None, NHL output is not written.

  • data_dir (pathlib.Path) – Directory containing input data

  • to_model_res (bool, optional) – Whether or not to calculate and return NHL in the resolution needed to run in FETCH, by default True.

Returns:

  • NHL transpiration (xarray.DataArray) – NHL transpiration. If to_model_res is True, NHL is returned in the resolution needed to run in FETCH, with units of [m3 H2O m-2crown m-1stem s-1]. If to_model_res is False, NHL is returned as tree-level transpiration, with units of [kg H2O s-1].

  • LAD (array) – LAD profile

  • DS (xarray.Dataset)