forecastseries.ForecastClient.get_results#

ForecastClient.get_results(modelconfig: str, injectionplan: str | None = None) → list[ForecastCatalog] | list[ForecastGRRateGrid] | None#

Get the results for a model run as a Catalog or Grid object.

Parameters:

  • modelconfig – The name of the ModelConfig for which to get the results.

  • injectionplan – The name of the InjectionPlan for which to get the results.

Returns:

  • The results for the model run.

  • - For result_type ‘GRID’, for each timestep a – ForecastGRRateGrid object is returned.

  • - For result_type ‘CATALOG’, for each timestep and – grid cell a ForecastCatalog object is returned.