download_demo

pyeem.datasets.download_demo(data_dir, demo_name, overwrite=False)

Download a demo dataset from AWS S3. Please note that this step requires an internet connection because the data is downloaded from an AWS S3 bucket.

Parameters

• data_dir (str) – The directory in which the demo data will be downloaded.

• demo_name (str) – The name of the demo dataset you would like to download.

• overwrite (bool, optional) – Determines whether or not the demo directory will be overwritten if it already exists. Defaults to False.

Returns

The relative path to the demo directory.

Return type

str