Merge pull request #18 from jukent/doi

doi infrastructure changes

Author: jukent

CITATION.cff

@@ -0,0 +1,28 @@
+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: Banihirwe
+    given-names: Anderson
+    orcid: https://orcid.org/0000-0001-6583-571X
+    website: https://github.com/andersy005
+  - family-names: Bonnlander
+    given-names: Brian
+    website: https://github.com/bonnland
+  - family-names: de La Beaujardière
+    given-names: Jeff
+    website: https://github.com/jeffdlb
+    affiliation: UCAR/NCAR
+  - family-names: Henderson
+    given-names: Scott
+    website: https://github.com/scotthq
+    orcid: https://orcid.org/0000-0003-0624-4965 
+  - name: "CESM LENS on AWS Cookbook contributors" # use the 'name' field to acknowledge organizations
+    website: "https://github.com/ProjectPythia/cesm-lens-aws-cookbook/graphs/contributors"
+title: "CESM LENS on AWS Cookbook"
+abstract: "Notebooks developed to demonstrate analysis of CESM LENS data publicly available on Amazon S3 (us-west-2 region) using Xarray and Dask."

README.md

@@ -4,6 +4,7 @@
 
 [![nightly-build](https://github.com/ProjectPythia/cesm-lens-aws-cookbook/actions/workflows/nightly-build.yaml/badge.svg)](https://github.com/ProjectPythia/cesm-lens-aws-cookbook/actions/workflows/nightly-build.yaml)
 [![Binder](https://binder.projectpythia.org/badge_logo.svg)](https://binder.projectpythia.org/v2/gh/ProjectPythia/cesm-lens-aws-cookbook/main?labpath=notebooks)
+[![DOI](https://zenodo.org/badge/509240024.svg)](https://zenodo.org/badge/latestdoi/509240024)
 
 This Project Pythia Cookbook covers analysis of CESM LENS data publicly available on Amazon S3 (us-west-2 region) using Xarray and Dask
 
@@ -26,12 +27,15 @@ The total LENS data volume is ~500 TB, and is traditionally accessible through t
 ## Structure
 
 ### Foundations
+
 There is one notebook in this section that describes how to access the CESM LENS data from AWS using Intake ESM. It includes examples of using an enhanced catalog.
 
 ### Example workflows
+
 This section contains an example of using this dataset to recreate two plots from a paper published in BAMS.
 
 ## Running the Notebooks
+
 You can either run the notebook using [Binder](https://binder.projectpythia.org) or on your local machine.
 
 ### Running on Binder
@@ -52,26 +56,28 @@ a live Jupyter notebook are described in [Getting Started with
 Jupyter](https://foundations.projectpythia.org/foundations/getting-started-jupyter.html).
 
 ### Running on Your Own Machine
+
 If you are interested in running this material locally on your computer, you will need to follow this workflow:
 
-(Replace "cookbook-example" with the title of your cookbooks)   
+(Replace "cookbook-example" with the title of your cookbooks)
 
 1. Clone the `https://github.com/ProjectPythia/cesm-lens-aws-cookbook` repository:
 
    ```bash
     git clone https://github.com/ProjectPythia/cesm-lens-aws-cookbook.git
-    ```  
+   ```
+
 1. Move into the `cesm-lens-aws-cookbook` directory
-    ```bash
-    cd cesm-lens-aws-cookbook
-    ```  
+   ```bash
+   cd cesm-lens-aws-cookbook
+   ```
 1. Create and activate your conda environment from the `environment.yml` file
-    ```bash
-    conda env create -f environment.yml
-    conda activate cla-cookbook-dev
-    ```  
-1.  Move into the `notebooks` directory and start up Jupyterlab
-    ```bash
-    cd notebooks/
-    jupyter lab
-    ```
+   ```bash
+   conda env create -f environment.yml
+   conda activate cla-cookbook-dev
+   ```
+1. Move into the `notebooks` directory and start up Jupyterlab
+   ```bash
+   cd notebooks/
+   jupyter lab
+   ```

_config.yml

@@ -4,16 +4,7 @@
 title: CESM LENS on AWS Cookbook
 author: the <a href="https://projectpythia.org/">Project Pythia</a> Community
 logo: notebooks/images/logos/pythia_logo-white-rtext.svg
-email: [email protected]
-copyright: '2022'
-
-description: Notebooks developed to demonstrate analysis of CESM LENS data publicly available on Amazon S3 (us-west-2 region) using Xarray and Dask.
-thumbnail: thumbnail.png
-tags:
-  domains:
-    - climate
-  packages:
-    - intake-esm
+copyright: "2022"
 
 execute:
   # To execute notebooks via a Binder instead, replace 'cache' with 'binder'
@@ -38,7 +29,7 @@ sphinx:
     linkcheck_ignore: ["https://doi.org/*"] # don't run link checker on DOI links since they are immutable
     nb_execution_raise_on_error: true # raise exception in build if there are notebook errors (this flag is ignored if building on binder)
     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,6 @@
+thumbnail: thumbnail.png
+tags:
+  domains:
+    - climate
+  packages:
+    - intake-esm

_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/enhanced-catalog.ipynb

notebooks/how-to-cite.md

@@ -0,0 +1,7 @@
+# How to Cite This Cookbook
+
+The material in Project Pythia's CESM LENS on AWS 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/cesm-lens-aws-cookbook) and archived on Zenodo. This DOI will always resolve to the latest release of the book source:
+
+[![DOI](https://zenodo.org/badge/509240024.svg)](https://zenodo.org/badge/latestdoi/509240024)