| Org | |
| Package | |
| Testing |
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 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 United States calibration of the model is available at https://pslmodels.github.io/OG-USA.
The model is constantly under development, and model components could change significantly. The package will have released versions, which will be checked against existing code prior to release. Stay tuned for an upcoming release!
- Install the Anaconda distribution of Python
- Clone this repository to a directory on your computer
- From the terminal (or Conda command prompt), navigate to the directory to which you cloned this repository and run
conda env create -f environment.yml. The process of creating theogusa-devconda environment can take more than 20 minutes. The pip install of theOG-Coredependency from GitHub takes most of the time. - Then,
conda activate ogusa-dev - Then install by
pip install -e . - Navigate to
./examples - Run the model with an example reform from terminal/command prompt by typing
python run_ogusa.py - You can adjust the
./examples/run_ogusa.pyby modifying model parameters specified in the dictionary passed to thep.update_specifications()calls. - Model outputs will be saved in the following files:
./examples/Example/: This folder will contain all of the output from therun_ogusa.pyrun script../examples/Example/example_plots_tables: This folder will contain a number of plots and tables generated from therun_ogusa.pyrun script to help you visualize the output../examples/Example/example_output.csv: This is a summary of the percentage changes in macro variables over the first ten years and in the steady-state.
./examples/Example/OUTPUT_BASELINE/: This folder contains all of the inputs to and outputs from the baseline equilibrium computation fromrun_ogusa.py./examples/Example/OUTPUT_BASELINE/model_params.pkl: Pickle binary file of ParamTools object of model parameters used in the baseline run./examples/Example/OUTPUT_BASELINE/SS/SS_vars.pkl: Pickle binary file of Python dictionary of outputs from the model steady state solution under the baseline policy. Seeogcore.SS.pyfor what is in the dictionary object in this pickle file./examples/Example/OUTPUT_BASELINE/TPI/TPI_vars.pkl: Pickle binary file of Python dictionary of outputs from the model timepath solution under the baseline policy. Seeogcore.TPI.pyfor what is in the dictionary object in this pickle file
- An analogous set of files in the
./examples/OUTPUT_REFORMdirectory, which represent objects from the simulation of the reform policy.
Note that, depending on your machine, a full model run (solving for the full time path equilibrium for the baseline and reform policies) can take more than two hours of compute time.
If you run into errors running the example script, please open a new issue in the OG-USA repo with a description of the issue and any relevant tracebacks you receive.
Once the package is installed, one can adjust parameters in the OG-Core Specifications object using the Calibration class as follows:
from ogcore.parameters import Specifications
from ogusa.calibrate import Calibration
p = Specifications()
c = Calibration(p)
updated_params = c.get_dict()
p.update_specifications({'initial_debt_ratio': updated_params['initial_debt_ratio']})
The core maintainers of the OG-Core repository are:
- Jason DeBacker (GitHub handle: jdebacker), Associate Professor, Department of Economics, Darla Moore School of Business, University of South Carolina; President, PSL Foundation; Vice President of Research and Co-founder, Open Research Group, Inc.
- Richard W. Evans (GitHub handle: rickecon), Senior Economist, Abundance Institute; President, Open Research Group, Inc.; Director, Open Source Economics Laboratory.
OG-USA (Version #.#.#)[Source code], https://github.com/PSLmodels/OG-USA.