Merge pull request #12 from jukent/doi

doi infrastructure

CITATION.cff

@@ -2,47 +2,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: Rose
-    given-names: Brian E. J.
-    orcid: https://orcid.org/0000-0002-9961-3821 # optional
-    website: https://github.com/brian-rose # optional
-    affiliation: University at Albany (State University of New York) # optional
-  - family-names: Kent
-    given-names: Julia
-    orcid: https://orcid.org/0000-0002-5611-8986
-    website: https://github.com/jukent
-    affiliation: UCAR/NCAR
-  - family-names: Tyle
-    given-names: Kevin
-    orcid: https://orcid.org/0000-0001-5249-9665
-    website: https://github.com/ktyle
-    affiliation: University at Albany (State University of New York)
-  - family-names: Clyne
-    given-names: John
-    orcid: https://orcid.org/0000-0003-2788-9017
-    website: https://github.com/clyne
-    affiliation: UCAR/NCAR
-  - family-names: Camron
-    given-names: Drew
-    orcid: https://orcid.org/0000-0001-7246-6502
-    website: https://github.com/dcamron
-    affiliation: UCAR/Unidata
-  - family-names: Grover
-    given-names: Maxwell
-    orcid: https://orcid.org/0000-0002-0370-8974
-    website: https://github.com/mgrover1
-    affiliation: Argonne National Laboratory
-  - family-names: Ford
-    given-names: Robert R.
-    orcid: https://orcid.org/0000-0001-5483-4965
-    website: https://github.com/r-ford
-    affiliation: University at Albany (State University of New York)
-  - family-names: Paul
-    given-names: Kevin
-    orcid: https://orcid.org/0000-0001-8155-8038
-    website: https://github.com/kmpaul
-    affiliation: NVIDIA
-  - name: "Cookbook Template contributors" # use the 'name' field to acknowledge organizations
-    website: "https://github.com/ProjectPythia/cookbook-template/graphs/contributors"
-title: "Cookbook Template"
-abstract: "A sample cookbook description."
+  - family-names: Hsu
+    given-names: Chia-Wei
+    orcid: https://orcid.org/0000-0002-4838-0140
+    affiliation: NOAA Physical Science Laboratory/ Univsersity of Colorado, Boulder (CIRES)
+    website: https://github.com/chiaweh2
+  - name: "Marine Heatwave Cookbook contributors" # use the 'name' field to acknowledge organizations
+    website: "https://github.com/ProjectPythia/marine-heatwave-cookbook/graphs/contributors"
+title: "Marine Heatwave Cookbook"
+abstract: "This Project Pythia Cookbook covers how marine heatwaves forecast is generated and detected based on available observational data."

README.md

@@ -2,9 +2,9 @@
 
 # Marine Heatwaves Cookbook
 
-[![nightly-build](https://github.com/ProjectPythia/cookbook-template/actions/workflows/nightly-build.yaml/badge.svg)](https://github.com/ProjectPythia/cookbook-template/actions/workflows/nightly-build.yaml)
+[![nightly-build](https://github.com/ProjectPythia/marine-heatwave-cookbook/actions/workflows/nightly-build.yaml/badge.svg)](https://github.com/ProjectPythia/marine-heatwave-cookbook/actions/workflows/nightly-build.yaml)
 [![Binder](https://binder.projectpythia.org/badge_logo.svg)](https://binder.projectpythia.org/v2/gh/ProjectPythia/marine-heatwave-cookbook/main?labpath=notebooks)
-[![DOI](https://zenodo.org/badge/475509405.svg)](https://zenodo.org/badge/latestdoi/475509405)
+[![DOI](https://zenodo.org/badge/656355237.svg)](https://zenodo.org/badge/latestdoi/656355237)
 
 This main goal of this Marine Heatwaves Cookbook is to show how to detect and forecast marine heatwaves based on available observational and model forecast data.
 The step and code used in the cookbook is also used to generate the [Marine Heatwave Portal at NOAA Physcial Science Laboratory](https://psl.noaa.gov/marine-heatwaves/)
@@ -13,11 +13,13 @@ To understand more scientific detail of the forecast skill please check out [Jac
 This cookbook is initiated during the pythia cookoff 2023.
 
 ## Motivation
+
 The marine heatwave have started to become one of the many "hot topics" in climate science.
 This cookbook is aiming to show how a marine heatwave is detected and forecast based on [Jacox et al., 2022](http://doi.org/10.1038/s41586-022-04573-9)
 
 ## Authors
-[Chia-Wei Hsu](https://chiaweh2.github.io)
+
+[Chia-Wei Hsu](@chiaweh2)
 
 ### Contributors
 
@@ -36,7 +38,8 @@ We will also explain one of the hot discussion topics in the marine heatwave fie
 
 ### Application
 
-In the application chapter, we will show 
+In the application chapter, we will show
+
 1. How a marine heatwave is being forecast shown in [PSL Marine Heatwave Portal](https://psl.noaa.gov/marine-heatwaves/)?
 1. Is it possible to track how a marine heatwave moves in the ocean?
 

_config.yml

@@ -4,17 +4,8 @@
 title: Marine Heatwave Cookbook
 author: Chia-Wei Hsu
 logo: notebooks/images/logos/pythia_logo-white-rtext.svg
-email: [email protected]
 copyright: "2023"
 
-description: This Project Pythia Cookbook covers how marine heatwaves forecast is generated and detected based on available observational data. 
-thumbnail: MHW_maps_demo3.png
-tags:
-  domains:
-    - climate
-  packages:
-    - xarray
-
 execute:
   # To execute notebooks via a Binder instead, replace 'cache' with 'binder'
   execute_notebooks: cache

_gallery_info.yml

@@ -1,6 +1,6 @@
-thumbnail: thumbnail.png
+thumbnail: MHW_maps_demo3.png
 tags:
   domains:
-    - sampledomain
+    - climate
   packages:
-    - samplepackage
+    - xarray

_toc.yml

@@ -1,7 +1,9 @@
 format: jb-book
 root: README
 parts:
+  - caption: Preamble
+    chapters:
+      - file: notebooks/how-to-cite
   - caption: Foundation
     chapters:
       - file: notebooks/foundation/mhw_observation_myst
-

notebooks/how-to-cite.md

@@ -1,7 +1,7 @@
 # How to Cite This Cookbook
 
-The material in Project Pythia's [Cookbook Template] 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 material in Project Pythia's Marine Heatwave 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/cookbook-template) and archived on Zenodo. This DOI will always resolve to the latest release of the book source:
+The source code for the book is [released on GitHub](https://github.com/ProjectPythia/marine-heatwave-cookbook) and archived on Zenodo. This DOI will always resolve to the latest release of the book source:
 
-[![DOI](https://zenodo.org/badge/475509405.svg)](https://zenodo.org/badge/latestdoi/475509405)
+[![DOI](https://zenodo.org/badge/656355237.svg)](https://zenodo.org/badge/latestdoi/656355237)