Add rename_dictionnary parameter to plotting functions for custom display names with alphabetical sorting (#157)

Author: Copilot

.github/workflows/ci.yml

@@ -2,6 +2,12 @@ name: CI
 on:
   - push
 #   - pull_request
+
+# needed to allow julia-actions/cache to delete old caches that it has created
+permissions:
+  actions: write
+  contents: read
+
 jobs:
   test:
     env: 
@@ -117,7 +123,7 @@ jobs:
             arch: x64
             test_set: "jet"
             allow_failure: true
-          - version: '1'
+          - version: '1.11'
             os: ubuntu-latest
             arch: x64
             test_set: "jet"
@@ -126,19 +132,30 @@ jobs:
             arch: x64
             test_set: "jet"
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
-      # On the Julia “pre” matrix entries, drop the unsupported test-only package
-      - name: Remove Pigeons from targets on pre Julia
-        if: matrix.version == 'pre'
+      - name: Remove Pigeons from non estimation runs
+        if: contains(matrix.test_set, 'estimat') == false
+        shell: bash
+        run: |
+          sed -i.bak \
+            -e '/^\[targets\]/,$ s/,[[:space:]]*"Pigeons"//g' \
+            -e '/^\[targets\]/,$ s/"Pigeons",[[:space:]]*//g' \
+            Project.toml
+          rm -f Project.toml.bak
+
+      - name: Remove JET from estimation runs
+        if: contains(matrix.test_set, 'estimat') == true
+        shell: bash
         run: |
-          sed -i \
-            -e '/^\[targets\]/,$s/,[[:space:]]*"Pigeons"//g' \
-            -e '/^\[targets\]/,$s/"Pigeons",[[:space:]]*//g' \
+          sed -i.bak \
+            -e '/^\[targets\]/,$ s/,[[:space:]]*"JET"//g' \
+            -e '/^\[targets\]/,$ s/"JET",[[:space:]]*//g' \
             Project.toml
+          rm -f Project.toml.bak 
       - name: Set Custom Test Environment Variable (Windows)
         if: matrix.os == 'windows-latest'
         run: echo "TEST_SET=${{ matrix.test_set }}" | Out-File -Append -FilePath $env:GITHUB_ENV -Encoding utf8
@@ -148,16 +165,7 @@ jobs:
       - name: Set JULIA_NUM_THREADS for estimation tests
         if: (matrix.version == '1' && (matrix.test_set == 'estimation' || matrix.test_set == 'estimate_sw07' || matrix.test_set == '1st_order_inversion_estimation'))
         run: echo "JULIA_NUM_THREADS=auto" >> $GITHUB_ENV
-      - uses: actions/cache@v4
-        env:
-          cache-name: cache-artifacts
-        with:
-          path: ~/.julia/artifacts
-          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
-          restore-keys: |
-            ${{ runner.os }}-test-${{ env.cache-name }}-
-            ${{ runner.os }}-test-
-            ${{ runner.os }}-
+      - uses: julia-actions/cache@v2
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
         with:

.github/workflows/copilot-setup-steps.yml

@@ -0,0 +1,38 @@
+name: "Copilot Setup Steps"
+
+# Automatically run the setup steps when they are changed to allow for easy validation, and
+# allow manual testing through the repository's "Actions" tab
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+  pull_request:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+
+jobs:
+  # The job MUST be called `copilot-setup-steps` or it will not be picked up by Copilot.
+  copilot-setup-steps:
+    runs-on: ubuntu-latest
+
+    # Set the permissions to the lowest permissions possible needed for your steps.
+    # Copilot will be given its own token for its operations.
+    permissions:
+      # If you want to clone the repository as part of your setup steps, for example to install dependencies, you'll need the `contents: read` permission. If you don't clone the repository in your setup steps, Copilot will do this for you automatically after the steps complete.
+      # needed to allow julia-actions/cache to delete old caches that it has created
+      contents: read
+      actions: write
+
+    # You can define any steps you want, and they will run before the agent starts.
+    # If you do not check out your code, Copilot will do this for you.
+    steps:
+      - uses: actions/checkout@v5
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: "1"
+          arch: x64
+      - name: Set JULIA_NUM_THREADS
+        run: echo "JULIA_NUM_THREADS=auto" >> $GITHUB_ENV
+      - uses: julia-actions/cache@v2
+      - uses: julia-actions/julia-buildpkg@v1

Project.toml

@@ -71,7 +71,7 @@ DynamicPPL = "0.35 - 0.37"
 DynarePreprocessor_jll = "6"
 FiniteDifferences = "0.12"
 ForwardDiff = "0.10, 1"
-JET = "0.7 - 0.10"
+JET = "0.07 - 0.10"
 JSON = "0.21, 1"
 Krylov = "0.10"
 LaTeXStrings = "1"
@@ -80,7 +80,7 @@ LinearAlgebra = "1"
 LinearOperators = "2"
 LinearSolve = "3"
 LoopVectorization = "0.12"
-MCMCChains = "6"
+MCMCChains = "6, 7"
 MacroTools = "0.5"
 MatrixEquations = "2"
 NLopt = "0.6, 1"
@@ -104,7 +104,7 @@ SymPyPythonCall = "0.2 - 0.5"
 Symbolics = "5, 6"
 Test = "1"
 ThreadedSparseArrays = "0.2.3"
-Turing = "0.30 - 0.40"
+Turing = "0.30 - 0.41"
 Unicode = "1"
 Zygote = "0.6, 0.7"
 julia = "1.10"

docs/src/plotting.md

@@ -803,7 +803,7 @@ and then we plot the IRF for the first shock:
 plot_irf(Gali_2015_chapter_3_nonlinear, shocks = shocks[1])
 
 ```
-and then we overlay the IRF for the remaining shocks using the custom color palette by passing on a dictionnary:
+and then we overlay the IRF for the remaining shocks using the custom color palette by passing on a dictionary:
 ```julia
 for s in shocks[2:end]
     plot_irf!(Gali_2015_chapter_3_nonlinear, shocks = s, plot_attributes = Dict(:palette => ec_color_palette), plot_type = :stack)

docs/src/unfinished_docs/todo.md

@@ -3,6 +3,9 @@
 ## High priority
 
 - [ ] write tests/docs/technical details for nonlinear obc, forecasting, (non-linear) solution algorithms, SS solver, obc solver, and other algorithms
+- [ ] make sympy optional (maybe even an extension) and use Symbolics where possible
+- [ ] collect helper function only used in statsplots extension in that script
+- [ ] make package mooncake compatible. write custom pullback functions where necessary (all in one for llh)
 - [ ] print out th OCB shocks as auxilliary shocks
 - [ ] generalised higher order IRF is around mean not SSS. plot mean line?
 - [ ] set irrelevant arguments back to default and inform user
@@ -45,7 +48,6 @@
 - [ ] switch from sympy to Symbolics
 - [ ] optimize second order estim with SW07 or NAWM
 - [ ] optimize third order with smaller model
-- [ ] add argument to plotting functions to replace names in plots (e.g. input a dictionary: Dict(:dinve => "Investment growth"))
 - [ ] programmatic model writing: accept {i}[0] as definition for variable
 - [ ] fix higher order shock finder (3rd order) and check results for pruned second order. are the right state values taken for 1st and second order subprocesses?
 - [ ] take analytical derivatives of NSSS funcs to reduce allocation and speed up the NSSS solver
@@ -137,6 +139,7 @@
 - [ ] weed out SS solver and saved objects
 
 - [x] add to the doc/strings that KeyedArrays are part of the `AxisKeys` package so people can look up how to access elements there. otherwise they might confuse it for a format provided by the package and wouldnt know how to access elements from it
+- [x] add argument to plotting functions to replace names in plots (e.g. input a dictionary: Dict(:dinve => "Investment growth"))
 - [x] implement benchmarks
 - [x] write non allocating version of steady state functions
 - [x] do SVD on matrices before solving first order. idea to solve in lower dimensional subspace. doesn't work as that is the whole point of the solution. what breaks is the X^2 as any transformation of X would have a term in the middle remaining