Merging

Merging

.github/workflows/deploy_docs.yml

@@ -25,10 +25,10 @@ jobs:
       - name: Setup Miniconda
         uses: conda-incubator/setup-miniconda@v3
         with:
-          miniforge-variant: Mambaforge
+          miniconda-version: "latest"
           activate-environment: ogzaf-dev
           environment-file: environment.yml
-          python-version: "3.11"
+          python-version: "3.12"
           auto-activate-base: false
 
       - name: Build # Build Jupyter Book

.github/workflows/docs_check.yml

@@ -23,10 +23,10 @@ jobs:
       - name: Setup Miniconda
         uses: conda-incubator/setup-miniconda@v3
         with:
-          miniforge-variant: Mambaforge
+          miniconda-version: "latest"
           activate-environment: ogzaf-dev
           environment-file: environment.yml
-          python-version: "3.11"
+          python-version: "3.12"
           auto-activate-base: false
 
       - name: Build # Build Jupyter Book

.github/workflows/publish_to_pypi.yml

@@ -16,11 +16,12 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.11"
+          python-version: "3.12"
       - name: Build package
         shell: bash -l {0}
         run: |
           pip install wheel
+          pip install setuptools
           python setup.py sdist bdist_wheel
       - name: Publish a Python distribution to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+## [0.0.5] - 2025-02-11 23:00:00
+
+### Added
+
+- Updated Python 3.12 in GH Actions
+- Replaced miniforge and mambaforge with miniconda and "latest" in `deploy_docs.yml` and `docs_check.yml`
+- Added `pip install setuptools` to `publish_to_pypi.yml` GH Action
+- Updated Python 3.11 and 3.12 in `README.md`
+- Update documentation with "UN Tutorial" section
+
+
 ## [0.0.4] - 2024-12-07 12:00:00
 
 ### Added
@@ -49,6 +61,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - This version is a pre-release alpha. The example run script OG-ZAF/examples/run_og_zaf.py runs, but the model is not currently calibrated to represent the South African economy and population.
 
 
+[0.0.5]: https://github.com/EAPD-DRB/OG-ZAF/compare/v0.0.4...v0.0.5
 [0.0.4]: https://github.com/EAPD-DRB/OG-ZAF/compare/v0.0.3...v0.0.4
 [0.0.3]: https://github.com/EAPD-DRB/OG-ZAF/compare/v0.0.2...v0.0.3
 [0.0.2]: https://github.com/EAPD-DRB/OG-ZAF/compare/v0.0.1...v0.0.2

PSL_catalog.json

@@ -3,18 +3,23 @@
     "img": "https://github.com/EAPD-DRB/OG-ZAF/blob/main/docs/OG-ZAF_logo.png?raw=true",
     "banner_title": "OG-ZAF",
     "banner_subtitle": "An overlapping-generations macroeconomic model for evaluating fiscal policy in South Africa",
-    "detailed_description": "OG-ZAF is an overlapping-generations (OG) model that allows for dynamic general equilibrium analysis of fiscal policy for South Africa. OG-ZAF is built on the OG-Core framework. The model output includes changes in macroeconomic aggregates (GDP, investment, consumption), wages, interest rates, and the stream of tax revenues over time. Regularly updated documentation of the model theory--its output, and solution method--and the Python API is available at https://pslmodels.github.io/OG-Core and documentation of the specific South African calibration of the model will be available soon.",
+    "detailed_description": "OG-ZAF is an overlapping-generations (OG) model that allows for dynamic general equilibrium analysis of fiscal policy for South Africa. OG-ZAF is built on the OG-Core framework. The model output includes changes in macroeconomic aggregates (GDP, investment, consumption), wages, interest rates, and the stream of tax revenues over time. Regularly updated documentation of the model theory--its output, and solution method--and the Python API is available at https://pslmodels.github.io/OG-Core and documentation of the specific South African calibration of the model https://eapd-drb.github.io/OG-ZAF.",
     "policy_area": "Fiscal policy, Macroeconomics, Demographics",
     "geography": "South Africa",
     "language": "Python",
     "maintainers": [
+        {
+            "name": "Jason DeBacker",
+            "image": "https://github.com/jdebacker.png",
+            "link": "https://github.com/jdebacker"
+        },
         {
             "name": "Richard W. Evans",
             "image": "https://github.com/rickecon.png",
             "link": "https://github.com/rickecon"
         },
         {
-            "name": "Marcel LaFleur",
+            "name": "Marcelo LaFleur",
             "image": "https://avatars.githubusercontent.com/u/231228?v=4",
             "link": "https://github.com/SeaCelo"
         }
@@ -26,4 +31,4 @@
       "webapp": "",
       "recent_changes": "https://github.com/EAPD-DRB/OG-ZAF/blob/main/CHANGELOG.md"
     }
-}
+}

README.md

@@ -3,10 +3,10 @@
 | | |
 | --- | --- |
 | Org | [![United Nations DESA](https://img.shields.io/badge/United%20Nations%20DESA-blue)](https://www.un.org/en/desa) [![PSL cataloged](https://img.shields.io/badge/PSL-cataloged-a0a0a0.svg)](https://www.PSLmodels.org) [![OS License: CC0-1.0](https://img.shields.io/badge/OS%20License-CC0%201.0-yellow)](https://github.com/EAPD-DRB/OG-ZAF/blob/main/LICENSE) |
-| Package | [![Python 3.10](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-31013/) [![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3116/) [![PyPI Latest Release](https://img.shields.io/pypi/v/ogzaf.svg)](https://pypi.org/project/ogzaf/) [![PyPI Downloads](https://img.shields.io/pypi/dm/ogzaf.svg?label=PyPI%20downloads)](https://pypi.org/project/ogzaf/) |
+| Package | [![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3116/) [![Python 3.12](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/downloads/release/python-3129/) [![PyPI Latest Release](https://img.shields.io/pypi/v/ogzaf.svg)](https://pypi.org/project/ogzaf/) [![PyPI Downloads](https://img.shields.io/pypi/dm/ogzaf.svg?label=PyPI%20downloads)](https://pypi.org/project/ogzaf/) |
 | Testing | ![example event parameter](https://github.com/EAPD-DRB/OG-ZAF/actions/workflows/build_and_test.yml/badge.svg?branch=main) ![example event parameter](https://github.com/EAPD-DRB/OG-ZAF/actions/workflows/deploy_docs.yml/badge.svg?branch=main) ![example event parameter](https://github.com/EAPD-DRB/OG-ZAF/actions/workflows/check_format.yml/badge.svg?branch=main) [![Codecov](https://codecov.io/gh/EAPD-DRB/OG-ZAF/branch/main/graph/badge.svg)](https://codecov.io/gh/EAPD-DRB/OG-ZAF) |
 
-OG-ZAF is an overlapping-generations (OG) model that allows for dynamic general equilibrium analysis of fiscal policy for South Africa. OG-ZAF is built on the OG-Core framework. The model output includes changes in macroeconomic aggregates (GDP, investment, consumption), wages, interest rates, and the stream of tax revenues over time. Regularly updated documentation of the model theory--its output, and solution method--and the Python API is available at https://pslmodels.github.io/OG-Core and documentation of the specific South African calibration of the model will be available soon.
+OG-ZAF is an overlapping-generations (OG) model that allows for dynamic general equilibrium analysis of fiscal policy for South Africa. OG-ZAF is built on the OG-Core framework. The model output includes changes in macroeconomic aggregates (GDP, investment, consumption), wages, interest rates, and the stream of tax revenues over time. Regularly updated documentation of the model theory--its output, and solution method--and the Python API is available at https://pslmodels.github.io/OG-Core and documentation of the specific South African calibration of the model is available at https://eapd-drb.github.io/OG-ZAF.
 
 
 ## Using and contributing to OG-ZAF
@@ -63,9 +63,9 @@ The organization of this repository will be changing rapidly, but the `OG-ZAF/ex
 The core maintainers of the OG-ZAF repository are:
 
 * Marcelo LaFleur (GitHub handle: [@SeaCelo](https://github.com/SeaCelo)), Senior Economist, Department of Economic and Social Affairs (DESA), United Nations
-* [Richard W. Evans](https://sites.google.com/site/rickecon/) (GitHub handle: [@rickecon](https://github.com/rickecon)), Senior Research Fellow and Director of Open Policy, Center for Growth and Opportunity at Utah State University; President, Open Research Group, Inc.
+* [Richard W. Evans](https://sites.google.com/site/rickecon/) (GitHub handle: [@rickecon](https://github.com/rickecon)), Senior Economist, Abundance Institute; President, Open Research Group, Inc.
 * [Jason DeBacker](https://jasondebacker.com) (GitHub handle: [@jdebacker](https://github.com/jdebacker)), Associate Professor, University of South Carolina; Vice President of Research, Open Research Group, Inc.
 
 ## Citing OG-ZAF
 
-OG-ZAF (Version #.#.#)[Source code], https://github.com/EAPD-DRB/OG-ZAF
+OG-ZAF (Version #.#.#)[Source code], https://github.com/EAPD-DRB/OG-ZAF.

docs/book/OGZAF_references.bib

@@ -266,6 +266,13 @@ @ARTICLE{DeBackerEtAl:2019
   pages = {207-275},
 }
 
+@BOOK{DeBackerEvans:2024,
+  AUTHOR = {Jason DeBacker and Richard W. Evans},
+  TITLE = {Overlapping Generations Models for Policy Analysis: Theory and Computation},
+  PUBLISHER = {unpublished},
+  YEAR = {2024},
+}
+
 @ARTICLE{DeNardi:2004,
   AUTHOR = {Mariacristina {De Nardi}},
   TITLE = {Wealth Inequality and Intergenerational Links},
@@ -767,4 +774,4 @@ @Article{PRS2020
   doi={},
   abstract={},
   url={https://econpapers.repec.org/scripts/redir.pf?u=https%3A%2F%2Fwww.resbank.co.za%2Fcontent%2Fdam%2Fsarb%2Fpublications%2Foccasional-bulletin-of-economic-notes%2F2020%2F10412%2FOBEN%25202002%2520%28Industry%2520TFP%2520estimates%2520for%2520South%2520Africa%29%2520-%2520November%25202020.pdf;h=repec:rbz:oboens:10412}
-}
+}

docs/book/_config.yml

@@ -1,16 +1,35 @@
-####################################################
+###############################################################################
 # Book settings
 title                    : OG-ZAF
 author                   : Marcelo LaFleur, Richard W. Evans, and Jason DeBacker
-copyright                : '2024'
+copyright                : '2025'
 logo                     : '..//OG-ZAF_logo.png'
 
-####################################################
+###############################################################################
 # Execution settings
 execute:
   execute_notebooks      : force
 
-####################################################
+###############################################################################
+# Parse and render settings
+parse:
+  myst_enable_extensions:  # default extensions to enable in the myst parser. See https://myst-parser.readthedocs.io/en/latest/using/syntax-optional.html
+    - amsmath
+    - colon_fence
+    # - deflist
+    - dollarmath
+    # - html_admonition
+    # - html_image
+    - linkify
+    # - replacements
+    # - smartquotes
+    - substitution
+    - tasklist
+    - html_image
+  myst_url_schemes: [mailto, http, https] # URI schemes that will be recognised as external URLs in Markdown links
+  myst_dmath_double_inline: true  # Allow display math ($$) within an inline context
+
+###############################################################################
 # HTML-specific settings
 html:
   # favicon                : "_static/logo/favicon.ico"  # generated at https://www.favicon.cc/
@@ -23,43 +42,48 @@ html:
   home_page_in_navbar    : true  # Whether to include your home page in the left Navigation Bar
   # baseurl                : ""  # The base URL where your book will be hosted. Used for creating image previews and social links. e.g.: https://mypage.com/mybook/
 
-####################################################
-# Launch button settings
-notebook_interface       : 'notebook'
+###############################################################################
+# LaTeX and BibTex settings
+latex:
+  latex_engine          : pdflatex  # one of 'pdflatex', 'xelatex' (recommended for unicode), 'luatex', 'platex', 'uplatex'
+  use_jupyterbook_latex : true  # use sphinx-jupyterbook-latex for pdf builds as default
 
-binder:
-  binderhub_url          : 'https://mybinder.org'
-  text                   : 'Launch binder'
+bibtex_bibfiles:
+  - OGZAF_references.bib
+  - citations.bib
 
+###############################################################################
+# Launch button settings
 launch_buttons:
   notebook_interface     : 'classic'  # The interface interactive links will activate ["classic", "jupyterlab"]
   # binderhub_url          : https://mybinder.org  # The URL of the BinderHub (e.g., https://mybinder.org)
   # jupyterhub_url         : ""  # The URL of the JupyterHub (e.g., https://datahub.berkeley.edu)
   # thebelab               : false  # Add a thebelab button to pages (requires the repository to run on Binder)
+  colab_url: "https://colab.research.google.com"  # The URL of Google Colab
 
-####################################################
+###############################################################################
 # Information about where the book exists on the web
 repository:
-  url                    : https://github.com/EAPD-DRB/OG-ZAF
-  path_to_book           : 'docs/book'
+  url: https://github.com/EAPD-DRB/OG-ZAF
+  branch: main
+  path_to_book: 'docs/book'
 
-#######################################################################################
-# Advanced and power-user settings
+###############################################################################
+# Advanced Sphinx settings
 sphinx:
-  extra_extensions          : ['sphinx.ext.autodoc', 'sphinx.ext.mathjax',
-                               'sphinx.ext.viewcode', 'sphinx.ext.napoleon',
-                               'alabaster']   # A list of extra extensions to load by Sphinx.
-  config                    :   # key-value pairs to directly over-ride the Sphinx configuration
+  config:  # key-value pairs to directly over-ride the Sphinx configuration
     bibtex_reference_style: author_year
-    mathjax_path          : https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
-    autodoc_preserve_defaults:  True
-
-####################################################
-# LaTeX information
-latex:
-  latex_engine           : 'xelatex'
-  latex_documents:
-    targetname           : book.tex
-bibtex_bibfiles:
-  - OGZAF_references.bib
-  - citations.bib
+    mathjax_path: https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
+    html_js_files:
+      - https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js
+    # html_theme: furo
+    pygments_style: default
+  extra_extensions:
+    - "sphinx.ext.autodoc"
+    - "sphinxarg.ext"
+    - "sphinx.ext.viewcode"
+    - "sphinx.ext.napoleon"
+    - "sphinx.ext.mathjax"
+    - "alabaster"
+    - "sphinx_exercise"
+    - "sphinx_proof"

docs/book/_toc.yml

@@ -18,6 +18,10 @@ parts:
   - file: content/calibration/UBI
   - file: content/calibration/matching_lwi
   - file: content/calibration/exogenous_parameters
+- caption: UN Tutorial
+  chapters:
+  - file: content/UNtutorial/getting_started
+  - file: content/UNtutorial/3perOG
 - caption: References
   chapters:
   - file: content/OGZAF_references