Merge branch 'master' into notebook-gallery

econ-ark · Jul 31, 2023 · 6ab3b4d · 6ab3b4d
2 parents df8d877 + a547d08
commit 6ab3b4d
Show file tree

Hide file tree

Showing 50 changed files with 1,665 additions and 14,587 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -28,10 +28,10 @@ jobs:
     steps:
     - uses: actions/checkout@v3
 
-    - name: Set up Python 3.9
+    - name: Set up Python 3.10
       uses: actions/setup-python@v4
       with:
-        python-version: "3.9"  # Numba doesn't support Python 3.11 [2023-05]
+        python-version: "3.10"  # Interpolation.py doesn't support Python 3.11 [2023-07]
         cache: 'pip'
         cache-dependency-path: |
           requirements/base.txt
@@ -52,6 +52,7 @@ jobs:
         -M html Documentation HARK-docs
         -T
         -W
+        -j auto
 
     - name: Set up git for deployment
       run: |
@@ -73,3 +74,25 @@ jobs:
         --force 
         https://x-access-token:${{ github.token }}@github.com/${{ github.repository }}
         `git subtree split --prefix HARK-docs/html gh-pages`:refs/heads/gh-pages
+
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install --upgrade sphinx-lint
+    - name: Lint documentation with sphinx-lint
+      run: >
+        sphinx-lint
+        --ignore Documentation/example_notebooks/GenIncProcessModel.py
+        --enable all
+        --max-line-length 85 
+        README.md
+        Documentation/
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
@@ -130,4 +130,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/HARK/distribution.py b/HARK/distribution.py
@@ -1181,7 +1181,7 @@ def func_wrapper(x: np.ndarray, *args: Any) -> np.ndarray:
 
         if len(kwargs):
             f_query = func(self.dataset, **kwargs)
-            ldd = DiscreteDistributionLabeled.from_dataset(f_query, self.pmv)
+            ldd = DiscreteDistributionLabeled.from_dataset(f_query, self.probability)
 
             return ldd
 

diff --git a/HARK/tests/test_distribution.py b/HARK/tests/test_distribution.py
@@ -1,6 +1,7 @@
 import unittest
 
 import numpy as np
+import xarray as xr
 
 from HARK.distribution import (
     Bernoulli,
@@ -603,3 +604,41 @@ def test_combine_labeled_dist(self):
                 np.concatenate([de.expected(), abc.expected()]),
             )
         )
+
+
+class labeled_transition_tests(unittest.TestCase):
+    def setUp(self) -> None:
+        return super().setUp()
+
+    def test_expectation_transformation(self):
+        # Create a basic labeled distribution
+        base_dist = DiscreteDistributionLabeled(
+            pmv=np.array([0.5, 0.5]),
+            atoms=np.array([[1.0, 2.0], [3.0, 4.0]]),
+            var_names=["a", "b"],
+        )
+
+        # Define a transition function
+        def transition(shocks, state):
+            state_new = {}
+            state_new["m"] = state["m"] * shocks["a"]
+            state_new["n"] = state["n"] * shocks["b"]
+            return state_new
+
+        m = xr.DataArray(np.linspace(0, 10, 11), name="m", dims=("grid",))
+        n = xr.DataArray(np.linspace(0, -10, 11), name="n", dims=("grid",))
+        state_grid = xr.Dataset({"m": m, "n": n})
+
+        # Evaluate labeled transformation
+
+        # Direct expectation
+        exp1 = base_dist.expected(transition, state=state_grid)
+        # Expectation after transformation
+        new_state_dstn = base_dist.dist_of_func(transition, state=state_grid)
+        # TODO: needs a cluncky identity function with an extra argument because
+        # DDL.expected() behavior is very different with and without kwargs.
+        # Fix!
+        exp2 = new_state_dstn.expected(lambda x, unused: x, unused=0)
+
+        assert np.all(exp1["m"] == exp2["m"]).item()
+        assert np.all(exp1["n"] == exp2["n"]).item()
diff --git a/README.md b/README.md
@@ -183,9 +183,9 @@ Looking for help? Please open a [GitHub issue](https://github.com/econ-ark/HARK/
 
 Current releases follow [Semantic Versioning](https://semver.org/). For more information please see the [Release documentation](https://github.com/econ-ark/OverARK/wiki/Release-Management).
 
-## API Documentation
+## Documentation
 
-Documentation for the latest release is at [docs.econ-ark.org](https://docs.econ-ark.org/reference/).
+Documentation for the latest release is at [docs.econ-ark.org](https://docs.econ-ark.org/).
 
 ## Introduction
 

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