pywfm.IWFMModel.get_supply_requirement_ag_subregions#
- IWFMModel.get_supply_requirement_ag_subregions(subregions='all', conversion_factor=1.0)#
Return the agricultural supply requirement for one or more model subregions
- Parameters:
subregions (int, list, tuple, np.ndarray, or str='all', default='all') – one or more subregion identification numbers used to return the ag supply requirement
conversion_factor (float, default=1.0) – factor to convert ag supply requirement from model units to desired output units
- Returns:
array of ag supply requirement for subregions specified
- Return type:
np.ndarray
Note
This method is intended to be used during a model simulation (is_for_inquiry=0)
See also
IWFMModel.get_supply_requirement_ag_elements
Return the agricultural supply requirement for one or more model elements
IWFMModel.get_supply_requirement_urban_elements
Return the urban supply requirement for one or more model elements
IWFMModel.get_supply_requirement_urban_subregions
Return the urban supply requirement for one or more model subregions