Merge pull request #9 from jukent/doi

Infrastructure changes to add DOI

CITATION.cff

@@ -0,0 +1,18 @@
+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: Dupuis
+    given-names: Christopher
+    website: https://github.com/cmdupuis3
+  - family-names: Sinha
+    given-names: Anirban
+    website: https://github.com/anirban89
+  - family-names: Abernathey
+    given-names: Ryan
+    website: https://github.com/rabernat
+    orcid: https://orcid.org/0000-0001-5999-4917
+  - name: "xbatcher for Machine Learning Part 1 Cookbook contributors" # use the 'name' field to acknowledge organizations
+    website: "https://github.com/ProjectPythia/xbatcher-ML-1-cookbook/graphs/contributors"
+title: "xbatcher for Machine Learning Part 1 Cookbook"
+abstract: "A complete workflow for a convolutional neural network using xbatcher."

README.md

@@ -1,9 +1,10 @@
 <img src="thumbnail.png" alt="thumbnail" width="300"/>
- 
+
 # xbatcher for Machine Learning (Part 1) Cookbook
 
 [![nightly-build](https://github.com/ProjectPythia/xbatcher-ML-1-cookbook/actions/workflows/nightly-build.yaml/badge.svg)](https://github.com/ProjectPythia/xbatcher-ML-1-cookbook/actions/workflows/nightly-build.yaml)
 [![Binder](http://binder.mypythia.org/badge_logo.svg)](http://binder.mypythia.org/v2/gh/ProjectPythia/xbatcher-ML-1-cookbook/main?labpath=notebooks)
+[![DOI](https://zenodo.org/badge/597998597.svg)](https://zenodo.org/badge/latestdoi/597998597)
 
 This Project Pythia Cookbook covers a complete workflow for a convolutional neural network. Here, we emphasize how to create xarray-based training datasets with the `xbatcher` package.
 

_config.yml

@@ -4,33 +4,14 @@
 title: xbatcher for Machine Learning Part 1
 author: Christopher Dupuis
 logo: notebooks/images/logos/pythia_logo-white-rtext.svg
-email: [email protected]
-copyright: '2022'
-
-description: A complete workflow for a convolutional neural network using xbatcher.
-thumbnail: thumbnail.png
-tags:
-  domains:
-    - oceanography
-    - machine learning
-    - data science
-    - scientific software engineering
-  packages:
-    - numpy
-    - xarray
-    - zarr
-    - intake
-    - matplotlib
-    - IPython
-    - tensorflow
-    - xbatcher
+copyright: "2022"
 
 execute:
   # To execute notebooks via a binder instead, replace 'cache' with 'binder'
   execute_notebooks: force
   exclude_patterns:
-    - 'notebooks/surface_currents_prep.ipynb'
-    - 'notebooks/surface_currents_model.ipynb'
+    - "notebooks/surface_currents_prep.ipynb"
+    - "notebooks/surface_currents_model.ipynb"
 
 # Add a few extensions to help with parsing content
 parse:
@@ -47,9 +28,8 @@ 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: '<i class="fas fa-link"></i>'
     html_theme_options:

_gallery_info.yml

@@ -0,0 +1,16 @@
+thumbnail: thumbnail.png
+tags:
+  domains:
+    - oceanography
+    - machine learning
+    - data science
+    - scientific software engineering
+  packages:
+    - numpy
+    - xarray
+    - zarr
+    - intake
+    - matplotlib
+    - IPython
+    - tensorflow
+    - xbatcher

_toc.yml

@@ -1,6 +1,9 @@
 format: jb-book
 root: README
 parts:
+  - caption: Preamble
+    chapters:
+      - file: notebooks/how-to-cite
   - caption: Basic CNNs with xbatcher
     chapters:
       - file: notebooks/surface_currents.ipynb

notebooks/how-to-cite.md

@@ -0,0 +1,7 @@
+# How to Cite This Cookbook
+
+The material in Project Pythia's xbatcher for Machine Learning (Part 1) 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/xbatcher-ML1-cookbook) and archived on Zenodo. This DOI will always resolve to the latest release of the book source:
+
+[![DOI](https://zenodo.org/badge/597998597.svg)](https://zenodo.org/badge/latestdoi/597998597)