ILAMB.ModelResult.ModelResult.extractTimeSeries¶
- ModelResult.extractTimeSeries(variable, lats=None, lons=None, alt_vars=[], initial_time=- 1e+20, final_time=1e+20, output_unit='', expression=None, convert_calendar=True)[source]¶
Extracts a time series of the given variable from the model.
- Parameters
variable (str) – name of the variable to extract
alt_vars (list of str, optional) – alternate variables to search for if variable is not found
initial_time (float, optional) – include model results occurring after this time
final_time (float, optional) – include model results occurring before this time
output_unit (str, optional) – if specified, will try to convert the units of the variable extract to these units given.
lats (numpy.ndarray, optional) – a 1D array of latitude locations at which to extract information
lons (numpy.ndarray, optional) – a 1D array of longitude locations at which to extract information
expression (str, optional) – an algebraic expression describing how to combine model outputs
- Returns
var – the extracted variable
- Return type