Downloader

class climate_resilience.downloader.SitesDownloader(folder: str, site_json_file_path: str, latitudes: Optional[Union[Tuple[float], List[float]]] = None, longitudes: Optional[Union[Tuple[float], List[float]]] = None, latitude_range: Optional[Union[Tuple[float], List[float]]] = None, longitude_range: Optional[Union[Tuple[float], List[float]]] = None)

Bases: object

download_historical_daily(start_date: datetime.datetime, end_date: datetime.datetime, variable: str, scenario: str, model: str, geom: ee.geometry.Geometry.Point, name: str, state: str) → ee.batch.Task

Download daily data.

Parameters

  • start_date (datetime) – Starting date of the dataset to download. Format: YYYY-MM-DD

  • end_date (datetime) – Ending date of the dataset to download. Format: YYYY-MM-DD

  • variable (str) – Variable of interest.

  • scenario (str) – Scenario of interest.

  • model (str) – Model of interest.

  • geom (ee.Geometry.Point) – Site location in latitude and longitude.

  • name (str) – Name Mnemonic of the site.

  • state (str) – Site location state code.

Returns

Returns the google earth engine task that performs the download process.

Not necessaily useful for basic download commands.

Return type

ee.batch.Task

download_historical_monthly(start_date: datetime.datetime, end_date: datetime.datetime, variable: str, scenario: str, model: str, geom: ee.geometry.Geometry.Point, name: str, state: str) → ee.batch.Task

Download monthly data.

Parameters

  • start_date (datetime) – Starting date of the dataset to download. Format: YYYY-MM-DD

  • end_date (datetime) – Ending date of the dataset to download. Format: YYYY-MM-DD

  • variable (str) – Variable of interest.

  • scenario (str) – Scenario of interest.

  • model (str) – Model of interest.

  • geom (ee.Geometry.Point) – Site location in latitude and longitude.

  • name (str) – Name Mnemonic of the site.

  • state (str) – Site location state code.

Returns

Returns the google earth engine task that performs the download process.

Not necessaily useful for basic download commands.

Return type

ee.batch.Task

download_model_average_daily(start_date: datetime.datetime, end_date: datetime.datetime, variable: str, scenario: str, geom: ee.geometry.Geometry.Point, name: str, state: str) → ee.batch.Task

Download average daily data.

Parameters

  • start_date (datetime) – Starting date of the dataset to download. Format: YYYY-MM-DD

  • end_date (datetime) – Ending date of the dataset to download. Format: YYYY-MM-DD

  • variable (str) – Variable of interest.

  • scenario (str) – Scenario of interest.

  • geom (ee.Geometry.Point) – Site location in latitude and longitude.

  • name (str) – Name Mnemonic of the site.

  • state (str) – Site location state code.

Returns

Returns the google earth engine task that performs the download process.

Not necessaily useful for basic download commands.

Return type

ee.batch.Task

download_samples(params_yaml_file: str, mode: str) → None

Download all the data samples from the Google Earth Engine based on YAML file download configuration parameters.

Parameters

  • params_yaml_files (str) – Path to the YAML file containing all the download configuration parameters.

  • mode (str) – Type of dataset to download from Google Earth Engine.