Indicator#

class Indicator(name, getter, units=None, element=None)[source]#

Create an Indicator object that serves as an argument for Model objects.

Parameters:
  • name (str) – Name of indicator.

  • units (str) – Indicator units of measure.

  • getter (function) – Should take no arguments and return the indicator value.

  • element (str) – Element corresponding to indicator

__call__()[source]#

Call self as a function.

get()[source]#

Return value of indicator. This method used cached values.

difference()[source]#

Return the difference between the current indicator value and the last one evaluated by calling this object.

Metric#

alias of Indicator