Merge pull request #16 from brian-rose/use-binder

Use binder -- can we run the big notebook?

Author: brian-rose

.github/workflows/nightly-build.yaml

@@ -3,14 +3,15 @@ name: nightly-build
 on:
   workflow_dispatch:
   schedule:
-    - cron: '0 0 * * *' # Daily “At 00:00”
+    - cron: '0 0 * * 0' # Weekly Sunday at 00:00
 
 jobs:
   build:
     if: ${{ github.repository_owner == 'ProjectPythia' }}
     uses: ProjectPythia/cookbook-actions/.github/workflows/build-book.yaml@main
     with:
       environment_name: cookbook-dev
+      binder_nb_timeout: 3600 # one hour run time
 
   link-check:
     if: ${{ github.repository_owner == 'ProjectPythia' }}

.github/workflows/publish-book.yaml

@@ -11,6 +11,7 @@ jobs:
     uses: ProjectPythia/cookbook-actions/.github/workflows/build-book.yaml@main
     with:
       environment_name: cookbook-dev
+      binder_nb_timeout: 3600 # one hour run time
 
   deploy:
     needs: build

.github/workflows/trigger-book-build.yaml

@@ -8,3 +8,4 @@ jobs:
     with:
       environment_name: cookbook-dev
       artifact_name: book-zip-${{ github.event.number }}
+      binder_nb_timeout: 3600 # one hour run time

.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
       - id: double-quote-string-fixer
 
   - repo: https://github.com/psf/black
-    rev: 22.12.0
+    rev: 23.3.0
     hooks:
       - id: black
 
@@ -28,8 +28,9 @@ repos:
     rev: v2.2.0
     hooks:
       - id: seed-isort-config
+
   - repo: https://github.com/PyCQA/isort
-    rev: 5.11.4
+    rev: 5.12.0
     hooks:
       - id: isort
 
@@ -40,7 +41,7 @@ repos:
         additional_dependencies: [[email protected]]
 
   - repo: https://github.com/nbQA-dev/nbQA
-    rev: 1.6.1
+    rev: 1.7.0
     hooks:
       - id: nbqa-black
         additional_dependencies: [black]

_config.yml

@@ -16,11 +16,9 @@ tags:
     - intake-esm
 
 execute:
-  # To execute notebooks via a binder instead, replace 'cache' with 'binder'
-  execute_notebooks: force
+  # To execute notebooks via a Binder instead, replace 'cache' with 'binder'
+  execute_notebooks: binder
   allow_errors: False # cells with expected failures must set the `raises-exception` cell tag
-  exclude_patterns:
-    - 'notebooks/example-workflows/key-figures.ipynb'
 
 # Add a few extensions to help with parsing content
 parse:
@@ -37,8 +35,8 @@ parse:
 
 sphinx:
   config:
-    linkcheck_ignore: ["https://doi.org/*",]
-    nb_execution_raise_on_error: true  # raise exception in build if there are notebook errors
+    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_theme: sphinx_pythia_theme