pytuflow.BCTablesCheck.time_series

pytuflow.BCTablesCheck.time_series#

BCTablesCheck.time_series(locations, data_types, *args, **kwargs)#

Returns time-series data for the given locations and data types.

Because boundary data is not guaranteed to share a common index, the return DataFrame will contain columns for both the indexes and values for the requested time-series data.

Parameters:

  • locations (str | list[str]) – The locations to extract the time series data for.

  • data_types (str | list[str]) – The data types to extract the time series data for. Can use either data type (e.g. flow) or boundary type (e.g. QT)

Returns:

Data frame with the time series data.

Return type:

pd.DataFrame

Examples

Get the time-series for boundary FC01:

>>> bndry.time_series('FC01', None)
    FC01/time  FC01/QT
0       0.000     0.00
1       0.083     0.84
2       0.167     3.31
3       0.250     4.60
4       0.333     7.03
...       ...      ...
36      3.000     2.18
37      3.083     1.96
38      3.167     1.77
39      3.250     1.60
40      3.333     1.45
Contents