Merge pull request #1 from Christian-Kofi-Okyere/main

Converted files to work with myst

Author: jukent

_config.yml renamed to ._config.yml.bak

@@ -0,0 +1,48 @@
+# This file was created automatically with `myst init --gh-pages` 🪄 💚
+# Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**.
+
+name: MyST GitHub Pages Deploy
+on:
+  push:
+    # Runs on pushes targeting the default branch
+    branches: [main]
+env:
+  # `BASE_URL` determines, relative to the root of the domain, the URL that your site is served from.
+  # E.g., if your site lives at `https://mydomain.org/myproject`, set `BASE_URL=/myproject`.
+  # If, instead, your site lives at the root of the domain, at `https://mydomain.org`, set `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@v3
+        with:
+          path: './_build/html'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/deploy.yml

@@ -134,3 +134,6 @@ dmypy.json
 
 # Ephemeral .nfs files
 .nfs*
+
+# MyST build outputs
+_build

.gitignore

@@ -26,3 +26,4 @@ dependencies:
   - pip
   - pip:
     - climkern
+  - mystmd

environment.yml

@@ -0,0 +1,41 @@
+version: 1
+extends:
+  - https://raw.githubusercontent.com/projectpythia-mystmd/pythia-config/main/pythia.yml
+project:
+  title: Radiative Feedback Cookbook
+  authors:
+    - name: Project Pythia Community
+      url: https://projectpythia.org/
+  github: https://github.com/projectpythia-mystmd/radiative-feedback-cookbook
+  copyright: '2024'
+  bibliography:
+    - bibliography.bib
+  toc:
+    - file: README.md
+    - title: Preamble
+      children:
+        - file: notebooks/how-to-cite.md
+    - title: Foundations
+      children:
+        - file: notebooks/foundations/energy-balance-model.ipynb
+        - file: notebooks/foundations/theory-rad-feedback.ipynb
+    - title: Feedback Analysis
+      children:
+        - file: notebooks/feedback-analysis/manual-calc.ipynb
+        - file: notebooks/feedback-analysis/aprp.ipynb
+    - title: Simplifying Calculations
+      children:
+        - file: notebooks/simplified-calc/climkern-calc.ipynb
+        - file: notebooks/simplified-calc/kernel-comparison.ipynb
+        - file: notebooks/simplified-calc/state-dependence.ipynb
+    - title: Appendix
+      children:
+        - file: references.md
+  jupyter:
+      binder:
+        repo: projectpythia-mystmd/radiative-feedback-cookbook
+site:
+  options:
+    logo: notebooks/images/logos/pythia_logo-white-rtext.svg
+    folders: true
+  template: book-theme