euromod_linking.methods.base
============================

.. py:module:: euromod_linking.methods.base

.. autoapi-nested-parse::

   What every linking method is handed and what it returns.

   A method implements ``apply`` and ``check_dataset``, plus an optional
   ``preview``, and must be deterministic: same input data, same shocks, same
   params gives bit-identical output.



Exceptions
----------

.. autoapisummary::

   euromod_linking.methods.base.MethodError


Classes
-------

.. autoapisummary::

   euromod_linking.methods.base.MethodContext
   euromod_linking.methods.base.MethodResult


Module Contents
---------------

.. py:exception:: MethodError



   Raised by a method for domain failures (infeasible targets, bad state).


.. py:class:: MethodContext

   .. py:attribute:: country_code
      :type:  str


   .. py:attribute:: dataset_name
      :type:  str | None
      :value: None



   .. py:attribute:: extensions
      :type:  list | None
      :value: None



   .. py:attribute:: system_name
      :type:  str


.. py:class:: MethodResult

   .. py:attribute:: baseline
      :type:  pandas.DataFrame | None
      :value: None



   .. py:attribute:: constants
      :type:  dict | None
      :value: None



   .. py:attribute:: data
      :type:  pandas.DataFrame


   .. py:attribute:: diagnostics
      :type:  dict