diff --git a/CHANGELOG.md b/CHANGELOG.md index d8acdda0..359bf0df 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,19 @@ 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.1.3] - 2024-02-12 15:00:00 + +### Added + +- Restricts Python version in `environment.yml` and `setup.py` to be <3.12 +- Updates the Jupyter Book copyright to 2024 in `_config.yml` +- Updates the pandas_datareader quarterly calls in `macro_params.py` to be "QE" instead of just "Q" +- Adds Jupyter Book and Black tags to `README.md` and `intro.md` +- Adds back Windows tests to `build_and_test.yml` +- PR #84 fixed some formatting +- PR #85 updated the way the dask client is set in `run_og_usa.py` script +- PR #86 moved `demographics.py` out of OG-USA and into OG-Core + ## [0.1.2] - 2023-10-26 15:00:00 ### Added @@ -47,5 +60,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 +[0.1.3]: https://github.com/PSLmodels/OG-USA/compare/v0.1.2...v0.1.3 [0.1.2]: https://github.com/PSLmodels/OG-USA/compare/v0.1.1...v0.1.2 [0.1.1]: https://github.com/PSLmodels/OG-USA/compare/v0.1.0...v0.1.1 diff --git a/README.md b/README.md index 10a73766..efc23181 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ | | | | --- | --- | -| Org | [![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/PSLmodels/OG-USA/blob/master/LICENSE) | -| Package | [![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-3917/) [![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/ogusa.svg)](https://pypi.org/project/ogusa/) [![PyPI Downloads](https://img.shields.io/pypi/dm/ogusa.svg?label=PyPI%20downloads)](https://pypi.org/project/fiscalsim-us/) | +| Org | [![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/PSLmodels/OG-USA/blob/master/LICENSE) [![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://pslmodels.github.io/OG-Core/) | +| Package | [![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-3917/) [![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/ogusa.svg)](https://pypi.org/project/ogusa/) [![PyPI Downloads](https://img.shields.io/pypi/dm/ogusa.svg?label=PyPI%20downloads)](https://pypi.org/project/fiscalsim-us/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) | | Testing | ![example event parameter](https://github.com/PSLmodels/OG-USA/actions/workflows/build_and_test.yml/badge.svg?branch=master) ![example event parameter](https://github.com/PSLmodels/OG-USA/actions/workflows/deploy_docs.yml/badge.svg?branch=master) ![example event parameter](https://github.com/PSLmodels/OG-USA/actions/workflows/check_format.yml/badge.svg?branch=master) [![Codecov](https://codecov.io/gh/PSLmodels/OG-USA/branch/master/graph/badge.svg)](https://codecov.io/gh/PSLmodels/OG-USA) | OG-USA is an overlapping-generations (OG) model that allows for dynamic general equilibrium analysis of fiscal policy for the United States. OG-USA is built on the [OG-Core](https://github.com/PSLmodels/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](https://pslmodels.github.io/OG-Core) and documentation of the specific United States calibration of the model is available at [https://pslmodels.github.io/OG-USA](https://pslmodels.github.io/OG-USA). diff --git a/docs/book/_config.yml b/docs/book/_config.yml index b3a7de4d..bd3c840a 100644 --- a/docs/book/_config.yml +++ b/docs/book/_config.yml @@ -2,7 +2,7 @@ # Book settings title : OG-USA author : Jason DeBacker and Richard W. Evans -copyright : '2022' +copyright : '2024' logo : '..//OG-USA_logo.png' #################################################### diff --git a/docs/book/content/api/demographics.rst b/docs/book/content/api/demographics.rst deleted file mode 100644 index 6daa40bb..00000000 --- a/docs/book/content/api/demographics.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _demographics: - -Demographics Functions -======================== - -**demographics.py modules** - -ogusa.demographics ------------------------------------------- - -.. automodule:: ogusa.demographics - :members: get_fert, get_mort, pop_rebin, get_imm_resid, immsolve, - get_pop_objs diff --git a/docs/book/content/api/public_api.rst b/docs/book/content/api/public_api.rst index bf7023e2..47593621 100644 --- a/docs/book/content/api/public_api.rst +++ b/docs/book/content/api/public_api.rst @@ -13,7 +13,6 @@ There is also a link to the source code for each documented member. bequest_transmission calibrate - demographics deterministic_profiles estimate_beta_j get_micro_data diff --git a/docs/book/content/intro/intro.md b/docs/book/content/intro/intro.md index dfc0d6b1..354745ea 100644 --- a/docs/book/content/intro/intro.md +++ b/docs/book/content/intro/intro.md @@ -1,6 +1,12 @@ (Chap_Intro)= # OG-USA +| | | +| --- | --- | +| Org | [![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/PSLmodels/OG-USA/blob/master/LICENSE) [![Jupyter Book Badge](https://jupyterbook.org/badge.svg)](https://pslmodels.github.io/OG-Core/) | +| Package | [![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-3917/) [![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/ogusa.svg)](https://pypi.org/project/ogusa/) [![PyPI Downloads](https://img.shields.io/pypi/dm/ogusa.svg?label=PyPI%20downloads)](https://pypi.org/project/fiscalsim-us/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) | +| Testing | ![example event parameter](https://github.com/PSLmodels/OG-USA/actions/workflows/build_and_test.yml/badge.svg?branch=master) ![example event parameter](https://github.com/PSLmodels/OG-USA/actions/workflows/deploy_docs.yml/badge.svg?branch=master) ![example event parameter](https://github.com/PSLmodels/OG-USA/actions/workflows/check_format.yml/badge.svg?branch=master) [![Codecov](https://codecov.io/gh/PSLmodels/OG-USA/branch/master/graph/badge.svg)](https://codecov.io/gh/PSLmodels/OG-USA) | + `OG-USA` is a package that provides code and data to calibrate an overlapping-generations (OG) model to the economy of the United States (USA). `OG-USA` uses as a dependency the [`OG-Core`](https://pslmodels.github.io/OG-Core/) package, which contains the core theory and logic of a general OG model. The `OG-USA` calibration package and the `OG-Core` theory and logic make the model that allows for dynamic general equilibrium analysis of federal fiscal policy in the United States. The model output focuses on changes in macroeconomic aggregates (GDP, investment, consumption), wages, interest rates, and the stream of tax revenues over time. This documentation of the `OG-USA` package contains the following major sections, which are regularly updated. * Contributing to `OG-USA` diff --git a/environment.yml b/environment.yml index 004feaee..e22052f1 100644 --- a/environment.yml +++ b/environment.yml @@ -2,7 +2,7 @@ name: ogusa-dev channels: - conda-forge dependencies: -- python>=3.7.7 +- python>=3.7.7,<3.12 - numpy - numba>=0.54 - scipy>=1.5.0 @@ -26,7 +26,7 @@ dependencies: - statsmodels - linearmodels - rpy2<=3.5.11 -- black +- black>=24.1.1 - pip: - jupyter-book>=0.9.1 - openpyxl>=3.1.2 diff --git a/ogusa/macro_params.py b/ogusa/macro_params.py index 6ee1b4d7..ada35a76 100644 --- a/ogusa/macro_params.py +++ b/ogusa/macro_params.py @@ -61,7 +61,7 @@ def get_macro_params(): "GDP Per Capita", ] ] - .resample("Q") + .resample("QE") .mean() ) fred_data_a = fred_data[["Labor share"]] @@ -107,7 +107,7 @@ def get_macro_params(): # find g_y macro_parameters["g_y"] = ( - fred_data_q["GDP Per Capita"].pct_change(periods=4, freq="Q").mean() + fred_data_q["GDP Per Capita"].pct_change(periods=4, freq="QE").mean() ) # # estimate r_gov_shift and r_gov_scale diff --git a/setup.py b/setup.py index c575886d..74d40184 100644 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ setup( name="ogusa", - version="0.1.2", + version="0.1.3", author="Jason DeBacker and Richard W. Evans", license="CC0 1.0 Universal (CC0 1.0) Public Domain Dedication", description="USA calibration for OG-Core", @@ -35,7 +35,7 @@ packages=["ogusa"], package_data={"ogusa": ["ogusa_default_parameters.json", "data/PSID/*"]}, include_packages=True, - python_requires=">=3.7.7", + python_requires=">=3.7.7, <3.12", install_requires=[ "numpy", "psutil",