Merge pull request #5 from NCAR/create_topo

.github/workflows/deploy.yml

@@ -1,37 +1,34 @@
 name: deploy
 
 on:
-  # Trigger the workflow on push to main branch
   push:
     branches:
       - main
 
-# This job installs dependencies, build the book, and pushes it to `gh-pages`
 jobs:
   build-and-deploy-book:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        python-version: [3.8]
+    runs-on: ubuntu-latest
+
     steps:
-    - uses: actions/checkout@v2
+    - name: Checkout repository
+      uses: actions/checkout@v4
 
-    # Install dependencies
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+    - name: Setup Python
+      uses: actions/setup-python@v5
       with:
-        python-version: ${{ matrix.python-version }}
+        python-version: "3.11"
+
     - name: Install dependencies
       run: |
-        pip install -r requirements.txt
-    # Build the book
+        python -m pip install --upgrade pip
+        pip install "jupyter-book==0.15.1" ghp-import
+        pip install -r requirements.txt || true
+
     - name: Build the book
       run: |
         jupyter-book build .
-    # Deploy the book's HTML to gh-pages branch
-    - name: GitHub Pages action
-      uses: peaceiris/actions-gh-pages@v3.6.1
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: _build/html
+        ls -R _build/html
+
+    - name: Deploy to GitHub Pages
+      run: |
+        ghp-import -n -p -f _build/html

.gitignore

@@ -9,6 +9,16 @@ __pycache__/
 # C extensions
 *.so
 
+# fortran object and module files
+*.o
+*.mod
+
+# misc
+*.o*
+
+# old studd
+*/OLD*
+
 # Distribution / packaging
 .Python
 build/

_config.yml

@@ -7,13 +7,11 @@ execute:
 # Information about where the book exists on the web
 repository:
   url: https://github.com/NCAR/tx2_3  # Online location of your book
-  path_to_book: docs  # Optional path to your book, relative to the repository root
+  path_to_book: .  # Optional path to your book, relative to the repository root
   branch: main  # Which branch of the repository should be used when creating links (optional)
 
 # Add GitHub buttons to your book
 # See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
 html:
   use_repository_button: true
-  use_edit_page_button : true
-  use_issues_button    : true
-  home_page_in_navbar  : false
+  use_issues_button: true

_toc.yml

@@ -1,14 +1,27 @@
 format: jb-book
-root: README
-chapters:
-- file: supergrid/orca_gridgen.md
-- file: topography/topo.md
-- file: mesh/mesh.md
-- file: runoff_mapping/runoff.md
-- file: initial_conditions/ics.md
-- file: vertical_grids/vgrid.md
-- file: state_restoring/state_restoring.ipynb
-- file: tidal_energy_dissipation/regrid_tidal_dissipation.ipynb
-- file: chlorophyll/Interpolate_and_fill_SeaWIFS.ipynb
-- file: transport_sections/transport_sections.ipynb
-- file: seaice_files/ice.md
+root: intro
+parts:
+  - caption: Model Setup
+    chapters:
+    - file: supergrid/orca_gridgen.md
+    - file: topography/topo.md
+    - file: mesh/create_mesh.ipynb
+    - file: runoff_mapping/runoff.md
+    - file: state_restoring/state_restoring.ipynb
+    - file: tidal_energy_dissipation/regrid_tidal_dissipation.ipynb
+    - file: chlorophyll/Interpolate_and_fill_SeaWIFS.ipynb
+    - file: seaice_files/create_seaice.ipynb
+    - file: geothermal/davies2013_to_tx2_3.ipynb
+    - file: background_viscosity/background_kh_tx2_3.ipynb
+    - file: cr_mask/mle_cr_labsea_mask.ipynb
+  - caption: Model Validation
+    chapters:
+    - file:  basin_masks/basin_masks.ipynb
+    - file:  basin_masks/imbie_basin_to_tx2_3.ipynb
+    - file:  woa18/woa18_to_tx2_3.ipynb
+    - file:  mld/deBoyer2004/deBoyer2004_to_tx2_3.ipynb
+    - file:  mld/deBoyer2023/deBoyer2023_to_tx2_3.ipynb
+    - file:  aviso/aviso_to_tx2_3.ipynb
+    - file:  oisst/oisst_to_tx2_3.ipynb
+    - file:  sfc_check/sfc_flux_check_xarray_g01.ipynb
+    - file:  sfc_check/sfc_flux_check_xarray_b01.ipynb