Skip to content

Commit

Permalink
Tweak docs (#4)
Browse files Browse the repository at this point in the history
* Explain use case

* Mention two usecases

* Update example
  • Loading branch information
willirath authored Feb 6, 2021
1 parent a3d0ebb commit d9eec2b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# Intake Zenodo Fetcher
# Intake Zenodo Fetcher: _Fetch data from Zenodo based on Intake catalog entries_

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ESM-VFC/intake_zenodo_fetcher/main?filepath=examples/fetch_based_on_zenodo_doi.ipynb)

Fetch data from Zenodo based on Intake catalog entries
## Why?

See [examples/fetch_based_on_zenodo_doi.ipynb](https://nbviewer.jupyter.org/github/ESM-VFC/intake_zenodo_fetcher/blob/main/examples/fetch_based_on_zenodo_doi.ipynb) for a demo on pre-fetching the data based on a Zenodo DOI.
To improve reproducibility of workflows that use data archived on Zenodo, `intake_zenodo_fetcher` simplifies downloading a local copy of the data belonging to a Zenodo DOI.
It offers functions to fetch _all_ data baloginging to a Zenodo DOI and it allows for restricting the download to just those parts of the Zenodo record that belong to a catalog entry in an Intake catalog.

See [examples/fetch_based_on_zenodo_doi.ipynb](https://nbviewer.jupyter.org/github/ESM-VFC/intake_zenodo_fetcher/blob/main/examples/fetch_based_on_zenodo_doi.ipynb) for a demo on pre-fetching the data based on a Zenodo DOI or [try it live on `mybinder.org`](https://mybinder.org/v2/gh/ESM-VFC/intake_zenodo_fetcher/main?filepath=examples/fetch_based_on_zenodo_doi.ipynb).

## Installation

Expand Down
Loading

0 comments on commit d9eec2b

Please sign in to comment.