From 4055b76c0dd77726a2aa63b226896a4cb4915465 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Fri, 23 Jun 2023 11:36:38 -0600 Subject: [PATCH] doi infrastructure changes (#32) --- CITATION.cff | 12 ++++++++++++ README.md | 1 + _config.yml | 15 --------------- _gallery_info.yml | 11 +++++++++++ _toc.yml | 3 +++ notebooks/how-to-cite.md | 7 +++++++ 6 files changed, 34 insertions(+), 15 deletions(-) create mode 100644 CITATION.cff create mode 100644 _gallery_info.yml create mode 100644 notebooks/how-to-cite.md diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..9181572 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,12 @@ +cff-version: 1.2.0 +message: "If you use this cookbook, please cite it as below." +authors: + # add additional entries for each author -- see https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md + - family-names: Hagen + given-names: Norland Raphael + website: https://github.com/norlandrhagen + orcid: https://orcid.org/0000-0003-1994-1153 + - name: "Kerchunk Cookbook contributors" # use the 'name' field to acknowledge organizations + website: "https://github.com/ProjectPythia/kerchunk-cookbook/graphs/contributors" +title: "Kerchunk Cookbook" +abstract: "A Project Pythia Cookbook for Kerchunk." diff --git a/README.md b/README.md index 6a13fae..1a7d4ae 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![nightly-build](https://github.com/ProjectPythia/kerchunk-cookbook/actions/workflows/nightly-build.yaml/badge.svg)](https://github.com/ProjectPythia/kerchunk-cookbook/actions/workflows/nightly-build.yaml) [![Binder](https://binder.projectpythia.org/badge_logo.svg)](https://binder.projectpythia.org/v2/gh/ProjectPythia/kerchunk-cookbook/main?labpath=notebooks) +[![DOI](https://zenodo.org/badge/588661659.svg)](https://zenodo.org/badge/latestdoi/588661659) This Project Pythia Cookbook covers using the [Kerchunk](https://fsspec.github.io/kerchunk/) library to access archival data formats as if they were diff --git a/_config.yml b/_config.yml index 0fb1792..9d20d2b 100644 --- a/_config.yml +++ b/_config.yml @@ -4,23 +4,8 @@ title: Kerchunk Cookbook author: Norland Raphael Hagen logo: notebooks/images/logos/pythia_logo-white-rtext.svg -email: projectpythia@ucar.edu copyright: "2022" -description: A Project Pythia Cookbook for Kerchunk -thumbnail: thumbnail.png - -tags: - domains: - - AWS Cloud - - Data Access - - HRRR model - - zarr - packages: - - kerchunk - - intake - - xarray - execute: # To execute notebooks via a binder instead, replace 'cache' with 'binder' execute_notebooks: cache diff --git a/_gallery_info.yml b/_gallery_info.yml new file mode 100644 index 0000000..f93c400 --- /dev/null +++ b/_gallery_info.yml @@ -0,0 +1,11 @@ +thumbnail: thumbnail.png +tags: + domains: + - AWS Cloud + - Data Access + - HRRR model + - zarr + packages: + - kerchunk + - intake + - xarray diff --git a/_toc.yml b/_toc.yml index 1e9ce1d..4ccef47 100644 --- a/_toc.yml +++ b/_toc.yml @@ -1,6 +1,9 @@ format: jb-book root: README parts: + - caption: Preamble + chapters: + - file: notebooks/how-to-cite - caption: Foundations chapters: - file: notebooks/foundations/kerchunk_basics diff --git a/notebooks/how-to-cite.md b/notebooks/how-to-cite.md new file mode 100644 index 0000000..6c38f6b --- /dev/null +++ b/notebooks/how-to-cite.md @@ -0,0 +1,7 @@ +# How to Cite This Cookbook + +The material in Project Pythia's Kerchunk Cookbook is licensed for free and open consumption and reuse. All code is served under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0), while all non-code content is licensed under [Creative Commons BY 4.0 (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/). Effectively, this means you are free to share and adapt this material so long as you give appropriate credit to the Cookbook authors and the Project Pythia community. + +The source code for the book is [released on GitHub](https://github.com/ProjectPythia/kerchunk-cookbook) and archived on Zenodo. This DOI will always resolve to the latest release of the book source: + +[![DOI](https://zenodo.org/badge/588661659.svg)](https://zenodo.org/badge/latestdoi/588661659)