Merge pull request #21 from rickecon/tutor

Merging
EAPD-DRB · Oct 20, 2024 · 9201542 · 9201542
2 parents 7c6a8ba + a1d36eb
commit 9201542
Show file tree

Hide file tree

Showing 11 changed files with 689 additions and 48 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,13 @@ 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.4] - 2024-10-20 22:00:00
+
+### Added
+
+- Added UN tutorial section to documentation
+- Updated some Sphinx packages in `environment.yml`
+
 ## [0.0.3] - 2024-08-11 12:00:00
 
 ### Added
@@ -21,4 +28,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
+[0.0.4]: https://github.com/EAPD-DRB/OG-PHL/compare/v0.0.3...v0.0.4
 [0.0.3]: https://github.com/EAPD-DRB/OG-PHL/compare/v0.0.0...v0.0.3
diff --git a/docs/book/OGPHL_references.bib b/docs/book/OGPHL_references.bib
@@ -40,7 +40,7 @@ @INCOLLECTION{AuerbachKotlikoff:1983a
   TITLE = {National Savings, Economic Welfare, and the Structure of Taxation},
   BOOKTITLE = {Behavioral Simulation Methods in Tax Policy Analysis},
   PUBLISHER = {University of Chicago Press},
-  YEAR = {1983},
+  YEAR = {1983a},
   editor = {Martin Feldstein},
   type = {National Bureau of Economic Research Project Report},
   chapter = {Chap. 13},
@@ -52,7 +52,7 @@ @INCOLLECTION{AuerbachKotlikoff:1983b
   TITLE = {Investment versus Savings Incentives: The Size of the Bang for the Buck and the Potential for Self-financing Business Tax Cuts},
   BOOKTITLE = {The Economic Consequences of Government Deficits},
   PUBLISHER = {Kluwer-Nijhoff Publishing},
-  YEAR = {1983},
+  YEAR = {1983b},
   editor = {Lawrence. H. Meyer},
   series = {Economic Policy Conference Series},
   type = {Center for the Study of American Business},
@@ -65,7 +65,7 @@ @INCOLLECTION{AuerbachKotlikoff:1983c
   TITLE = {An Examination of Empirical Tests of Social Security and Savings},
   BOOKTITLE = {Social Policy Evaluation: An Economic Perspective},
   PUBLISHER = {Academic Press},
-  YEAR = {1983},
+  YEAR = {1983c},
   editor = {Elhanan Helpman and Assaf Razin and Efraim Sadka},
   chapter = {Chap. 8},
   pages = {pp. 161-179},
@@ -231,6 +231,13 @@ @BOOK{DavidsonMacKinnon:2004
   YEAR = {2004},
 }
 
+@BOOK{DeBackerEvans:2024,
+  AUTHOR = {Jason DeBacker and Richard W. Evans},
+  TITLE = {Overlapping Generations Models for Policy Analysis: Theory and Computation},
+  PUBLISHER = {unpublished},
+  YEAR = {2024},
+}
+
 @TECHREPORT{DeBackerRamnath:2017,
   Author = {Jason DeBacker and Shanthi Ramnath},
   Institution = {Mimeo},
@@ -279,18 +286,6 @@ @ARTICLE{DeNardiYang:2014
   month = {November},
 }
 
-@InBook{ZodrowDiamond:2013,
-  author={George R. Zodrow and John W. Diamond},
-  title={{Dynamic Overlapping Generations Computable General Equilibrium Models and the Analysis of Tax Policy: The Diamond-Zodrow Model}},
-  publisher={Elsevier},
-  year={2013},
-  month={December},
-  volume={1},
-  series={Handbook of Computable General Equilibrium Modeling},
-  chapter={0},
-  pages={743-813},
-}
-
 @ARTICLE{EvansPhillips:2014,
   AUTHOR = {Richard W. Evans and Kerk L. Phillips},
   TITLE = {OLG Life Cycle Model Transition Paths: Alternate Model Forecast Method},
@@ -730,3 +725,15 @@ @ARTICLE{Zhang:1997
   month = {December},
   pages = {2187-2209},
 }
+
+@InBook{ZodrowDiamond:2013,
+  author={George R. Zodrow and John W. Diamond},
+  title={{Dynamic Overlapping Generations Computable General Equilibrium Models and the Analysis of Tax Policy: The Diamond-Zodrow Model}},
+  publisher={Elsevier},
+  year={2013},
+  month={December},
+  volume={1},
+  series={Handbook of Computable General Equilibrium Modeling},
+  chapter={0},
+  pages={743-813},
+}
diff --git a/docs/book/_config.yml b/docs/book/_config.yml
@@ -10,6 +10,25 @@ logo                     : '..//OG-PHL_logo.png'
 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:
@@ -23,43 +42,47 @@ 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/
 
+#######################################################################################
+# 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
+
+bibtex_bibfiles:
+  - OGPHL_references.bib
+  - citations.bib
 ####################################################
 # Launch button settings
-notebook_interface       : 'notebook'
-
-binder:
-  binderhub_url          : 'https://mybinder.org'
-  text                   : 'Launch binder'
-
 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-PHL
-  path_to_book           : 'docs/book'
+  url: https://github.com/EAPD-DRB/OG-PHL
+  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:
-  - OGPHL_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"
diff --git a/docs/book/_toc.yml b/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/OGPHL_references