TimeSeries#

class TimeSeries(series, name=None, settings=None, metadata=None)[source]#

Class that deals with all user-provided time series.

Parameters

  • series (pandas.Series) – pandas.Series with pandas.DatetimeIndex.

  • name (str, optional) – String with the name of the time series, if None is provided, pastas will try to derive the name from the series.

  • settings (str or dict, optional) – String with the name of one of the predefined settings (obtained through ps.TimeSeries._predefined_settings.) or a dictionary with the settings to be applied. This does not have to include all the settings arguments.

  • metadata (dict, optional) – Dictionary with metadata of the time series.

Returns

series – Returns a pastas.TimeSeries object.

Return type

pastas.TimeSeries

Examples

To obtain the predefined TimeSeries settings, you can run the following line of code:

>>> ps.rcParams["timeseries"]

See also

pastas.timeseries.TimeSeries.update_series

For the individual options for the different settings.

Attributes#

series

series_original

Methods#

__init__

to_dict

Method to export the Time Series to a json format.

update_series

Method to update the series with new options.