PolicyEngine Core
A fork of OpenFisca-Core that powers PolicyEngine country models (policyengine-uk, policyengine-us, policyengine-canada, policyengine-il, policyengine-ng) and the downstream apps and APIs. Provides the simulation engine, parameter tree, variable system, and reform machinery that each country package builds on top of.
Install
pip install policyengine-core
Supports Python 3.9 – 3.14.
Usage
Most users reach this package transitively through a country model. Import directly if you're building a new country model, writing a reform, or extending the core:
from policyengine_core.simulations import Simulation
from policyengine_core.reforms import Reform
See the documentation for API reference and tutorials.
Development
# Install dev dependencies (uses uv)
make install
# Run the full test suite
make test
# Run a single test
uv run pytest tests/core/test_file.py::test_name -v
# Format before committing (CI enforces)
make format
Always use uv run for Python commands; bare python / pytest / pip may pick up the wrong environment.
Contributions: see CONTRIBUTING.md for branching, PR conventions, and the towncrier changelog.d/ workflow. Default branch is master.
License
Distributed under the AGPL License. See LICENSE for details.
Acknowledgements
- Forked from OpenFisca-Core.
- README template adapted from Othneil Drew's Best-README-Template.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file policyengine_core-3.31.0.tar.gz.
File metadata
- Download URL: policyengine_core-3.31.0.tar.gz
- Upload date:
- Size: 503.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4e7811d9f1668cb198ee68a460d7383add3443db1f0e32d591dc92ed4e5b4319
|
|
| MD5 |
4b1f0abd99e9f5b84e61e0fc3b9b7f4f
|
|
| BLAKE2b-256 |
a25e227324f4c7b7fdce0e0eb0d6246afc6bb7d1fb2a61546f514fe698c20c29
|
File details
Details for the file policyengine_core-3.31.0-py3-none-any.whl.
File metadata
- Download URL: policyengine_core-3.31.0-py3-none-any.whl
- Upload date:
- Size: 245.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6537c2ecebd2a49a7a345dbe3d3d4f37fc3c3babc6bba1990a2eb99a9f55d67d
|
|
| MD5 |
601705916e4cf3c48751e89291204587
|
|
| BLAKE2b-256 |
fb75d30a9de4352d02e1c81135c7d7c1b64f6506af7cab3883d9a4d51c4599cb
|
