search

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

Documentation of model parameters #963

Closed jdebacker closed 3 months ago

jdebacker commented 3 months ago

This PR adds utilities to generate a chapter of the OG-Core documentation that describes each model parameter using metadata from default_parameters.py. Github Actions are updated to ensure this page is regenerated and compiled with the documentation at each PR.

View of the new chapter:

Screenshot 2024-08-08 at 12 09 37 PM
jdebacker commented 3 months ago

Relates to Issue #954

jdebacker commented 3 months ago

Also addes rst file for pension model API, addressing Issue #953

codecov-commenter commented 3 months ago

Codecov Report

Attention: Patch coverage is 10.52632% with 17 lines in your changes missing coverage. Please review.

Project coverage is 71.07%. Comparing base (e799452) to head (2f66a35). Report is 2 commits behind head on master.

Files Patch % Lines
ogcore/utils.py 10.52% 17 Missing :warning:
Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/963/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/963?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels) ```diff @@ Coverage Diff @@ ## master #963 +/- ## ========================================== - Coverage 71.31% 71.07% -0.24% ========================================== Files 20 20 Lines 4953 4972 +19 ========================================== + Hits 3532 3534 +2 - Misses 1421 1438 +17 ``` | [Flag](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/963/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/963/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels) | `71.07% <10.52%> (-0.24%)` | :arrow_down: | 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/963?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels) | Coverage Δ | | |---|---|---| | [ogcore/utils.py](https://app.codecov.io/gh/PSLmodels/OG-Core/pull/963?src=pr&el=tree&filepath=ogcore%2Futils.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=PSLmodels#diff-b2djb3JlL3V0aWxzLnB5) | `84.13% <10.52%> (-3.05%)` | :arrow_down: |
rickecon commented 3 months ago

@jdebacker. This is such a cool addition to the documentation. Merging.