atmospy.load_dataset#

atmospy.load_dataset(name, cache=True, data_home=None, **kwargs)#

Load an example dataset from the online repository (requires internet).

This function provides quick access to a number of example datasets that can be used to either explore the plotting functionality of atmospy or to report issues without needing to upload your own data.

This function also handles some basic data pre-processing to ensure they are ready-to-go.

Parameters:
namestr

The name of the dataset. Dataset names can be found on https://github.com/dhhagan/atmospy-data or by running the get_dataset_names function.

cachebool, optional

If True, the dataset will be loaded from local cache if available and it will save to local cache if it needs to be downloaded, by default True

data_homestr, optional

The directory to store the cached data; if not set, it will be determined for your operating system using the get_data_home function, by default None

Returns:
dfpandas.DataFrame

Tabular data.