From 18ffb43b79442b516b6bb1b191dd77142ed13695 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Fri, 23 Jun 2023 11:46:25 -0600 Subject: [PATCH] doi infrastructure changes (#106) * doi * Update CITATION.cff * Update CITATION.cff --- CITATION.cff | 30 ++++++++++++++++++++++++++++++ README.md | 1 + _config.yml | 9 --------- _gallery_info.yml | 6 ++++++ _toc.yml | 3 +++ notebooks/how-to-cite.md | 7 +++++++ 6 files changed, 47 insertions(+), 9 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..bb0f9f1 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,30 @@ +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: Grover + given-names: Maxwell + orcid: https://orcid.org/0000-0002-0370-8974 # optional + website: https://github.com/mgrover1 + affiliation: Argonne National Laboratory # optional + - family-names: Sherman + given-names: Zachary + - family-names: Sharma + given-names: Milind + website: https://github.com/gewitterblitz + orcid: https://orcid.org/0000-0003-3318-7601 + affiliation: Texas A&M University + - family-names: Ladino + given-names: Alfonso + website: https://github.com/aladinor + orcid: https://orcid.org/0000-0001-8081-7827 + affiliation: University of Illinois at Urbana Champaign + - family-names: Camron + given-names: Crystal + website: https://github.com/crystalclearwx + orcid: https://orcid.org/0009-0009-6628-6287 + affiliation: Problem Solutions, Inc./AccuWeather, Inc. + - name: "Radar Cookbook contributors" # use the 'name' field to acknowledge organizations + website: "https://github.com/ProjectPythia/radar-cookbook/graphs/contributors" +title: "Radar Cookbook" +abstract: "A cookbook meant to work with various weather radar data." diff --git a/README.md b/README.md index 9e6e00f..e2d419d 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![nightly-build](https://github.com/ProjectPythia/radar-cookbook/actions/workflows/nightly-build.yaml/badge.svg)](https://github.com/ProjectPythia/radar-cookbook/actions/workflows/nightly-build.yaml) [![Binder](https://binder.projectpythia.org/badge_logo.svg)](https://binder.projectpythia.org/v2/gh/ProjectPythia/radar-cookbook/main?labpath=notebooks) +[![DOI](https://zenodo.org/badge/479066261.svg)](https://zenodo.org/badge/latestdoi/479066261) This Project Pythia Cookbook covers the basics of working with weather radar data in Python. diff --git a/_config.yml b/_config.yml index f3b4974..639ba3d 100644 --- a/_config.yml +++ b/_config.yml @@ -4,17 +4,8 @@ title: Radar Cookbook author: Max Grover, Zachary Sherman, Milind Sharma logo: notebooks/images/logos/pythia_logo-white-rtext.svg -email: projectpythia@ucar.edu copyright: '2023' -description: A cookbook meant to work with various weather radar data. -thumbnail: thumbnail.png -tags: - domains: - - radar - packages: - - Py-Art - 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..fa6350b --- /dev/null +++ b/_gallery_info.yml @@ -0,0 +1,6 @@ +thumbnail: thumbnail.png +tags: + domains: + - radar + packages: + - Py-Art \ No newline at end of file diff --git a/_toc.yml b/_toc.yml index 88cc6bf..8178bb8 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/pyart-basics diff --git a/notebooks/how-to-cite.md b/notebooks/how-to-cite.md new file mode 100644 index 0000000..1196a7b --- /dev/null +++ b/notebooks/how-to-cite.md @@ -0,0 +1,7 @@ +# How to Cite This Cookbook + +The material in Project Pythia's Radar 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/radar-cookbook) and archived on Zenodo. This DOI will always resolve to the latest release of the book source: + +[![DOI](https://zenodo.org/badge/479066261.svg)](https://zenodo.org/badge/latestdoi/479066261) \ No newline at end of file