Skip to content
Merged
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
2 changes: 1 addition & 1 deletion connect/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ <h3>Using Codex?</h3>

<hr class="panel-divider" />
<p class="mono foot-head" style="margin-bottom:10px;">on the server</p>
<p class="soon-hint" style="max-width: none;">Ten tools across the four engines: <code class="mono">score_reform</code> (a PolicyEngine reform — the same reform dict as the microsimulation tools — through a chosen macro model; OG-UK runs locally only, and the OBR bridge is in progress); <code class="mono">obr_shock</code> and <code class="mono">list_reform_variables</code> (OBR — raw variable shocks in model units); <code class="mono">forecast_uk</code>, <code class="mono">latest_shocks</code>, <code class="mono">model_summary</code> (SVAR); and <code class="mono">calculate_household</code>, <code class="mono">household_reform_impact</code>, <code class="mono">list_reform_parameters</code>, <code class="mono">population_reform_impact</code> (PolicyEngine). Two things stay local-only and are never on the hosted server: OG-UK scoring, and PolicyEngine <em>population-level</em> reform scoring (it needs large private microdata) — the PolicyEngine tools above are household-level only. The server is serverless and scales to zero — the first call after a quiet spell takes ~10 seconds to wake.</p>
<p class="soon-hint" style="max-width: none;">Ten tools across the four engines: <code class="mono">score_reform</code> (a PolicyEngine reform — the same reform dict as the microsimulation tools — through a chosen macro model; OG-UK runs locally only, and the OBR bridge is in progress); <code class="mono">obr_shock</code> and <code class="mono">list_reform_variables</code> (OBR — raw variable shocks in model units); <code class="mono">forecast_uk</code>, <code class="mono">latest_shocks</code>, <code class="mono">model_summary</code> (SVAR); and <code class="mono">calculate_household</code>, <code class="mono">household_reform_impact</code>, <code class="mono">list_reform_parameters</code>, <code class="mono">population_reform_impact</code> (PolicyEngine). OG-UK scoring stays local-only (a solve takes tens of minutes, so the hosted server excludes it); every other tool above, including population-level reform scoring, runs on the hosted server. The server is serverless and scales to zero — the first call after a quiet spell takes ~10 seconds to wake.</p>
</div>

<!-- ================= CLI ================= -->
Expand Down
20 changes: 15 additions & 5 deletions integration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,23 @@ pip install "macromod[models] @ git+https://github.com/PolicyEngine/macro#subdir
A shorter `pip install macromod` will come with PyPI publication.

For development, install with the full model set (policyengine included via
the `[models]` extra), overriding the two model packages with local editable
checkouts; OG-UK is optional and local-only:
the `[models]` extra), then override the two model packages with local
editable checkouts in a second step (`--no-deps`: mixing the extra's Git URLs
and editable paths in one resolution is a conflict):

```bash
uv venv && uv pip install -e "./integration[models]" pytest \
-e ../obr-macroeconomic-model -e ../boe-var-model
uv pip install "oguk @ git+https://github.com/PSLmodels/OG-UK" # optional, for --model og
uv venv && uv pip install -e "./integration[models]" pytest
uv pip install --no-deps -e ../obr-macroeconomic-model -e ../boe-var-model
```

OG-UK (optional, for `--model og`) pins `policyengine-uk==2.88.0`, which
conflicts with the household/population stack — give it its own environment
until [PSLmodels/OG-UK#68](https://github.com/PSLmodels/OG-UK/issues/68)
lands:

```bash
uv venv .venv-og && uv pip install -p .venv-og/bin/python \
"oguk @ git+https://github.com/PSLmodels/OG-UK"
```

## CLI
Expand Down
Loading