hermes_client.ForecastSeriesClient

class hermes_client.ForecastSeriesClient(url: str, forecastseries: UUID | str, project: UUID | str | None = None, timeout: int | None = None)

Client for the HERMES API to interact with ForecastSeries.

Either the ForecastSeries UUID must be provided, or both the ForecastSeries name and the Project UUID or name.

Parameters:

• url – Base URL of the HERMES API.

• forecastseries – UUID or name of the ForecastSeries.

• project – UUID or name of the Project.

• timeout – Timeout for API requests in seconds.

Attributes

forecasts	Finished or still running Forecasts.
injectionplans	The InjectionPlans used for Forecasts.
metadata	General metadata of the ForecastSeries.
modelconfigs	The ModelConfigs used for Forecasts.
modelsettings	Model settings which are passed to all models.

Methods

get_forecast_by_time

Get a forecast by its starttime.