Time History Tools¶
-
timehistory.plot_time_history.
getHistorySeries
(database, variable, setname, indices=None, components=None)¶ Retrieve a series of time history structures suitable for plotting in addition to the specific set index and component for the time series
Parameters: - database (hdf5_wrapper.hdf5_wrapper) – database to retrieve time history data from
- variable (str) – the name of the time history variable for which to retrieve time-series data
- setname (str) – the name of the index set as specified in the geosx input xml for which to query time-series data
- indices (int, list) – the indices in the named set to query for, if None, defaults to all
- components (int, list) – the components in the flattened data types to retrieve, defaults to all
Returns: list of (time, data, idx, comp) timeseries tuples for each time history data component
Return type: list