forecastseries.ForecastClient#

class hermes_client.forecastseries.ForecastClient(url: str, forecast: dict, timeout: int | None = None)#

Client to interact with Forecasts in the HERMES API.

This object allows access to all the inputs of the Forecast, as well as the data linked to the ModelRuns of this specific Forecast.

Usually automatically created by the ForecastSeriesClient(), can however also be created directly using a Forecast UUID by using the from_oid() class method.

Parameters:

url – Base URL of the HERMES API.
forecast – The Forecast metadata as a dictionary.
timeout – Timeout for API requests in seconds.

Attributes

`injectionobservations`	InjectionObservations used in the Forecast.
`injectionplans`	Injection plans used in the Forecast.
`metadata`	Metadata of the Forecast.
`modelconfigs`	Model configs used in the Forecast.
`modelruns`	Model run data as `ModelRunClient()` objects.
`seismicityobservation`	Seismicity observations use din the Forecast.

Methods

`from_oid`	Create a `ForecastClient()` object from its oid.
`get_results`	Get the results for a model run as a Catalog or Grid object.