seismometer.api.download_example_dataset

seismometer.api.download_example_dataset(dataset_name, branch_name='main', source_repo=None)

Downloads an example dataset from the specified branch to local data/ directory.

Parameters:

• dataset_name (str) – The name of the dataset to download.

• branch_name (str, optional) – The branch from which to download the dataset. Defaults to “main”.

• source_repo (Optional[str], optional) – The GitHub repository that contains the data, by default None.

Raises:

ValueError – If the specified dataset is not available in the example datasets.