myst infrastructure changes

Author: jukent

.github/workflows/deploy.yml

@@ -0,0 +1,46 @@
+# This file was created automatically with `myst init --gh-pages` 🪄 💚
+
+name: MyST GitHub Pages Deploy
+on:
+  push:
+    # Runs on pushes targeting the default branch
+    branches: [main]
+env:
+  # `BASE_URL` determines the website is served from, including CSS & JS assets
+  # You may need to change this to `BASE_URL: ''`
+  BASE_URL: /${{ github.event.repository.name }}
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - name: Install MyST Markdown
+        run: npm install -g mystmd
+      - name: Build HTML Assets
+        run: myst build --html
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: './_build/html'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.gitignore

@@ -134,3 +134,6 @@ dmypy.json
 
 # Do not track netCDF data files
 .nc
+
+# MyST build outputs
+_build

environment.yml

@@ -1,4 +1,4 @@
-name: cla-cookbook-dev
+name: cla-myst-cookbook-dev
 channels:
   - conda-forge
 dependencies:
@@ -18,3 +18,4 @@ dependencies:
   - cartopy
   - sphinx-pythia-theme
   - zarr
+  - mystmd

myst.yml

@@ -0,0 +1,42 @@
+# See docs at: https://mystmd.org/guide/frontmatter
+version: 1
+extends:
+  - https://raw.githubusercontent.com/projectpythia-mystmd/pythia-config/main/pythia.yml
+project:
+  id: 8ae3f9b8-fa17-4538-bbda-352888ee892d
+  # title:
+  # description:
+  # keywords: []
+  # authors: []
+  github: https://github.com/projectpythia-mystmd/cesm-lens-aws-cookbook
+  # To autogenerate a Table of Contents, run "myst init --write-toc"
+  authors:
+    - name: Anderson Banihirwe
+    - name: Brian Bonnlander
+    - name: Jeff de La Beaujardière
+    - name: Scott Henderson
+  copyright: '2024'
+  toc:
+    # Auto-generated by `myst init --write-toc`
+    - file: README.md
+    - title: Preamble
+      children:
+        - file: notebooks/how-to-cite.md
+    - title: Foundations
+      children:
+        - file: notebooks/foundations/enhanced-catalog.ipynb
+    - title: Example workflows
+      children:
+        - file: notebooks/example-workflows/key-figures.ipynb
+    - title: Appendix
+      children:
+        - file: references.md
+
+  jupyter:
+      binder:
+        repo: projectpythia-mystmd/cesm-lens-aws-cookbook  
+site:
+  template: book-theme
+  # options:
+  #   favicon: favicon.ico
+  #   logo: site_logo.png

notebooks/example-workflows/key-figures.ipynb

@@ -1019,27 +1019,6 @@
     "### What's next?\n",
     "More example workflows using these datasets may be added in the future."
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Resources and references\n",
-    "\n",
-    "1. [Original notebook in the (no longer maintained) Pangeo Gallery](https://gallery.pangeo.io/repos/NCAR/cesm-lens-aws/notebooks/EnhancedIntakeCatalogDemo.html)\n",
-    "2. [Kay et al. (2015): _The Community Earth System Model (CESM) Large Ensemble Project_, BAMS, doi:10.1175/BAMS-D-13-00255.1](https://doi.org/10.1175/BAMS-D-13-00255.1)\n",
-    "3. [CESM LENS Data Sets on AWS](https://doi.org/10.26024/wt24-5j82)\n",
-    "4. [Morice et al. (2012) paper on HadCRUT4 dataset](https://doi.org/10.1029/2011JD017187)\n",
-    "5. [NASS GISTEMP dataset](https://data.giss.nasa.gov/gistemp/)\n",
-    "6. [Lenssen et al. (2019) paper on latest GISTEMP methods](https://doi.org/10.1029/2018JD029522)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {

notebooks/foundations/enhanced-catalog.ipynb

@@ -524,25 +524,6 @@
     "### What's next?\n",
     "We will use this data to recreate some figures from a paper published in [BAMS](https://www.ametsoc.org/index.cfm/ams/publications/bulletin-of-the-american-meteorological-society-bams/) that describes the CESM LENS project: {cite:t}`Kay:2015a`"
    ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Resources and references\n",
-    "\n",
-    "1. [Original notebook in the (no longer maintained) Pangeo Gallery](https://gallery.pangeo.io/repos/NCAR/cesm-lens-aws/notebooks/EnhancedIntakeCatalogDemo.html)\n",
-    "2. [Intake-esm documentation](https://intake-esm.readthedocs.io)\n",
-    "3. [Kay et al. (2015): _The Community Earth System Model (CESM) Large Ensemble Project_, BAMS, doi:10.1175/BAMS-D-13-00255.1](https://doi.org/10.1175/BAMS-D-13-00255.1)\n",
-    "4. [Community Earth System Model Large Ensemble (CESM LENS) Data Sets on AWS](https://doi.org/10.26024/wt24-5j82)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {