Split nu into xi_ss and xi_tpi - #1224
Open
arihantlodha-cmd wants to merge 1 commit into
Open
arihantlodha-cmd wants to merge 1 commit into
arihantlodha-cmd wants to merge 1 commit into
Conversation
Closes PSLmodels#1099. The single nu parameter set the convergence (dampening) rate of functional iteration for both the steady-state and transition-path solutions, but the documentation refers to two separate parameters, xi_ss and xi_tpi. This splits nu into those two parameters so the code matches the documentation and the two solutions can be damped independently. - default_parameters.json: replace nu with xi_ss and xi_tpi (both default 0.4, same range validators), with notation $\xi_{ss}$ and $\xi_{tpi}$. - SS.py: the SS outer loop now uses p.xi_ss. - TPI.py: the TPI outer loop now uses p.xi_tpi. - tests/testing_params.json and the parameters reference doc updated to match. Both new parameters default to nu's previous value, so default runs are unchanged (a baseline SS still solves to r = 0.0628). This is a breaking rename for any configuration or downstream model that sets nu directly; those should set xi_ss and xi_tpi instead.
jdebacker
approved these changes
Sep 26, 2026
Member
|
@arihantlodha-cmd Can you run |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1224 +/- ##
=======================================
Coverage 75.17% 75.17%
=======================================
Files 24 24
Lines 6031 6031
=======================================
Hits 4534 4534
Misses 1497 1497
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this does
Closes #1099. The single
nuparameter set the convergence (dampening) rate of functional iteration for both the steady-state and the transition-path solutions, but the documentation refers to two separate parameters,xi_ssandxi_tpi. This splitsnuinto those two so the code matches the docs and the two solutions can be damped independently.Changes
default_parameters.json: replacenuwithxi_ssandxi_tpi(both default 0.4, same range validators), notation$\xi_{ss}$and$\xi_{tpi}$.SS.py: the SS outer loop now usesp.xi_ss.TPI.py: the TPI outer loop now usesp.xi_tpi.tests/testing_params.jsonand the parameters reference doc updated to match.Behavior and compatibility
Both new parameters default to
nu's previous value (0.4), so default runs are unchanged: a baseline SS still solves to r = 0.0628, andtests/test_parameters.pypasses (16 passed).This is a breaking rename for any configuration or downstream model that sets
nudirectly; those should setxi_ssandxi_tpiinstead. Flagging in case a deprecation shim fornuis preferred over a hard rename, happy to add one.