Dynamic Tax Scoring Model
Python Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
conda.recipe
documentation
dynamic
ogusa
regression
regression_jenkins
run_examples
test_data
.gitattributes
.gitignore
.jenkins_wrapper.sh
.regression.txt
.travis.yml
Jenkinsfile
LICENSE.md
MANIFEST.in
README.md
TxFuncEst_baseline.pkl
TxFuncEst_policy.pkl
environment.yml
setup.cfg
setup.py
ss_outputs.pkl
upload.sh
version_and_release.sh
versioneer.py

README.md

OG-USA

OG-USA is an overlapping-generations (OG) model of the economy of the United States (USA) that allows for dynamic general equilibrium analysis of federal tax policy. The model output focuses changes in macroeconomic aggregates (GDP, investment, consumption), wages, interest rates, and the stream of tax revenues over time. Careful documentation of the model--its output, and solution method--is available here and is regularly updated.

Disclaimer

The model is currently under development. Users should be forewarned that the model components could change significantly. Therefore, there is NO GUARANTEE OF ACCURACY. THE CODE SHOULD NOT CURRENTLY BE USED FOR PUBLICATIONS, JOURNAL ARTICLES, OR RESEARCH PURPOSES. Essentially, you should assume the calculations are unreliable until we finish the code re-architecture and have checked the results against other existing implementations of the tax code. The package will have released versions, which will be checked against existing code prior to release. Stay tuned for an upcoming release!

Using/contributing to OG-USA

  • 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
  • Then, source activate ospcdyn (on Mac/Linux) or conda activate ospcdyn on Windows.
  • Then install by python setup.py install (use python setup.py develop if you would like to modifty the code base and run the updated model)
  • Navigate to ./run_examples
  • Run the model with an example reform from terminal/command prompt by typing python run_ogusa_example.py
  • You can adjust the ./run_examples/run_ogusa_example.py by adjusting the individual income tax reform (using a dictionary or JSON file in a format that is consistent with Tax Calculator) or other model parameters specified in the user_params or kwargs dictionaries.
  • Model outputs will be saved in the following files:
    • ./run_examples/OUTPUT_BASELINE/model_params.pkl
      • Model parameters used in the baseline run
      • See execute.py for items in the dictionary object in this pickle file
    • ./run_examples/OUTPUT_BASELINE/TxFuncEst_baseline_'guid'.pkl
      • Tax function parameters used for the baseline model run
      • See txfunc.py for what is in the dictionary object in this pickle file
    • ./run_examples/OUTPUT_BASELINE/SS/SS_vars.pkl
      • Outputs from the model steady state solution under the baseline policy
      • See SS.py for what is in the dictionary object in this pickle file
    • ./run_examples/OUTPUT_BASELINE/TPI/TPI_vars.pkl
      • Outputs from the model timepath solution under the baseline policy
      • See SS.py for what is in the dictionary object in this pickle file
    • An analogous set of files in the ./run_examples/OUTPUT_REFORM directory, 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 from a few to several 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.

Citing OG-USA

OG-USA (Version 0.5.7)[Source code], https://github.com/open-source-economics/OG-USA