Skip to main content

Philippines Calibration for OG-Core

Project description

OG-PHL

Org United Nations DESA PSL cataloged OS License: CC0-1.0
Package Python 3.10 Python 3.11 PyPI Latest Release PyPI Downloads
Testing example event parameter example event parameter example event parameter Codecov

OG-PHL is an overlapping-generations (OG) model that allows for dynamic general equilibrium analysis of fiscal policy for the Philippines. OG-PHL 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 Philippines calibration of the model will be available soon.

Using and contributing to OG-PHL

  • If you are installing on a Mac computer, install XCode Tools. In Terminal: xcode-select —install
  • Download and install the appropriate Anaconda distribution of Python. Select the correct version for you platform (Windows, Intel Mac, or M1 Mac).
  • In Terminal:
    • Make sure the conda package manager is up-to-date: conda update conda.
    • Make sure the Anaconda distribution of Python is up-to-date: conda update anaconda.
  • Fork this repository and clone your fork of this repository to a directory on your computer.
  • From the terminal (or Anaconda command prompt), navigate to the directory to which you cloned this repository and run conda env create -f environment.yml. The process of creating the ogphl-dev conda environment should not take more than five minutes.
  • Then, conda activate ogphl-dev
  • Then install by pip install -e .

Run an example of the model

  • Navigate to ./examples
  • Run the model with an example reform from terminal/command prompt by typing python run_og_zaf.py
  • You can adjust the ./examples/run_og_zaf.py by modifying model parameters specified in the dictionary passed to the p.update_specifications() calls.
  • Model outputs will be saved in the following files:
    • ./examples/OG-PHL_example_plots
      • This folder will contain a number of plots generated from OG-Core to help you visualize the output from your run
    • ./examples/ogphl_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/OG-PHL-Example/OUTPUT_BASELINE/model_params.pkl
      • Model parameters used in the baseline run
      • See ogcore.execute.py for items in the dictionary object in this pickle file
    • ./examples/OG-PHL-Example/OUTPUT_BASELINE/SS/SS_vars.pkl
      • Outputs from the model steady state solution under the baseline policy
      • See ogcore.SS.py for what is in the dictionary object in this pickle file
    • ./examples/OG-PHL-Example/OUTPUT_BASELINE/TPI/TPI_vars.pkl
      • Outputs from the model timepath solution under the baseline policy
      • See ogcore.TPI.py for what is in the dictionary object in this pickle file
    • An analogous set of files in the ./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 35 minutes to more than two hours of compute time.

If you run into errors running the example script, please open a new issue in the OG-PHL 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 ogphl.calibrate import Calibration
p = Specifications()
c = Calibration(p)
updated_params = c.get_dict()
p.update_specifications({'initial_debt_ratio': updated_params['initial_debt_ratio']})

Disclaimer

The organization of this repository will be changing rapidly, but the OG-PHL/examples/run_og_zaf.py script will be kept up to date to run with the master branch of this repo.

Core Maintainers

The core maintainers of the OG-PHL repository are:

  • Marcelo LaFleur (GitHub handle: @SeaCelo), Senior Economist, Department of Economic and Social Affairs (DESA), United Nations
  • Richard W. Evans (GitHub handle: @rickecon), Senior Research Fellow and Director of Open Policy, Center for Growth and Opportunity at Utah State University; President, Open Research Group, Inc.
  • Jason DeBacker (GitHub handle: @jdebacker), Associate Professor, University of South Carolina; Vice President of Research, Open Research Group, Inc.

Citing OG-PHL

OG-PHL (Version #.#.#)[Source code], https://github.com/EAPD-DRB/OG-PHL

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ogphl-0.0.5.tar.gz (157.1 kB view details)

Uploaded Source

Built Distribution

ogphl-0.0.5-py3-none-any.whl (164.1 kB view details)

Uploaded Python 3

File details

Details for the file ogphl-0.0.5.tar.gz.

File metadata

  • Download URL: ogphl-0.0.5.tar.gz
  • Upload date:
  • Size: 157.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for ogphl-0.0.5.tar.gz
Algorithm Hash digest
SHA256 c384cdf8433918ba11d5136dbeb2b6d19f2cd7fb832507b42de715844bb62960
MD5 001b4559f4ac5b2c04415f1cf9f96ebf
BLAKE2b-256 854ec9c391f73dca935bda02c2bdf805bb7bbebbc3a2c4b427a227f321eb7190

See more details on using hashes here.

File details

Details for the file ogphl-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: ogphl-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 164.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for ogphl-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 f7d8fc0846141e70892b3308e1bbcf2445b3197f71f4a284f94237f087e99a1c
MD5 f45e35565536b8bb6ef917677d7f0235
BLAKE2b-256 ecdc8d06868a7bc0e4f5e8802beff80fa9eb97334b9fb1ff2713b1d8f8233f32

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page