FoundryDatasets¶

class mastml.datasets.FoundryDatasets(no_local_server, anonymous, test)[source]¶

Bases: object

Class to download datasets hosted on Materials Data Facility

Args:

no_local_server: (bool), whether or not the server is local. Set to True if running on e.g. Google Colab

anonymous: (bool), whether to use your MDF user or be anonymous. Some functionality may be disabled if True

test: (bool), whether to be in test mode. Some functionality may be disabled if True

Methods:

download_data: downloads specified data from MDF and saves to current directory

Args:

name: (str), name of the dataset to download

doi: (str), digital object identifier of the dataset to download

download: (bool), whether or not to download the full dataset

Returns:

None

Methods Summary

download_data([name, doi, download])

Methods Documentation