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.

Used to access all the metadata of a ForecastSeries and the Forecasts linked to it.

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	All finished or still running Forecasts as ForecastClient() objects.
injectionplans	The InjectionPlans used for Forecasts.
metadata	Metadata of the ForecastSeries.
modelconfigs	The ModelConfigs used for Forecasts.
modelsettings	The general model settings.

Methods

get_forecast_by_time

Get a specific forecast by its starttime.