metobs_toolkit.Modeldata.add_gee_dataset#

Modeldata.add_gee_dataset(mapname, gee_location, obstype, bandname, units, scale, band_desc=None, time_res='1h', is_image=False, is_numeric=True, credentials='')[source]#

Add a new gee dataset to the available gee datasets.

Parameters:

  • mapname (str) – Mapname of choice for the GEE dataset to add.

  • gee_location (str) – Location of the gee dataset (like “ECMWF/ERA5_LAND/HOURLY” for ERA5).

  • obstype (str) – The observation type name the band corresponds to.

  • bandname (str) – Name of the dataset band as stored on the GEE.

  • units (str) – The units of the band.

  • scale (int) – The scale to represent the dataset in. (This is a GEE concept that is similar to the resolution in meters).

  • band_desc (str or None, optional) – Add a descrition to of the band. The default is None.

  • time_res (timedelta string, optional) – Time reoslution of the dataset, if is_image == False. The default is ‘1H’.

  • is_image (bool, optional) – If True, the dataset is a ee.Image, else it is assumed to be an ee.ImageCollection. The default is False.

  • is_numeric (bool, optional) – If True, the bandvalues are interpreted as numerical values rather than categorical.. The default is True.

  • credentials (str, optional) – Extra credentials of the dataset. The default is ‘’.

Return type:

None.

Note

To list all available gee dataset, use the .list_gee_dataset() method.

Note

Currently no unit conversion is perfomed automatically other than K –> Celsius. This will be implemented in the futur.

On this page
Show Source