From 83e06700ddbe29f0443797ad97a8085fd5c302a1 Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Sat, 24 Jun 2023 09:14:58 -0600 Subject: [PATCH 1/2] doi --- CITATION.cff | 13 +++++++++++++ README.md | 3 +-- _config.yml | 5 ++--- _gallery_info.yml | 11 +++++++++++ _toc.yml | 9 ++++++--- notebooks/how-to-cite | 7 +++++++ 6 files changed, 40 insertions(+), 8 deletions(-) create mode 100644 CITATION.cff create mode 100644 _gallery_info.yml create mode 100644 notebooks/how-to-cite diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..3c122cf --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,13 @@ +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: Camron + given-names: Drew + orcid: https://orcid.org/0000-0001-7246-6502 + website: https://github.com/dcamron + affiliation: UCAR/Unidata + - name: "Metpy Cookbook contributors" # use the 'name' field to acknowledge organizations + website: "https://github.com/ProjectPythia/metpy-cookbook/graphs/contributors" +title: "Metpy Cookbook" +abstract: "A sample cookbook description." diff --git a/README.md b/README.md index 256ad94..a3616c3 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,13 @@ - **:warning: THIS COOKBOOK IS UNDER CONSTRUCTION :warning:** # MetPy Cookbook [![nightly-build](https://github.com/ProjectPythia/metpy-cookbook/actions/workflows/nightly-build.yaml/badge.svg)](https://github.com/ProjectPythia/metpy-cookbook/actions/workflows/nightly-build.yaml) [![Binder](http://binder.mypythia.org/badge_logo.svg)](http://binder.mypythia.org/v2/gh/ProjectPythia/metpy-cookbook/main?labpath=notebooks) +[![DOI](https://zenodo.org/badge/620944317.svg)](https://zenodo.org/badge/latestdoi/620944317) This Cookbook is the oversized recipe book for all your MetPy needs. We provide a gallery of real workflows centered around meteorological data, @@ -34,7 +34,6 @@ MetPy Maintainers and the MetPy Community. ### The MetPy Example Gallery - ## Running the Notebooks You can either run the notebook using [Binder](https://mybinder.org/) or on your local machine. diff --git a/_config.yml b/_config.yml index c0abe16..c5ea439 100644 --- a/_config.yml +++ b/_config.yml @@ -43,14 +43,13 @@ parse: sphinx: config: - html_favicon: notebooks/images/icons/favicon.ico - html_last_updated_fmt: '%-d %B %Y' + html_last_updated_fmt: "%-d %B %Y" html_theme: sphinx_pythia_theme html_permalinks_icon: '' html_theme_options: home_page_in_toc: true - repository_url: https://github.com/ProjectPythia/cookbook-template/ # Online location of your book + repository_url: https://github.com/ProjectPythia/metpy-cookbook/ # Online location of your book repository_branch: main # Which branch of the repository should be used when creating links (optional) use_issues_button: true use_repository_button: true diff --git a/_gallery_info.yml b/_gallery_info.yml new file mode 100644 index 0000000..3fcf31c --- /dev/null +++ b/_gallery_info.yml @@ -0,0 +1,11 @@ +thumbnail: metpy.png +tags: + domains: + - meteorology + - data access + packages: + - metpy + - siphon + - cartopy + - xarray + - pint diff --git a/_toc.yml b/_toc.yml index 2bcc221..e0d0415 100644 --- a/_toc.yml +++ b/_toc.yml @@ -1,13 +1,16 @@ format: jb-book root: README parts: + - caption: Preamble + chapters: + - file: notebooks/how-to-cite - caption: The MetPy Gallery chapters: - file: notebooks/notebook-template - title: What organization + title: What organization sections: - - glob: notebooks/gallery/* + - glob: notebooks/gallery/* - file: notebooks/gallery/index1 title: do we want - file: notebooks/gallery/index2 - title: for these "chapters"? + title: for these "chapters"? diff --git a/notebooks/how-to-cite b/notebooks/how-to-cite new file mode 100644 index 0000000..28de144 --- /dev/null +++ b/notebooks/how-to-cite @@ -0,0 +1,7 @@ +# How to Cite This Cookbook + +The material in Project Pythia's Metpy 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/metpy-cookbook) and archived on Zenodo. This DOI will always resolve to the latest release of the book source: + +[![DOI](https://zenodo.org/badge/620944317.svg)](https://zenodo.org/badge/latestdoi/620944317) From d730cd8e48b7b7ef81160d1343b4a0db6d66497b Mon Sep 17 00:00:00 2001 From: Julia Kent <46687291+jukent@users.noreply.github.com> Date: Sat, 24 Jun 2023 09:15:34 -0600 Subject: [PATCH 2/2] config --- _config.yml | 17 ++--------------- 1 file changed, 2 insertions(+), 15 deletions(-) diff --git a/_config.yml b/_config.yml index c5ea439..f93dee9 100644 --- a/_config.yml +++ b/_config.yml @@ -4,22 +4,8 @@ title: The MetPy Cookbook author: MetPy Maintainers logo: pythia.png -email: support-python@unidata.ucar.edu copyright: "2023" -description: A sample cookbook description. -thumbnail: metpy.png -tags: - domains: - - meteorology - - data access - packages: - - metpy - - siphon - - cartopy - - xarray - - pint - execute: # To execute notebooks via a binder instead, replace 'cache' with 'binder' execute_notebooks: cache @@ -43,8 +29,9 @@ parse: sphinx: config: + html_favicon: notebooks/images/icons/favicon.ico - html_last_updated_fmt: "%-d %B %Y" + html_last_updated_fmt: '%-d %B %Y' html_theme: sphinx_pythia_theme html_permalinks_icon: '' html_theme_options: