mlspm.datasets

mlspm.datasets.download_dataset(name: str, target_dir: PathLike)

Download and unpack a dataset to a target directory.

The following datasets are available:

• 'AFM-ice-Cu111': https://doi.org/10.5281/zenodo.10047850

• 'AFM-ice-Au111-monolayer': https://doi.org/10.5281/zenodo.10049832

• 'AFM-ice-Au111-bilayer': https://doi.org/10.5281/zenodo.10049856

• 'AFM-ice-exp': https://doi.org/10.5281/zenodo.10054847

• 'AFM-ice-relaxed': https://doi.org/10.5281/zenodo.10362511

• 'ASD-AFM-molecules': https://doi.org/10.5281/zenodo.10562769 - ‘molecules.tar.gz’

• 'AFM-camphor-exp': https://doi.org/10.5281/zenodo.10562769 - ‘afm_camphor.tar.gz’

• 'ED-AFM-molecules': https://doi.org/10.5281/zenodo.10609676 - ‘molecules_rebias.tar.gz’

• 'ED-AFM-data': https://doi.org/10.5281/zenodo.10609676 - ‘edafm-data.tar.gz’

Parameters:

• name – Name of the dataset to download.

• target_dir – Directory where the dataset will be unpacked into. The directory and its parents will be created if they do not exist already. If the directory already exists and is not empty, then the operation is aborted.