euromod-linking 0.1.0__tar.gz

euromod_linking-0.1.0/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+<!--next-version-placeholder-->
+
+## v0.1.0 (25/08/2026)
+
+First release.
+
+Turns an external economic model's projected changes into transformed EUROMOD input
+microdata and run parameters, so macro results can be evaluated at household level.
+
+- **The shock table.** One canonical eight-column format every external model's output is
+  normalised into, identified by a content hash so the same economic scenario always has the
+  same id. Channels: `align`, `scale`, `constant` (`reweight` and `inject` are reserved).
+- **Population cells** written over real EUROMOD input variables, never invented category
+  labels. `region` is NUTS-aware: coarser codes cover their subregions, and finer codes
+  collapse to the level the dataset supports.
+- **Two entry points.** `apply_scenario` transforms input and executes nothing;
+  `run_scenario` additionally runs baseline and counterfactual. `validate_only=True` reports
+  what a scenario would do before paying for two simulations.
+- **Two linking methods**, resolved from the shock channels rather than chosen by the caller:
+  `lma_labour_alignment` (two-level hierarchical alignment to employment and unemployment
+  targets, driving the LMA add-on) and `scale_variables` (cell-level arithmetic on input
+  variables and extension-aware income lists).
+- **Model compatibility checking.** `check_compatibility` and `compatibility_matrix` verify a
+  method's required add-ons and extension switches against the model before a run, so a
+  missing `LMA_trans` fails during validation rather than after two simulations.
+- **Declarative ingest.** External model output is read through mapping specs — YAML or a
+  dict — rather than bespoke parsing code.
+
+Requires Python 3.11+ and a local EUROMOD model, which is distributed by the JRC at
+<https://euromod-web.jrc.ec.europa.eu/download-euromod>. This targets the EUROMOD model for
+the 27 EU member states; models built on the same engine but with different conventions
+(SOUTHMOD, SWISSMOD, national models outside the EU) are out of scope.

euromod_linking-0.1.0/LICENSE.txt

@@ -0,0 +1,291 @@
+# License 
+
+                     EUROPEAN UNION PUBLIC LICENCE v. 1.2
+                      EUPL © the European Union 2007, 2016
+
+This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined
+below) which is provided under the terms of this Licence. Any use of the Work,
+other than as authorised under this Licence is prohibited (to the extent such
+use is covered by a right of the copyright holder of the Work).
+
+The Work is provided under the terms of this Licence when the Licensor (as
+defined below) has placed the following notice immediately following the
+copyright notice for the Work:
+
+        Licensed under the EUPL
+
+or has expressed by any other means his willingness to license under the EUPL.
+
+1. Definitions
+
+In this Licence, the following terms have the following meaning:
+
+- ‘The Licence’: this Licence.
+
+- ‘The Original Work’: the work or software distributed or communicated by the
+  Licensor under this Licence, available as Source Code and also as Executable
+  Code as the case may be.
+
+- ‘Derivative Works’: the works or software that could be created by the
+  Licensee, based upon the Original Work or modifications thereof. This Licence
+  does not define the extent of modification or dependence on the Original Work
+  required in order to classify a work as a Derivative Work; this extent is
+  determined by copyright law applicable in the country mentioned in Article 15.
+
+- ‘The Work’: the Original Work or its Derivative Works.
+
+- ‘The Source Code’: the human-readable form of the Work which is the most
+  convenient for people to study and modify.
+
+- ‘The Executable Code’: any code which has generally been compiled and which is
+  meant to be interpreted by a computer as a program.
+
+- ‘The Licensor’: the natural or legal person that distributes or communicates
+  the Work under the Licence.
+
+- ‘Contributor(s)’: any natural or legal person who modifies the Work under the
+  Licence, or otherwise contributes to the creation of a Derivative Work.
+
+- ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of
+  the Work under the terms of the Licence.
+
+- ‘Distribution’ or ‘Communication’: any act of selling, giving, lending,
+  renting, distributing, communicating, transmitting, or otherwise making
+  available, online or offline, copies of the Work or providing access to its
+  essential functionalities at the disposal of any other natural or legal
+  person.
+
+2. Scope of the rights granted by the Licence
+
+The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
+sublicensable licence to do the following, for the duration of copyright vested
+in the Original Work:
+
+- use the Work in any circumstance and for all usage,
+- reproduce the Work,
+- modify the Work, and make Derivative Works based upon the Work,
+- communicate to the public, including the right to make available or display
+  the Work or copies thereof to the public and perform publicly, as the case may
+  be, the Work,
+- distribute the Work or copies thereof,
+- lend and rent the Work or copies thereof,
+- sublicense rights in the Work or copies thereof.
+
+Those rights can be exercised on any media, supports and formats, whether now
+known or later invented, as far as the applicable law permits so.
+
+In the countries where moral rights apply, the Licensor waives his right to
+exercise his moral right to the extent allowed by law in order to make effective
+the licence of the economic rights here above listed.
+
+The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to
+any patents held by the Licensor, to the extent necessary to make use of the
+rights granted on the Work under this Licence.
+
+3. Communication of the Source Code
+
+The Licensor may provide the Work either in its Source Code form, or as
+Executable Code. If the Work is provided as Executable Code, the Licensor
+provides in addition a machine-readable copy of the Source Code of the Work
+along with each copy of the Work that the Licensor distributes or indicates, in
+a notice following the copyright notice attached to the Work, a repository where
+the Source Code is easily and freely accessible for as long as the Licensor
+continues to distribute or communicate the Work.
+
+4. Limitations on copyright
+
+Nothing in this Licence is intended to deprive the Licensee of the benefits from
+any exception or limitation to the exclusive rights of the rights owners in the
+Work, of the exhaustion of those rights or of other applicable limitations
+thereto.
+
+5. Obligations of the Licensee
+
+The grant of the rights mentioned above is subject to some restrictions and
+obligations imposed on the Licensee. Those obligations are the following:
+
+Attribution right: The Licensee shall keep intact all copyright, patent or
+trademarks notices and all notices that refer to the Licence and to the
+disclaimer of warranties. The Licensee must include a copy of such notices and a
+copy of the Licence with every copy of the Work he/she distributes or
+communicates. The Licensee must cause any Derivative Work to carry prominent
+notices stating that the Work has been modified and the date of modification.
+
+Copyleft clause: If the Licensee distributes or communicates copies of the
+Original Works or Derivative Works, this Distribution or Communication will be
+done under the terms of this Licence or of a later version of this Licence
+unless the Original Work is expressly distributed only under this version of the
+Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee
+(becoming Licensor) cannot offer or impose any additional terms or conditions on
+the Work or Derivative Work that alter or restrict the terms of the Licence.
+
+Compatibility clause: If the Licensee Distributes or Communicates Derivative
+Works or copies thereof based upon both the Work and another work licensed under
+a Compatible Licence, this Distribution or Communication can be done under the
+terms of this Compatible Licence. For the sake of this clause, ‘Compatible
+Licence’ refers to the licences listed in the appendix attached to this Licence.
+Should the Licensee's obligations under the Compatible Licence conflict with
+his/her obligations under this Licence, the obligations of the Compatible
+Licence shall prevail.
+
+Provision of Source Code: When distributing or communicating copies of the Work,
+the Licensee will provide a machine-readable copy of the Source Code or indicate
+a repository where this Source will be easily and freely available for as long
+as the Licensee continues to distribute or communicate the Work.
+
+Legal Protection: This Licence does not grant permission to use the trade names,
+trademarks, service marks, or names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the copyright notice.
+
+6. Chain of Authorship
+
+The original Licensor warrants that the copyright in the Original Work granted
+hereunder is owned by him/her or licensed to him/her and that he/she has the
+power and authority to grant the Licence.
+
+Each Contributor warrants that the copyright in the modifications he/she brings
+to the Work are owned by him/her or licensed to him/her and that he/she has the
+power and authority to grant the Licence.
+
+Each time You accept the Licence, the original Licensor and subsequent
+Contributors grant You a licence to their contributions to the Work, under the
+terms of this Licence.
+
+7. Disclaimer of Warranty
+
+The Work is a work in progress, which is continuously improved by numerous
+Contributors. It is not a finished work and may therefore contain defects or
+‘bugs’ inherent to this type of development.
+
+For the above reason, the Work is provided under the Licence on an ‘as is’ basis
+and without warranties of any kind concerning the Work, including without
+limitation merchantability, fitness for a particular purpose, absence of defects
+or errors, accuracy, non-infringement of intellectual property rights other than
+copyright as stated in Article 6 of this Licence.
+
+This disclaimer of warranty is an essential part of the Licence and a condition
+for the grant of any rights to the Work.
+
+8. Disclaimer of Liability
+
+Except in the cases of wilful misconduct or damages directly caused to natural
+persons, the Licensor will in no event be liable for any direct or indirect,
+material or moral, damages of any kind, arising out of the Licence or of the use
+of the Work, including without limitation, damages for loss of goodwill, work
+stoppage, computer failure or malfunction, loss of data or any commercial
+damage, even if the Licensor has been advised of the possibility of such damage.
+However, the Licensor will be liable under statutory product liability laws as
+far such laws apply to the Work.
+
+9. Additional agreements
+
+While distributing the Work, You may choose to conclude an additional agreement,
+defining obligations or services consistent with this Licence. However, if
+accepting obligations, You may act only on your own behalf and on your sole
+responsibility, not on behalf of the original Licensor or any other Contributor,
+and only if You agree to indemnify, defend, and hold each Contributor harmless
+for any liability incurred by, or claims asserted against such Contributor by
+the fact You have accepted any warranty or additional liability.
+
+10. Acceptance of the Licence
+
+The provisions of this Licence can be accepted by clicking on an icon ‘I agree’
+placed under the bottom of a window displaying the text of this Licence or by
+affirming consent in any other similar way, in accordance with the rules of
+applicable law. Clicking on that icon indicates your clear and irrevocable
+acceptance of this Licence and all of its terms and conditions.
+
+Similarly, you irrevocably accept this Licence and all of its terms and
+conditions by exercising any rights granted to You by Article 2 of this Licence,
+such as the use of the Work, the creation by You of a Derivative Work or the
+Distribution or Communication by You of the Work or copies thereof.
+
+11. Information to the public
+
+In case of any Distribution or Communication of the Work by means of electronic
+communication by You (for example, by offering to download the Work from a
+remote location) the distribution channel or media (for example, a website) must
+at least provide to the public the information requested by the applicable law
+regarding the Licensor, the Licence and the way it may be accessible, concluded,
+stored and reproduced by the Licensee.
+
+12. Termination of the Licence
+
+The Licence and the rights granted hereunder will terminate automatically upon
+any breach by the Licensee of the terms of the Licence.
+
+Such a termination will not terminate the licences of any person who has
+received the Work from the Licensee under the Licence, provided such persons
+remain in full compliance with the Licence.
+
+13. Miscellaneous
+
+Without prejudice of Article 9 above, the Licence represents the complete
+agreement between the Parties as to the Work.
+
+If any provision of the Licence is invalid or unenforceable under applicable
+law, this will not affect the validity or enforceability of the Licence as a
+whole. Such provision will be construed or reformed so as necessary to make it
+valid and enforceable.
+
+The European Commission may publish other linguistic versions or new versions of
+this Licence or updated versions of the Appendix, so far this is required and
+reasonable, without reducing the scope of the rights granted by the Licence. New
+versions of the Licence will be published with a unique version number.
+
+All linguistic versions of this Licence, approved by the European Commission,
+have identical value. Parties can take advantage of the linguistic version of
+their choice.
+
+14. Jurisdiction
+
+Without prejudice to specific agreement between parties,
+
+- any litigation resulting from the interpretation of this License, arising
+  between the European Union institutions, bodies, offices or agencies, as a
+  Licensor, and any Licensee, will be subject to the jurisdiction of the Court
+  of Justice of the European Union, as laid down in article 272 of the Treaty on
+  the Functioning of the European Union,
+
+- any litigation arising between other parties and resulting from the
+  interpretation of this License, will be subject to the exclusive jurisdiction
+  of the competent court where the Licensor resides or conducts its primary
+  business.
+
+15. Applicable Law
+
+Without prejudice to specific agreement between parties,
+
+- this Licence shall be governed by the law of the European Union Member State
+  where the Licensor has his seat, resides or has his registered office,
+
+- this licence shall be governed by Belgian law if the Licensor has no seat,
+  residence or registered office inside a European Union Member State.
+
+Appendix
+
+‘Compatible Licences’ according to Article 5 EUPL are:
+
+- GNU General Public License (GPL) v. 2, v. 3
+- GNU Affero General Public License (AGPL) v. 3
+- Open Software License (OSL) v. 2.1, v. 3.0
+- Eclipse Public License (EPL) v. 1.0
+- CeCILL v. 2.0, v. 2.1
+- Mozilla Public Licence (MPL) v. 2
+- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
+- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
+  works other than software
+- European Union Public Licence (EUPL) v. 1.1, v. 1.2
+- Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong
+  Reciprocity (LiLiQ-R+).
+
+The European Commission may update this Appendix to later versions of the above
+licences without producing a new version of the EUPL, as long as they provide
+the rights granted in Article 2 of this Licence and protect the covered Source
+Code from exclusive appropriation.
+
+All other changes or additions to this Appendix require the production of a new
+EUPL version.
+
+https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12 

euromod_linking-0.1.0/MANIFEST.in

@@ -0,0 +1,14 @@
+# The wheel gets schemas/ and mappings/ from [tool.setuptools.package-data]; the
+# sdist needs them named here too, along with the tests, so a source release can
+# be checked out and run.
+include LICENSE.txt
+include README.md
+include CHANGELOG.md
+recursive-include src/euromod_linking/schemas *.json
+recursive-include src/euromod_linking/mappings *.yaml
+recursive-include tests *.py
+
+# No `prune docs` / `prune build`: this file is an allowlist, and the sdist's
+# default set never reaches outside src/, so both pruned nothing while warning
+# on every build. Warnings nobody can act on are how real ones get ignored.
+global-exclude __pycache__ *.py[cod] .DS_Store

euromod_linking-0.1.0/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.4
+Name: euromod-linking
+Version: 0.1.0
+Summary: Link external economic models to EUROMOD by transforming input microdata and run parameters
+Author-email: Hannes Serruys <hannes.serruys@ec.europa.eu>
+License-Expression: EUPL-1.2
+Project-URL: Documentation, https://ec-jrc.github.io/JRC-EUROMOD-software-source-code/python-linking/
+Project-URL: Source, https://github.com/ec-jrc/JRC-EUROMOD-software-source-code/tree/master/connectors/PythonLinking
+Project-URL: EUROMOD model, https://euromod-web.jrc.ec.europa.eu/download-euromod
+Keywords: EUROMOD,microsimulation,macro-micro linking,tax-benefit,microdata
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: euromod>=0.3.1
+Requires-Dist: pandas>=2.0
+Requires-Dist: numpy
+Requires-Dist: jsonschema>=4.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: statsmodels>=0.14
+Requires-Dist: scikit-learn>=1.4
+Requires-Dist: scipy>=1.11
+Provides-Extra: excel
+Requires-Dist: openpyxl>=3.1; extra == "excel"
+Requires-Dist: xlrd>=2.0.1; extra == "excel"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: openpyxl>=3.1; extra == "dev"
+Requires-Dist: xlrd>=2.0.1; extra == "dev"
+Dynamic: license-file
+
+# euromod-linking
+
+Connect external economic models to [EUROMOD](https://euromod-web.jrc.ec.europa.eu/) by
+transforming its input microdata and run parameters.
+
+A macro model — a CGE model, a forecasting model, a policy scenario written by hand — projects
+*changes*: employment by region and education, nominal wages, price levels. EUROMOD simulates
+taxes and benefits on a household survey. This package is the layer between them: it takes those
+projected changes as data, rewrites the microdata and run parameters so the survey population
+matches them, and runs baseline and counterfactual simulations that differ *only* by the shock.
+
+It is a standalone library. It has no dependency on any agent, notebook or UI, and is usable
+directly from a script.
+
+## Scope
+
+**This library targets the JRC's EUROMOD model for the 27 EU member states, and only that
+model.** It is not a general library for the EUROMOD *software*: models built on the same
+engine — SOUTHMOD, SWISSMOD, and national or regional models outside the EU — will not work
+with it.
+
+It assumes EUROMOD's own EU-27 conventions throughout: the `ils_udb_*` User Database income
+lists, the `les`/`les2` labour-status codings, `drgn1`/`drgn2` read as NUTS regions, variable
+names such as `dwt`, `dag`, `deh`, `yem` and `yivwg`, the `$lhw` constant, and the
+JRC-maintained LMA add-on. Those conventions are precisely what a different model changes.
+
+## Install
+
+```bash
+pip install euromod-linking          # or: pip install -e .
+pip install euromod-linking[excel]   # to ingest .xlsx/.xlsm/.xls model output
+```
+
+Requires Python 3.11+ and a local EUROMOD model and installation (see the `euromod` connector).
+The model is distributed by the JRC and can be requested at
+<https://euromod-web.jrc.ec.europa.eu/download-euromod>.
+
+## The canonical shock table
+
+Every external model's output is normalised into one table before anything else happens. Six
+columns, one row per shock:
+
+| column | meaning |
+|---|---|
+| `channel` | how it acts: `align` (move people between states), `scale` (multiply a variable), `constant` (override a model parameter) |
+| `metric` | what it acts on: `employment`, `unemployment`, an input variable (`yem`), an income list (`ils_udb_yem`), or a constant name (`$f_cpi`) |
+| `group` | which people: a population cell over EUROMOD input variables — `"deh=3-4;dgn=1"`, `""` for everyone |
+| `period` | the external model's period label |
+| `op` | `set` \| `grow` \| `mult` \| `add` |
+| `value` | the number |
+
+Shock tables are content-addressed (`shk_…`), so the same economic scenario always has the same
+id regardless of which file or code path produced it.
+
+Population cells are written over *real EUROMOD input variables*, never invented category labels.
+`region` is the one named dimension and is NUTS-aware: coarser codes cover their subregions, and
+shocks defined at a finer level than the data supports are collapsed to the level it does.
+
+## Two entry points
+
+```python
+import pandas as pd
+from euromod import Model
+from euromod_linking import apply_scenario, run_scenario
+
+system = Model(r"C:\EUROMOD_RELEASES").countries["BE"].systems["BE_2025"]
+
+scenario = {
+    "country_code": "BE",
+    "system_name": "BE_2025",
+    "shocks": {"inline": [
+        {"channel": "align", "metric": "employment", "group": "deh=0-3",
+         "period": "1", "op": "grow", "value": 0.0655},
+    ]},
+    "params": {"period": "1"},
+}
+
+# Pure transform: returns the counterfactual input, a matched baseline, and diagnostics.
+plan = apply_scenario(system, pd.read_csv(data_file, sep="\t"), scenario)
+
+# Convenience: does the above and runs both simulations.
+out = run_scenario(system, scenario, input_path=r"C:\EUROMOD_RELEASES\Input")
+```
+
+`apply_scenario(..., validate_only=True)` stops before the expensive work and returns what the
+scenario *would* do: the per-cell baseline population the shocks resolve against, the resulting
+targets, the implied change in people and in percentage points, and feasibility against the pool
+of people who can actually move. Check a shock is the size you meant before paying for two
+simulations.
+
+External model output in a file is ingested through a declarative mapping spec — a YAML file
+under `mappings/`, or a dict — rather than bespoke parsing code:
+
+```python
+scenario["shocks"] = {"file": "projections.xlsx", "mapping": "regional_projections"}
+```
+
+## Methodologies
+
+The transformation is **never chosen by the caller**. It is resolved from the shock channels and
+echoed back, so a scenario cannot silently be handled by a different method than the one that
+produced an earlier result. Their code is content-fingerprinted into the scenario id — changing the modelling invalidates cached results rather than serving stale
+ones.
+
+- **`lma_labour_alignment`** (`align`) — two-level hierarchical alignment to external
+  employment/unemployment totals per cell. Level 1 sizes the labour force, level 2 splits it into
+  employment and unemployment. Who moves is decided by ranked logit propensities, not a random
+  draw; targets are hit exactly by splitting the boundary household's weight. New workers are
+  given full-time earnings at their own predicted hourly wage. Labour states come from `les`/`les2`
+  over working age (18–65), and only genuinely inactive people are recruitable — students,
+  pensioners, the long-term sick and conscripts are never moved.
+- **`scale_variables`** (`scale`) — cell-level scaling of input variables. An income-list metric
+  is expanded extension-aware into its component variables by walking the model's `DefIl`
+  definitions, so it stays correct when extensions change what a list contains.
+
+## Diagnostics
+
+Every run reports the baseline it worked from, not just what it achieved: per-cell population and
+labour states, the resolved target, the change in people *and* percentage points, feasibility
+against the recruitable pool, and transitions as **weighted people** alongside raw row counts.
+An alignment grade says only that the target was hit — never that the target was right — so the
+baseline is always reported beside it.
+
+## Tests
+
+```bash
+pip install -e .[dev]
+pytest
+```
+
+## Licence
+
+EUPL-1.2.

euromod_linking-0.1.0/README.md

@@ -0,0 +1,133 @@
+# euromod-linking
+
+Connect external economic models to [EUROMOD](https://euromod-web.jrc.ec.europa.eu/) by
+transforming its input microdata and run parameters.
+
+A macro model — a CGE model, a forecasting model, a policy scenario written by hand — projects
+*changes*: employment by region and education, nominal wages, price levels. EUROMOD simulates
+taxes and benefits on a household survey. This package is the layer between them: it takes those
+projected changes as data, rewrites the microdata and run parameters so the survey population
+matches them, and runs baseline and counterfactual simulations that differ *only* by the shock.
+
+It is a standalone library. It has no dependency on any agent, notebook or UI, and is usable
+directly from a script.
+
+## Scope
+
+**This library targets the JRC's EUROMOD model for the 27 EU member states, and only that
+model.** It is not a general library for the EUROMOD *software*: models built on the same
+engine — SOUTHMOD, SWISSMOD, and national or regional models outside the EU — will not work
+with it.
+
+It assumes EUROMOD's own EU-27 conventions throughout: the `ils_udb_*` User Database income
+lists, the `les`/`les2` labour-status codings, `drgn1`/`drgn2` read as NUTS regions, variable
+names such as `dwt`, `dag`, `deh`, `yem` and `yivwg`, the `$lhw` constant, and the
+JRC-maintained LMA add-on. Those conventions are precisely what a different model changes.
+
+## Install
+
+```bash
+pip install euromod-linking          # or: pip install -e .
+pip install euromod-linking[excel]   # to ingest .xlsx/.xlsm/.xls model output
+```
+
+Requires Python 3.11+ and a local EUROMOD model and installation (see the `euromod` connector).
+The model is distributed by the JRC and can be requested at
+<https://euromod-web.jrc.ec.europa.eu/download-euromod>.
+
+## The canonical shock table
+
+Every external model's output is normalised into one table before anything else happens. Six
+columns, one row per shock:
+
+| column | meaning |
+|---|---|
+| `channel` | how it acts: `align` (move people between states), `scale` (multiply a variable), `constant` (override a model parameter) |
+| `metric` | what it acts on: `employment`, `unemployment`, an input variable (`yem`), an income list (`ils_udb_yem`), or a constant name (`$f_cpi`) |
+| `group` | which people: a population cell over EUROMOD input variables — `"deh=3-4;dgn=1"`, `""` for everyone |
+| `period` | the external model's period label |
+| `op` | `set` \| `grow` \| `mult` \| `add` |
+| `value` | the number |
+
+Shock tables are content-addressed (`shk_…`), so the same economic scenario always has the same
+id regardless of which file or code path produced it.
+
+Population cells are written over *real EUROMOD input variables*, never invented category labels.
+`region` is the one named dimension and is NUTS-aware: coarser codes cover their subregions, and
+shocks defined at a finer level than the data supports are collapsed to the level it does.
+
+## Two entry points
+
+```python
+import pandas as pd
+from euromod import Model
+from euromod_linking import apply_scenario, run_scenario
+
+system = Model(r"C:\EUROMOD_RELEASES").countries["BE"].systems["BE_2025"]
+
+scenario = {
+    "country_code": "BE",
+    "system_name": "BE_2025",
+    "shocks": {"inline": [
+        {"channel": "align", "metric": "employment", "group": "deh=0-3",
+         "period": "1", "op": "grow", "value": 0.0655},
+    ]},
+    "params": {"period": "1"},
+}
+
+# Pure transform: returns the counterfactual input, a matched baseline, and diagnostics.
+plan = apply_scenario(system, pd.read_csv(data_file, sep="\t"), scenario)
+
+# Convenience: does the above and runs both simulations.
+out = run_scenario(system, scenario, input_path=r"C:\EUROMOD_RELEASES\Input")
+```
+
+`apply_scenario(..., validate_only=True)` stops before the expensive work and returns what the
+scenario *would* do: the per-cell baseline population the shocks resolve against, the resulting
+targets, the implied change in people and in percentage points, and feasibility against the pool
+of people who can actually move. Check a shock is the size you meant before paying for two
+simulations.
+
+External model output in a file is ingested through a declarative mapping spec — a YAML file
+under `mappings/`, or a dict — rather than bespoke parsing code:
+
+```python
+scenario["shocks"] = {"file": "projections.xlsx", "mapping": "regional_projections"}
+```
+
+## Methodologies
+
+The transformation is **never chosen by the caller**. It is resolved from the shock channels and
+echoed back, so a scenario cannot silently be handled by a different method than the one that
+produced an earlier result. Their code is content-fingerprinted into the scenario id — changing the modelling invalidates cached results rather than serving stale
+ones.
+
+- **`lma_labour_alignment`** (`align`) — two-level hierarchical alignment to external
+  employment/unemployment totals per cell. Level 1 sizes the labour force, level 2 splits it into
+  employment and unemployment. Who moves is decided by ranked logit propensities, not a random
+  draw; targets are hit exactly by splitting the boundary household's weight. New workers are
+  given full-time earnings at their own predicted hourly wage. Labour states come from `les`/`les2`
+  over working age (18–65), and only genuinely inactive people are recruitable — students,
+  pensioners, the long-term sick and conscripts are never moved.
+- **`scale_variables`** (`scale`) — cell-level scaling of input variables. An income-list metric
+  is expanded extension-aware into its component variables by walking the model's `DefIl`
+  definitions, so it stays correct when extensions change what a list contains.
+
+## Diagnostics
+
+Every run reports the baseline it worked from, not just what it achieved: per-cell population and
+labour states, the resolved target, the change in people *and* percentage points, feasibility
+against the recruitable pool, and transitions as **weighted people** alongside raw row counts.
+An alignment grade says only that the target was hit — never that the target was right — so the
+baseline is always reported beside it.
+
+## Tests
+
+```bash
+pip install -e .[dev]
+pytest
+```
+
+## Licence
+
+EUPL-1.2.