Three routes to the same models. Start with MCP below — it needs no install, no PolicyEngine account and no API key, though some clients - gate custom connectors by plan. Use the CLI or Python when you want the + gate custom connectors by plan. That is true of the hosted route; a + local UK population or reform-scoring run additionally needs a + HuggingFace token, as below. Use the CLI or Python when you want the models in a script, or need one of the local-only members.
@@ -368,10 +370,19 @@uk microdata
+ Running a UK population or reform score locally needs
+ HUGGING_FACE_TOKEN from an account with access to the
+ private policyengine/policyengine-uk-data-private
+ dataset. UK household calls, every US call, and every hosted call
+ need nothing.
local only
OG-UK long-run scoring (score_reform with
model='og') and dynamic_reform_impact take
- tens of minutes — the hosted server points you to the local CLI.
+ tens of minutes and are excluded from the hosted image;
+ dynamic_reform_impact returns the two-step local recipe,
+ while model='og' returns an import error — use the local
+ CLI for both.
The three define_* tools likewise return run instructions rather than results when called on the hosted server — the unlicensed upstream is never hosted. Everything else here runs hosted.
Experimental, UK only: an OG-UK steady-state solve feeds long-run wage changes back into a second microsimulation run. Local only, and until OG-UK#68 the solve needs its own environment — run pe-macro og-score --json > og.json there, then pe-macro dynamic-score --og-payload og.json.
Experimental, UK only: an OG-UK steady-state solve feeds long-run wage changes back into a second microsimulation run. Local only, and until OG-UK#68 the solve needs its own environment — run pe-macro og-score --reform '{"gov.hmrc.income_tax.rates.uk[0].rate":0.21}' --json > og.json there, then pe-macro dynamic-score --reform '{"gov.hmrc.income_tax.rates.uk[0].rate":0.21}' --og-payload og.json — both steps need the same --reform.