euromod.eu_euromod
==================

.. py:module:: euromod.eu_euromod

.. autoapi-nested-parse::

   Tools that are specific to the JRC's EUROMOD model of the 27 EU member states.

   The rest of the ``euromod`` package is a connector to the EUROMOD *software*: it
   works with any model built for that software. The modules in this package are
   different. They rely on the conventions of one model, the EU model maintained by
   the Joint Research Centre: its income lists (``ils_dispy``, ``ils_origrepy``, ...),
   its variable names (``dwt``, ``dms``, ``yse``, ...) and its system names
   (``PT_2022``). They will not work on a model that does not follow these
   conventions, and each module states exactly what it needs.

   This package is not imported by ``euromod`` itself. Import what you need, e.g.::

       from euromod.eu_euromod.calibrate import prepare_sample, fit_hsv

   Modules
   -------
   calibrate
       Calibrating a parametric tax-benefit function on EUROMOD output.



Below are listed the main public classes of the euromod.eu_euromod module.



.. toctree::
   :titlesonly:
   :maxdepth: 1

   calibrate/index.rst






.. list-table:: **Function**
   :header-rows: 0
   :widths: auto
   :class: summarytable

   * - :py:obj:`eu27_systems <euromod.eu_euromod.eu27_systems>`\ (year)
     - Baseline system names of the 27 member states for one policy year.
   * - :py:obj:`euro_area <euromod.eu_euromod.euro_area>`\ (year)
     - Euro-area members in a policy year (from 2015, when Lithuania joined).


.. list-table:: **Attributes**
   :header-rows: 0
   :widths: auto
   :class: summarytable

   * - :py:obj:`EU27 <euromod.eu_euromod.EU27>`
     - \-
   * - :py:obj:`EURO_AREA_19 <euromod.eu_euromod.EURO_AREA_19>`
     - \-
   * - :py:obj:`EURO_AREA_20 <euromod.eu_euromod.EURO_AREA_20>`
     - \-



Functions
---------
.. py:function:: eu27_systems(year)

   Baseline system names of the 27 member states for one policy year.

   :param year: Policy year.
   :type year: :obj:`int`

   :returns: ``["AT_2022", "BE_2022", ..., "SK_2022"]`` for ``year=2022``.
   :rtype: list of :obj:`str`


.. py:function:: euro_area(year)

   Euro-area members in a policy year (from 2015, when Lithuania joined).

   :param year: Policy year.
   :type year: :obj:`int`

   :returns: :data:`EURO_AREA_19` up to 2022, :data:`EURO_AREA_20` from 2023.
   :rtype: tuple of :obj:`str`



Attributes
----------
.. py:data:: EU27
   :value: ('AT', 'BE', 'BG', 'CY', 'CZ', 'DE', 'DK', 'EE', 'EL', 'ES', 'FI', 'FR', 'HR', 'HU', 'IE', 'IT',...


.. py:data:: EURO_AREA_19
   :value: ('AT', 'BE', 'CY', 'DE', 'EE', 'EL', 'ES', 'FI', 'FR', 'IE', 'IT', 'LT', 'LU', 'LV', 'MT', 'NL',...


.. py:data:: EURO_AREA_20
   :value: ('AT', 'BE', 'CY', 'DE', 'EE', 'EL', 'ES', 'FI', 'FR', 'HR', 'IE', 'IT', 'LT', 'LU', 'LV', 'MT',...