ochanticipy.datasources.iri package

Submodules

ochanticipy.datasources.iri.iri_seasonal_forecast module

Class to download and load IRI’s seasonal forecast.

class ochanticipy.datasources.iri.iri_seasonal_forecast.IriForecastDominant(country_config: CountryConfig, geo_bounding_box: GeoBoundingBox)[source]

Bases: _IriForecast

Class to retrieve IRI’s forecast dominant tercile data.

The retrieved data contains the dominant probability. Automatically all seasons and leadtimes are downloaded.

Parameters:

  • country_config (CountryConfig) – Country configuration

  • geo_bounding_box (GeoBoundingBox) – the bounding coordinates of the area that should be included in the data.

Examples

>>> from ochanticipy import create_country_config,     ...     GeoBoundingBox, IriForecastDominant
>>> country_config = create_country_config(iso3="bfa")
>>> geo_bounding_box = GeoBoundingBox(lat_max=13.0,
...                                   lat_min=12.0,
...                                   lon_max=-3.0,
...                                   lon_min=-2.0)
>>>
>>> # Initialize class and retrieve data
>>> iri = IriForecastDominant(country_config,geo_bounding_box)
>>> iri.download() # Must have IRI_AUTH environment variable set
>>> iri.process()
>>>
>>> iri_data = iri.load()
class ochanticipy.datasources.iri.iri_seasonal_forecast.IriForecastProb(country_config, geo_bounding_box: GeoBoundingBox)[source]

Bases: _IriForecast

Class to retrieve IRI’s forecast data per tercile.

The retrieved data contains the probability per tercile for the given bounding box. Automatically all seasons and leadtimes are downloaded.

Parameters:

  • country_config (CountryConfig) – Country configuration

  • geo_bounding_box (GeoBoundingBox) – the bounding coordinates of the area that should be included in the data.

Examples

>>> from ochanticipy import create_country_config,     ...     GeoBoundingBox, IriForecastProb
>>> country_config = create_country_config(iso3="bfa")
>>> geo_bounding_box = GeoBoundingBox(lat_max=13.0,
...                                   lat_min=12.0,
...                                   lon_max=-3.0,
...                                   lon_min=-2.0)
>>>
>>> # Initialize class and retrieve data
>>> iri = IriForecastProb(country_config,geo_bounding_box)
>>> iri.download() # Must have IRI_AUTH environment variable set
>>> iri.process()
>>>
>>> iri_data = iri.load()

Module contents

Methods pertaining to forecasts produced by IRI.