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.33.0
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.33.0.tar.gz | 674.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| policyengine_core-3.33.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 974.3 kB
Release files / policyengine_core-3.33.0.tar.gz
| Download URL | policyengine_core-3.33.0.tar.gz |
|---|---|
| Size | 674.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5c923828dc84a7a1ff8f6f407f7a704fe067246dd277ede04c15f409804b9c19
|
|
BLAKE2b-256 checksum How to use checksums |
90d770936abfab724399ea3d8db04bbd5808339ee1534819bf25ab46d00c8d32
|
| 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.33.0-py3-none-any.whl
| Download URL | policyengine_core-3.33.0-py3-none-any.whl |
|---|---|
| Size | 299.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2e32d02a8910ab683a2b7600987904b351d058fc2bd5910a8ea6641438bcd789
|
|
BLAKE2b-256 checksum How to use checksums |
6d02190e06717785ff974120a9136c6c5408a00beaa8cddd792f557a6bf974c4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|