Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,17 @@
PolicyEngine US is a microsimulation model of the US state and federal tax and benefit system.

To install, run `pip install policyengine-us`.

## System requirements

PolicyEngine-US loads the full US tax-benefit system on import, which requires significant memory. Based on [empirical testing](https://gist.github.com/MaxGhenis/253efeb07f4bfa8b50af768accf73c9d):

| Use case | RAM (minimum) | RAM (recommended) | Typical usage |
| --- | --- | --- | --- |
| Household calculations | 8 GB | 16 GB | ~500 MB |
| Microsimulation (CPS data) | 16 GB | 24-32 GB | 2-4 GB |

Key details:
- Importing the package loads the tax-benefit system, using ~400 MB
- Memory scales linearly with multiple simultaneous simulations
- CPS dataset operations may spike memory during calculations
4 changes: 4 additions & 0 deletions changelog_entry.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
- bump: patch
changes:
added:
- Add system requirements section to README documenting memory needs for household calculations and microsimulation.