[DMP 2024]: Unified `policyengine` Python package

[MaxGhenis]

Description

We are looking to develop a Python package called policyengine that will serve as a unified interface for our country-specific policy simulation packages (e.g., policyengine_us, policyengine_uk). This package will provide a consistent API for users to perform policy simulations, conduct analyses, and generate visualizations across different countries. The package will include two main simulation classes: Microsimulation for running simulations on microdata and IndividualSim for calculating outcomes for a single household. Additionally, the package will offer analytics and charting functionality to facilitate cross-country comparisons and visualizations. A key feature of the package will be the ability to reproduce charts and visualizations from the PolicyEngine web interface, enabling users to generate insightful visual representations of simulation results programmatically.

Goals

• Design a modular and extensible architecture for the policyengine package.

• Implement the Microsimulation and IndividualSim classes for policy simulations.

• Develop analytics and charting modules for cross-country analyses and visualizations.

• Enable users to reproduce charts from the PolicyEngine web interface, including:

  • Budgetary breakdowns
  • Charts by income decile
  • Poverty breakdowns by demographic groups
  • Income inequality impacts for microsimulations
  • Net income, marginal tax rates, and other variables with respect to earnings for individual households (under baseline and reform law)
  • Evolution of policy parameters' values

• Utilize Plotly for interactive and visually appealing charts.

• Provide a user-friendly API for configuring and running simulations, including setting default countries.

• Create comprehensive documentation, including tutorials and examples, to guide users in using the package effectively.

• Goals Achieved By Mid-point Milestone: Completion of the core architecture, implementation of the Microsimulation and IndividualSim classes, and basic charting functionality.

Setup/Installation

The policyengine package will be hosted on GitHub and can be installed via pip:

pip install policyengine

Detailed installation instructions and dependencies will be provided in the package's README file.

Expected Outcome

The final product will be a well-documented and user-friendly Python package that enables users to perform policy simulations, conduct analyses, and generate visualizations across different countries. The package will provide a consistent interface for users to interact with our country-specific policy simulation packages, streamlining the process of cross-country comparisons and policy evaluation. Users will be able to reproduce a wide range of charts and visualizations from the PolicyEngine web interface programmatically, facilitating in-depth analysis and customization of visual representations.

Acceptance Criteria

• The policyengine package is available on GitHub and can be installed via pip.

• The package provides the Microsimulation and IndividualSim classes for policy simulations.

• Users can easily configure and run simulations, including setting default countries.

• The package includes analytics and charting modules for cross-country analyses and visualizations.

• Users can reproduce charts from the PolicyEngine web interface, including budgetary breakdowns, charts by income decile, poverty breakdowns by demographic groups, income inequality impacts for microsimulations, net income and marginal tax rates for individual households, and evolution of policy parameters' values.

• Plotly is used for creating interactive and visually appealing charts.

• Comprehensive documentation, including tutorials and examples, is available to guide users in using the package effectively.

Implementation Details

• The policyengine package will be developed in Python, leveraging existing country-specific packages (e.g., policyengine_us, policyengine_uk).

• The package will follow a modular architecture, with separate modules for simulations, analytics, charting, and configuration.

• The Microsimulation and IndividualSim classes will be implemented to provide a consistent interface for policy simulations across different countries.

• The package will utilize Plotly for creating interactive and customizable charts and visualizations.

• Chart reproduction functionality will be implemented to enable users to generate charts similar to those in the PolicyEngine web interface.

• Continuous Integration and Continuous Deployment (CI/CD) practices will be followed to ensure code quality and automated testing.

Mockups/Wireframes

(Mockups and wireframes will be linked here when ready.)

Product Name

PolicyEngine

Organisation Name

PolicyEngine

Domain

• Policy Simulation

• Economic Modeling

• Data Analysis

• Data Visualization

Tech Skills Needed

• Python

• Data Analysis (pandas)

• Data Visualization (Plotly)

• Package Development

• Documentation

• Testing

• CI/CD

Mentor(s)

@nikhilwoodruff, co-founder and CTO @anth-volk, software engineer and developer community manager

Category

• Data Science

• Economic Modeling

• Package Development

• Documentation

• Testing

• Data Visualization

Related Issues

• Development of R and Stata wrappers for the policyengine package.
• Exploration of compiling the package to WebAssembly for improved performance in web-based applications.

[masterismail]

Hey @MaxGhenis! I'm super interested in this project! I've been building APIs and AI models for a while now, and this sounds like a great fit.

Is there a recommended way to chat with the mentors? I'd love to discuss how I can jump in and help out with this policyengine package.

Thanks!

[nikhilwoodruff]

Weekly goals

Week 1

• [x] Add initial workflow files and set up repo for the package

Week 2

• [x] Plan out structure of interface, with sketches of examples

Week 3

• [x] Clean up code quality
• [x] Fix GH action deployment

Week 4

• [x] Add basic Pytest test Inequality metrics asserting that we match the PolicyEngine numbers (passing)
• [x] Add logic and tests (same as above) for all 6 poverty metrics

Week 5

• [x] Finish six poverty metrics
• [x] Add budgetary impact metrics
• [x] Tests for those

Week 6

• [x] Finish vast majority of outstanding metrics
• [x] Add tests for any metrics added

Week 7

• [x] Finish remaining metrics in https://github.com/PolicyEngine/policyengine.py/issues/11
• [x] Add tests and documentation for all remaining metrics

[masterismail]

Weekly Learnings

Week 1

• [x] This week, I learned about Pytest and GitHub workflows, as well as GitHub Actions.

Week 2

• [x] This week, I focused on improving my skills in two key areas, code management and pytest.

Week 3

• [x] learned about gh actions in detail

Week 4

• [x] learned in depth about pytests

Week 5

• [x] learned about getting data from api

Week 6

• [x] focused on managing large amounts of code efficiently

Week 7

• [x] learnt more about plotly and it's usage.

[nikhilwoodruff]

Closing since the program is now ended.