econ-ark · MridulS · Jul 31, 2023 · Jul 28, 2023 · Jul 28, 2023 · Jul 28, 2023
diff --git a/.github/workflows/execute-notebooks.yml b/.github/workflows/execute-notebooks.yml
@@ -0,0 +1,64 @@
+name: Execute notebooks
+
+# Run on all pushes and pull requests, and on demand
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - ".github/workflows/execute-notebooks.yml"
+      - "examples/**"
+  workflow_dispatch:
+
+# Limit workflow permissions
+permissions:
+  contents: read
+
+# Limit simultaneous workflow runs
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+env:
+  FORCE_COLOR: "1"
+
+jobs:
+  execute:
+    name: Execute
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.10"  # Numba doesn't support Python 3.11 [2023-05]
+        cache: 'pip'
+        cache-dependency-path: |
+          requirements/base.txt
+
+    - name: Install HARK
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install .
+        python -m pip install nbformat nbclient nbstripout 
+
+    - name: Strip output
+      run: nbstripout examples/**/*.ipynb
+
+    - name: Execute notebooks
+      run: python tools/nb_exec.py examples/**/*.ipynb
+
+    - name: Open PR
+      uses: peter-evans/create-pull-request@v5
+      with:
+        author: "Econ-ARK Bot <noreply@econ-ark.org>"
+        branch: "bot/update-notebooks"
+        commit-message: "[bot] updated notebooks"
+        delete-branch: true
+        title: "[bot] Execute example notebooks"
+        body: |
+          This PR was automatically generated to re-execute
+          the example notebooks for use in the documentation.
diff --git a/Documentation/conf.py b/Documentation/conf.py
@@ -126,4 +126,4 @@
 napoleon_use_ivar = True  # solves duplicate object description warning
 
 # nbsphinx configuration
-nbsphinx_execute = "never"  # This is currently not working
+nbsphinx_execute = "never"  # notebooks are executed via ``nb_exec.py``
diff --git a/examples/Calibration/Income_calibrations.ipynb b/examples/Calibration/Income_calibrations.ipynb
diff --git a/examples/Calibration/Life_Cycle_example.ipynb b/examples/Calibration/Life_Cycle_example.ipynb
diff --git a/examples/Calibration/SCF_distributions.ipynb b/examples/Calibration/SCF_distributions.ipynb
diff --git a/examples/Calibration/Sabelhaus_Song_var_profiles.ipynb b/examples/Calibration/Sabelhaus_Song_var_profiles.ipynb
diff --git a/examples/Calibration/US_SSA_life_tables.ipynb b/examples/Calibration/US_SSA_life_tables.ipynb
diff --git a/examples/ConsBequestModel/example_AccidentalBequest.ipynb b/examples/ConsBequestModel/example_AccidentalBequest.ipynb
diff --git a/examples/ConsBequestModel/example_ConsIndShockComp.ipynb b/examples/ConsBequestModel/example_ConsIndShockComp.ipynb
diff --git a/examples/ConsBequestModel/example_TerminalBequest.ipynb b/examples/ConsBequestModel/example_TerminalBequest.ipynb
diff --git a/examples/ConsIndShockModel/Finite Cyclical Test.ipynb b/examples/ConsIndShockModel/Finite Cyclical Test.ipynb
diff --git a/examples/ConsIndShockModel/IndShockConsumerType.ipynb b/examples/ConsIndShockModel/IndShockConsumerType.ipynb
diff --git a/examples/ConsIndShockModel/IndShockConsumerType_Jacobian_Example.ipynb b/examples/ConsIndShockModel/IndShockConsumerType_Jacobian_Example.ipynb
diff --git a/examples/ConsIndShockModel/IndShockConsumerType_Transition_Matrix_Example.ipynb b/examples/ConsIndShockModel/IndShockConsumerType_Transition_Matrix_Example.ipynb
diff --git a/examples/ConsIndShockModel/KinkedRconsumerType.ipynb b/examples/ConsIndShockModel/KinkedRconsumerType.ipynb
diff --git a/examples/ConsIndShockModel/PerfForesightConsumerType.ipynb b/examples/ConsIndShockModel/PerfForesightConsumerType.ipynb
diff --git a/examples/ConsPortfolioModel/example_ConsPortfolioModel.ipynb b/examples/ConsPortfolioModel/example_ConsPortfolioModel.ipynb
diff --git a/examples/ConsPortfolioModel/example_ConsRiskyAssetModel.ipynb b/examples/ConsPortfolioModel/example_ConsRiskyAssetModel.ipynb
diff --git a/examples/ConsPortfolioModel/example_ConsSequentialPortfolioModel.ipynb b/examples/ConsPortfolioModel/example_ConsSequentialPortfolioModel.ipynb
diff --git a/examples/ConsumptionSaving/example_ConsAggShockModel.ipynb b/examples/ConsumptionSaving/example_ConsAggShockModel.ipynb
diff --git a/examples/ConsumptionSaving/example_ConsGenIncProcessModel.ipynb b/examples/ConsumptionSaving/example_ConsGenIncProcessModel.ipynb
diff --git a/examples/ConsumptionSaving/example_ConsIndShock.ipynb b/examples/ConsumptionSaving/example_ConsIndShock.ipynb
diff --git a/examples/ConsumptionSaving/example_ConsLaborModel.ipynb b/examples/ConsumptionSaving/example_ConsLaborModel.ipynb
diff --git a/examples/ConsumptionSaving/example_ConsMarkovModel.ipynb b/examples/ConsumptionSaving/example_ConsMarkovModel.ipynb
diff --git a/examples/ConsumptionSaving/example_ConsMedModel.ipynb b/examples/ConsumptionSaving/example_ConsMedModel.ipynb
diff --git a/examples/ConsumptionSaving/example_ConsPrefShockModel.ipynb b/examples/ConsumptionSaving/example_ConsPrefShockModel.ipynb
diff --git a/examples/ConsumptionSaving/example_ConsRepAgentModel.ipynb b/examples/ConsumptionSaving/example_ConsRepAgentModel.ipynb
diff --git a/examples/ConsumptionSaving/example_TractableBufferStockModel.ipynb b/examples/ConsumptionSaving/example_TractableBufferStockModel.ipynb
diff --git a/examples/Distributions/DiscreteDistributionLabeled.ipynb b/examples/Distributions/DiscreteDistributionLabeled.ipynb
diff --git a/examples/Distributions/ExpectedValue.ipynb b/examples/Distributions/ExpectedValue.ipynb
diff --git a/examples/FrameAgentType/FrameAgentType Demo.ipynb b/examples/FrameAgentType/FrameAgentType Demo.ipynb
diff --git a/examples/FrameAgentType/FrameModels.ipynb b/examples/FrameAgentType/FrameModels.ipynb
diff --git a/examples/GenIncProcessModel/GenIncProcessModel.ipynb b/examples/GenIncProcessModel/GenIncProcessModel.ipynb
diff --git a/examples/Gentle-Intro/Gentle-Intro-To-HARK.ipynb b/examples/Gentle-Intro/Gentle-Intro-To-HARK.ipynb
diff --git a/examples/HowWeSolveIndShockConsumerType/HowWeSolveIndShockConsumerType.ipynb b/examples/HowWeSolveIndShockConsumerType/HowWeSolveIndShockConsumerType.ipynb
diff --git a/examples/Interpolation/CubicInterp.ipynb b/examples/Interpolation/CubicInterp.ipynb
diff --git a/examples/Interpolation/DecayInterp.ipynb b/examples/Interpolation/DecayInterp.ipynb
diff --git a/examples/Journeys/AzureMachineLearning.ipynb b/examples/Journeys/AzureMachineLearning.ipynb
diff --git a/examples/Journeys/Journey-Engineering-Background.ipynb b/examples/Journeys/Journey-Engineering-Background.ipynb
@@ -63,7 +63,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.16"
+   "version": "3.10.12"
   },
   "latex_envs": {
    "LaTeX_envs_menu_present": true,
@@ -95,13 +95,6 @@
    "toc_position": {},
    "toc_section_display": true,
    "toc_window_display": false
-  },
-  "widgets": {
-   "application/vnd.jupyter.widget-state+json": {
-    "state": {},
-    "version_major": 2,
-    "version_minor": 0
-   }
   }
  },
  "nbformat": 4,

diff --git a/examples/Journeys/Journey-PhD.ipynb b/examples/Journeys/Journey-PhD.ipynb
diff --git a/examples/Journeys/Journey-Policymaker.ipynb b/examples/Journeys/Journey-Policymaker.ipynb
diff --git a/examples/Journeys/Journeys-into-HARK.ipynb b/examples/Journeys/Journeys-into-HARK.ipynb
@@ -64,14 +64,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.16"
-  },
-  "widgets": {
-   "application/vnd.jupyter.widget-state+json": {
-    "state": {},
-    "version_major": 2,
-    "version_minor": 0
-   }
+   "version": "3.10.12"
   }
  },
  "nbformat": 4,