glacier_lengths.examples module

Example data auxiliary functions.

glacier_lengths.examples.download_examples(overwrite: bool = False) → str

Download examples from the GitHub repo to a temporary directory.

Parameters

overwrite – Overwrite the files even though they exist?

Raises

ValueError – If the data could not be fetched from the GitHub repo.

Returns

A filepath to the temporary directory.

glacier_lengths.examples.get_example(name: str)

Retrieve the path to an example file.

Files will be downloaded from GitHub if they cannot be found.

Returns

An absolute filepath to the given example.