Feat/extends

.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

environment.yml

@@ -19,6 +19,8 @@ dependencies:
   - datashader
   - panel
   - sphinx-pythia-theme
+  - mystmd
+  - nodejs
   - s3fs>=2024.3.1
   - pip
   - pip:

myst.yml

@@ -0,0 +1,33 @@
+version: 1
+extends:
+  - pythia.yml
+project:
+  title: Radar Cookbook
+  github: https://github.com/projectpythia-mystmd/radar-cookbook
+  authors:
+    - name: Max Grover
+    - name: Zachary Sherman
+    - name: Milind Sharma
+  copyright: '2024'
+  toc:
+    - file: README.md
+    - title: Preamble
+      children:
+        - file: notebooks/how-to-cite.md
+    - title: Weather Radar Foundations
+      children:
+        - file: notebooks/radar-basics/radar-basics.ipynb
+    - title: Radar Software Foundations
+      children:
+        - file: notebooks/foundations/pyart-basics.ipynb
+        - file: notebooks/foundations/pyart-corrections.ipynb
+        - file: notebooks/foundations/pyart-gridding.ipynb
+        - file: notebooks/foundations/interactive-radar-visualization.ipynb
+    - title: Example Workflows
+      children:
+        - file: notebooks/example-workflows/moore-oklahoma-tornado.ipynb
+        - file: notebooks/example-workflows/tracer-example.ipynb
+        - file: notebooks/example-workflows/kdp-comparison.ipynb
+        - file: notebooks/example-workflows/cacti-data-quality-example.ipynb
+        - file: notebooks/example-workflows/fastbarnes_interpolation_rhi.ipynb
+        - file: notebooks/example-workflows/echo_top_height.ipynb

pythia.yml

@@ -0,0 +1,25 @@
+version: 1
+project:
+  open_access: true
+  license:
+    content: MIT
+    code: CC-BY-4.0
+site:
+  template: book-theme
+  options:
+    # favicon: favicon.ico
+    logo: notebooks/images/logos/pythia_logo-white-rtext.svg
+  nav:
+    - title: Home
+      url: https://projectpythia.org
+    - title: Foundations
+      url: https://foundations.projectpythia.org
+    - title: Cookbooks
+      url: https://cookbooks.projectpythia.org
+    - title: Resources
+      url: https://projectpythia.org/resource-gallery.html
+    - title: Community
+      url: https://projectpythia.org/index.html#join-us
+  actions:
+    - title: Pythia Project
+      url: https://projectpythia.org