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.11–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
# Lint GitHub Actions workflows after editing .github/, from the repo root
# (CI enforces; install shellcheck and pyflakes so actionlint also checks
# run: scripts)
uvx --from actionlint-py==1.7.12.25 actionlint
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.
Metadata
Release files for policyengine-core 3.32.29
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| policyengine_core-3.32.29.tar.gz | 617.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| policyengine_core-3.32.29-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 899.2 kB
Release files / policyengine_core-3.32.29.tar.gz
| Download URL | policyengine_core-3.32.29.tar.gz |
|---|---|
| Size | 617.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
526fbf4bc1592b4afd4b60df3d5572cfef3e00afb93fbc733940233d8a0310c4
|
|
BLAKE2b-256 checksum How to use checksums |
7725e616e70a4af620a9264b570190b4a9b44703d97f9d29b766f57375441bdf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / policyengine_core-3.32.29-py3-none-any.whl
| Download URL | policyengine_core-3.32.29-py3-none-any.whl |
|---|---|
| Size | 281.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
30591ab05d676ef89aabf4ae4ca4544b0fe97dde4ab82233d487d88ded05fffc
|
|
BLAKE2b-256 checksum How to use checksums |
de087e61ea7485fd7b1141c2d4aa8f363f3ac875685e8f119f45e613035edad2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|