hydromt_fiat.data.fetch_data#

hydromt_fiat.data.fetch_data(data: str, local_registry: bool = True, sub_dir: bool = True, output_dir: Path | str | None = None) → Path[source]#

Fetch data by simply calling the function.

Parameters:

  • data (str) – The data to fetch.

  • local_registry (bool, optional) – If True, the registry is taken from the current library location. Otherwise, it is taken from the remote ‘main’ branch on github, by default True.

  • sub_dir (bool) – Whether to place the fetched data in a sub directory of the same name. I.e. if the (tarred) dataset is named ‘custom-data’ a directory named ‘custom-data’ is created in which the data are placed. By default True.

  • output_dir (Path | str | None) – The output directory to store the data. If None, the data will be stored in ~/.cache/hydromt_fiat/<data>.

Returns:

The output directory where the data is stored.

Return type:

Path