diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..96a1c0d --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,17 @@ +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: Tyle + given-names: Kevin + orcid: https://orcid.org/0000-0002-0370-8974 # optional + website: https://github.com/ktyle + affiliation: University at Albany # optional + - family-names: Barletta + given-names: Michael + website: https://github.com/Michael-Barletta + orcid: https://orcid.org/0000-0003-3318-7601 + - name: "XGCM Cookbook contributors" # use the 'name' field to acknowledge organizations + website: "https://github.com/ProjectPythia/xgcm-cookbook/graphs/contributors" +title: "XGCM Interactive Visualization Cookbook" +abstract: "The cookbook for xgcm examples and use cases that were originally housed by Pangeo Gallery." diff --git a/README.md b/README.md index a9cd5d2..a80d5b8 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,7 @@ [![nightly-build](https://github.com/ProjectPythia/xgcm-cookbook/actions/workflows/nightly-build.yaml/badge.svg)](https://github.com/ProjectPythia/xgcm-cookbook/actions/workflows/nightly-build.yaml) [![Binder](http://binder.mypythia.org/badge_logo.svg)](http://binder.mypythia.org/v2/gh/ProjectPythia/xgcm-cookbook/main?labpath=notebooks) +[![DOI](https://zenodo.org/badge/508004390.svg)](https://zenodo.org/badge/latestdoi/508004390) This Project Pythia Cookbook covers ... (replace `...` with the main subject of your cookbook ... e.g., *working with radar data in Python*) diff --git a/_config.yml b/_config.yml index f41eeee..c6b466c 100644 --- a/_config.yml +++ b/_config.yml @@ -4,17 +4,8 @@ title: XGCM Cookbook author: the Project Pythia Community logo: notebooks/images/logos/pythia_logo-white-rtext.svg -email: projectpythia@ucar.edu copyright: '2022' -description: The cookbook for xgcm examples and use cases that were originally housed by Pangeo Gallery. -thumbnail: thumbnail.png -tags: - domains: - - - packages: - - xgcm - # Don't execute the notebooks upon building the book execute: execute_notebooks: "off" diff --git a/_gallery_info.yml b/_gallery_info.yml new file mode 100644 index 0000000..37c5558 --- /dev/null +++ b/_gallery_info.yml @@ -0,0 +1,6 @@ +thumbnail: thumbnail.png +tags: + domains: + - + packages: + - xgcm \ No newline at end of file diff --git a/_toc.yml b/_toc.yml index 2fed654..995f86b 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: Introduction chapters: - file: notebooks/notebook-template diff --git a/notebooks/how-to-cite.md b/notebooks/how-to-cite.md new file mode 100644 index 0000000..5b317a5 --- /dev/null +++ b/notebooks/how-to-cite.md @@ -0,0 +1,7 @@ +# How to Cite This Cookbook + +The material in Project Pythia's XGCM 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/xgcm-cookbook) and archived on Zenodo. This DOI will always resolve to the latest release of the book source: + +[![DOI](https://zenodo.org/badge/508004390.svg)](https://zenodo.org/badge/latestdoi/508004390)