pywatershed.base.Budget

class pywatershed.base.Budget(control, inputs, outputs, storage_changes, exchanges=None, init_accumulations=None, accum_start_time=None, units=None, time_unit='D', description=None, rtol=1e-05, atol=1e-05, basis='unit', imbalance_fatal=False, ignore_nans=False, unit_desc='', verbose=True)

Budget class for mass and energy conservation.

Currently no energy budget has been implmenented, todo.

__init__(control, inputs, outputs, storage_changes, exchanges=None, init_accumulations=None, accum_start_time=None, units=None, time_unit='D', description=None, rtol=1e-05, atol=1e-05, basis='unit', imbalance_fatal=False, ignore_nans=False, unit_desc='', verbose=True)

Methods

__init__(control, inputs, outputs, ...[, ...])
advance()	Advance time (taken from storageUnit)
calculate()	Accumulate for the timestep.
from_storage_unit(storage_unit[, quantity])
get_components([has_exchanges])
get_meta_keys()	Return a tuple of the metadata keys used by Budget.
init_component(data)	rtype: dict
initialize_netcdf(params, output_dir[, ...])	Initialize NetCDF output
output()	Output to previously initialized output types.
reset_accumulations()
set(data)	Set the data on the components after initialization :type data: dict :param data: a dict of dicts with top level optional keys: :param [inputs: :param outputs: :param storage_changes].: :param Each of those is a dict with var: np.ndarray, eg.
set_initial_accumulations(...)

Attributes

accumulations
balance
components
exchanges_sum
inputs_sum
outputs_sum
storage_changes_sum
terms

property accumulations

advance()

Advance time (taken from storageUnit)

property balance

calculate()

Accumulate for the timestep.

property components

property exchanges_sum

classmethod from_storage_unit(storage_unit, quantity='mass', **kwargs)

static get_components(has_exchanges=False)

static get_meta_keys()

Return a tuple of the metadata keys used by Budget.

static init_component(data)

Return type:

dict

initialize_netcdf(params, output_dir, extra_coords=None, write_sum_vars=True, write_individual_vars=False)

Initialize NetCDF output

Parameters:

output_dir (str) – directory for NetCDF file

Return type:

None

Returns:

None

property inputs_sum

output()

Output to previously initialized output types.

Return type:

None

Returns:

None

property outputs_sum

reset_accumulations()

set(data)

Set the data on the components after initialization :type data: dict :param data: a dict of dicts with top level optional keys: :param [inputs: :param outputs: :param storage_changes].: :param Each of those is a dict with var: np.ndarray, eg. :param data = {‘inputs’: {‘var’: np.ndarray}}

set_initial_accumulations(init_accumulations, accum_start_time)

property storage_changes_sum

property terms