PSLmodels / OG-Core

An overlapping generations model framework for evaluating fiscal policies.
https://pslmodels.github.io/OG-Core/
Creative Commons Zero v1.0 Universal
68 stars 119 forks source link

UBI and `alpha_I` parameter updates #966

Closed jdebacker closed 3 months ago

jdebacker commented 3 months ago

This PR does the following:

  1. Updates the range for the nominal UBI parameters. These were not well defined for using nominal values in different currencies. Also, negative values may be useful if one wanted to simulate a head tax.
  2. Adds a description of the $\alpha_I$ parameter
  3. Updates parameters.py to extrapolate the alpha_I parameter
  4. Ensures that alpha_I dimensions conform in time path calculations of I_g
codecov-commenter commented 3 months ago

Codecov Report

Attention: Patch coverage is 33.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 71.08%. Comparing base (e120ea6) to head (f96b391). Report is 10 commits behind head on master.

Files Patch % Lines
ogcore/TPI.py 0.00% 2 Missing :warning:
Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/966/graphs/tree.svg?width=650&height=150&src=pr&token=98mQCVhspd&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels)](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/966?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels) ```diff @@ Coverage Diff @@ ## master #966 +/- ## ======================================= Coverage 71.08% 71.08% ======================================= Files 20 20 Lines 4977 4977 ======================================= Hits 3538 3538 Misses 1439 1439 ``` | [Flag](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/966/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/966/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels) | `71.08% <33.33%> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/966?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels) | Coverage Δ | | |---|---|---| | [ogcore/\_\_init\_\_.py](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/966?src=pr&el=tree&filepath=ogcore%2F__init__.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels#diff-b2djb3JlL19faW5pdF9fLnB5) | `100.00% <100.00%> (ø)` | | | [ogcore/parameters.py](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/966?src=pr&el=tree&filepath=ogcore%2Fparameters.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels#diff-b2djb3JlL3BhcmFtZXRlcnMucHk=) | `82.91% <ø> (ø)` | | | [ogcore/TPI.py](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/966?src=pr&el=tree&filepath=ogcore%2FTPI.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels#diff-b2djb3JlL1RQSS5weQ==) | `35.82% <0.00%> (ø)` | |
jdebacker commented 3 months ago

@rickecon This PR is ready to review.

rickecon commented 3 months ago

@jdebacker. You will want to update this branch with the main branch as the current version is 0.11.16. So you should update this version to 0.11.17.

rickecon commented 3 months ago

@jdebacker. This is ready to merge as soon as you update the versions (and update your branch with the main).

jdebacker commented 3 months ago

@rickecon Thanks for noting the more recent version. I synced to master and bumped the version numbers. Let me know if this looks good to you. If so, it's ready to merge.

rickecon commented 3 months ago

@jdebacker. There are still some issues with the version number in CHANGELOG.md, setup.py, and __init__.py. Give me a call today if you want to talk through those.

jdebacker commented 3 months ago

@rickecon I think I missed committing some changes before. I've now done that and fixed a couple typos. Let me know if we need anything else here.

rickecon commented 3 months ago

@jdebacker. Looks great. Merging now.