.. image:: figures/code.png

|

Model Code
==========

This section is a technical documentation of the microWELT 3.0 model, including the model code. It is organised module by module. Each module documentation contains a text description followed by the code. The modules are grouped as follows:

- Model Overview
- The actors
- The socio-demographic core
- Economic activity
- Labor related income
- Tax-Benefit System
- Health and Care
- The simulation engine and associated modules
- Model output

This documentation is automatically generated from the latest version of the model code.

Model Overview
--------------

.. include:: code/_Documentation.mpp
   :start-after: NOTE(model, EN)
   :end-before: */

Model Actors
------------

ActorObservation.mpp
^^^^^^^^^^^^^^^^^^^^

.. include:: code/ActorObservation.mpp
   :start-after: NOTE(ActorObservation, EN)
   :end-before: */

.. include:: code/ActorObservation.mpp
   :start-after: */
   :code:

ActorPerson.mpp
^^^^^^^^^^^^^^^

.. include:: code/ActorPerson.mpp
   :start-after: NOTE(ActorPerson, EN)
   :end-before: */

.. include:: code/ActorPerson.mpp
   :start-after: */
   :code:

ActorObserver.mpp
^^^^^^^^^^^^^^^^^

.. include:: code/ActorObserver.mpp
   :start-after: NOTE(ActorObserver, EN)
   :end-before: */

.. include:: code/ActorObserver.mpp
   :start-after: */
   :code:

The Socio-Demographic Core
--------------------------

Fertility.mpp
^^^^^^^^^^^^^

.. include:: code/Fertility.mpp
   :start-after: NOTE(Fertility, EN)
   :end-before: */

.. include:: code/Fertility.mpp
   :start-after: */
   :code:

Mortality.mpp
^^^^^^^^^^^^^

.. include:: code/Mortality.mpp
   :start-after: NOTE(Mortality, EN)
   :end-before: */

.. include:: code/Mortality.mpp
   :start-after: */
   :code:

Migration.mpp
^^^^^^^^^^^^^

.. include:: code/Migration.mpp
   :start-after: NOTE(Migration, EN)
   :end-before: */

.. include:: code/Migration.mpp
   :start-after: */
   :code:

Partnerships.mpp
^^^^^^^^^^^^^^^^

.. include:: code/Partnerships.mpp
   :start-after: NOTE(Partnerships, EN)
   :end-before: */

.. include:: code/Partnerships.mpp
   :start-after: */
   :code:

Family.mpp
^^^^^^^^^^

.. include:: code/Family.mpp
   :start-after: NOTE(Family, EN)
   :end-before: */

.. include:: code/Family.mpp
   :start-after: */
   :code:

MaleFamily.mpp
^^^^^^^^^^^^^^

.. include:: code/MaleFamily.mpp
   :start-after: NOTE(MaleFamily, EN)
   :end-before: */

.. include:: code/MaleFamily.mpp
   :start-after: */
   :code:

LeavingHome.mpp
^^^^^^^^^^^^^^^

.. include:: code/LeavingHome.mpp
   :start-after: NOTE(LeavingHome, EN)
   :end-before: */

.. include:: code/LeavingHome.mpp
   :start-after: */
   :code:

ParentsEducation.mpp
^^^^^^^^^^^^^^^^^^^^

.. include:: code/ParentsEducation.mpp
   :start-after: NOTE(ParentsEducation, EN)
   :end-before: */

.. include:: code/ParentsEducation.mpp
   :start-after: */
   :code:

Education.mpp
^^^^^^^^^^^^^

.. include:: code/Education.mpp
   :start-after: NOTE(Education, EN)
   :end-before: */

.. include:: code/Education.mpp
   :start-after: */
   :code:

EducationEnrolment.mpp
^^^^^^^^^^^^^^^^^^^^^^

.. include:: code/EducationEnrolment.mpp
   :start-after: NOTE(EducationEnrolment, EN)
   :end-before: */

.. include:: code/EducationEnrolment.mpp
   :start-after: */
   :code:


Economic activity
-----------------

ActivityTransitions.mpp
^^^^^^^^^^^^^^^^^^^^^^^

.. include:: code/ActivityTransitions.mpp
   :start-after: NOTE(ActivityTransitions, EN)
   :end-before: */

.. include:: code/ActivityTransitions.mpp
   :start-after: */
   :code:

.. image:: figures/activity-transitions.png

ActivityParttime.mpp
^^^^^^^^^^^^^^^^^^^^

.. include:: code/ActivityParttime.mpp
   :start-after: NOTE(ActivityParttime, EN)
   :end-before: */

.. include:: code/ActivityParttime.mpp
   :start-after: */
   :code:

Labor related income
--------------------

Income-Earnings.mpp
^^^^^^^^^^^^^^^^^^^

.. include:: code/Income-Earnings.mpp
   :start-after: NOTE(Income-Earnings, EN)
   :end-before: */

.. include:: code/Income-Earnings.mpp
   :start-after: */
   :code:

Income-Parental.mpp
^^^^^^^^^^^^^^^^^^^

.. include:: code/Income-Parental.mpp
   :start-after: NOTE(Income-Parental, EN)
   :end-before: */

.. include:: code/Income-Parental.mpp
   :start-after: */
   :code:

Income-Pensions.mpp
^^^^^^^^^^^^^^^^^^^

.. include:: code/Income-Pensions.mpp
   :start-after: NOTE(Income-Pensions, EN)
   :end-before: */

.. include:: code/Income-Pensions.mpp
   :start-after: */
   :code:

Income-Unemployment.mpp
^^^^^^^^^^^^^^^^^^^^^^^

.. include:: code/Income-Unemployment.mpp
   :start-after: NOTE(Income-Unemployment, EN)
   :end-before: */

.. include:: code/Income-Unemployment.mpp
   :start-after: */
   :code:


Tax-Benefit System
--------------------

.. image:: figures/accounts-flows.png

TaxBen-General.mpp
^^^^^^^^^^^^^^^^^^

.. include:: code/TaxBen-General.mpp
   :start-after: NOTE(TaxBen-General, EN)
   :end-before: */

.. include:: code/TaxBen-General.mpp
   :start-after: */
   :code:

TaxBen-Accounts.mpp
^^^^^^^^^^^^^^^^^^^

.. include:: code/TaxBen-Accounts.mpp
   :start-after: NOTE(TaxBen-Accounts, EN)
   :end-before: */

.. include:: code/TaxBen-Accounts.mpp
   :start-after: */
   :code:

TaxBen-IncomeTax.mpp
^^^^^^^^^^^^^^^^^^^^

.. include:: code/TaxBen-IncomeTax.mpp
   :start-after: NOTE(TaxBen-IncomeTax, EN)
   :end-before: */

.. include:: code/TaxBen-IncomeTax.mpp
   :start-after: */
   :code:

TaxBen-SocialInsurance.mpp
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. include:: code/TaxBen-SocialInsurance.mpp
   :start-after: NOTE(TaxBen-SocialInsurance, EN)
   :end-before: */

.. include:: code/TaxBen-SocialInsurance.mpp
   :start-after: */
   :code:

TaxBen-Education.mpp
^^^^^^^^^^^^^^^^^^^^

.. include:: code/TaxBen-Education.mpp
   :start-after: NOTE(TaxBen-Education, EN)
   :end-before: */

.. include:: code/TaxBen-Education.mpp
   :start-after: */
   :code:

TaxBen-Family.mpp
^^^^^^^^^^^^^^^^^

.. include:: code/TaxBen-Family.mpp
   :start-after: NOTE(TaxBen-Family, EN)
   :end-before: */

.. include:: code/TaxBen-Family.mpp
   :start-after: */
   :code:

TaxBen-OldAge.mpp
^^^^^^^^^^^^^^^^^

.. include:: code/TaxBen-OldAge.mpp
   :start-after: NOTE(TaxBen-OldAge, EN)
   :end-before: */

.. include:: code/TaxBen-OldAge.mpp
   :start-after: */
   :code:

TaxBen-Social.mpp
^^^^^^^^^^^^^^^^^

.. include:: code/TaxBen-Social.mpp
   :start-after: NOTE(TaxBen-Social, EN)
   :end-before: */

.. include:: code/TaxBen-Social.mpp
   :start-after: */
   :code:

Health and Care
---------------

LongtermCare.mpp
^^^^^^^^^^^^^^^^

.. include:: code/LongtermCare.mpp
   :start-after: NOTE(LongtermCare, EN)
   :end-before: */

.. image:: figures/ltc.png

.. include:: code/LongtermCare.mpp
   :start-after: */
   :code:

Health.mpp
^^^^^^^^^^

.. include:: code/Health.mpp
   :start-after: NOTE(Health, EN)
   :end-before: */

.. include:: code/Health.mpp
   :start-after: */
   :code:

NTTA-Childcare.mpp
^^^^^^^^^^^^^^^^^^

.. include:: code/NTTA-Childcare.mpp
   :start-after: NOTE(NTTA-Childcare, EN)
   :end-before: */

.. include:: code/NTTA-Childcare.mpp
   :start-after: */
   :code:

The Simulation Engine and related modules
-----------------------------------------

SimulationEngine.mpp
^^^^^^^^^^^^^^^^^^^^

.. include:: code/SimulationEngine.mpp
   :start-after: NOTE(SimulationEngine, EN)
   :end-before: */

.. include:: code/SimulationEngine.mpp
   :start-after: */
   :code:

_Context.mpp
^^^^^^^^^^^^

.. include:: code/_Context.mpp
   :start-after: NOTE(_Context, EN)
   :end-before: */

.. include:: code/_Context.mpp
   :start-after: */
   :code:

ClockEvents.mpp
^^^^^^^^^^^^^^^

.. include:: code/ClockEvents.mpp
   :start-after: NOTE(ClockEvents, EN)
   :end-before: */

.. include:: code/ClockEvents.mpp
   :start-after: */
   :code:

ompp_framework.ompp
^^^^^^^^^^^^^^^^^^^

.. include:: code/ompp_framework.ompp
   :start-after: NOTE(ompp_framework, EN)
   :end-before: */

.. include:: code/ompp_framework.ompp
   :start-after: */
   :code:

modgen_framework.mpp
^^^^^^^^^^^^^^^^^^^^

.. include:: code/modgen_framework.mpp
   :start-after: NOTE(modgen_framework, EN)
   :end-before: */

.. include:: code/modgen_framework.mpp
   :start-after: */
   :code:

Model Output
------------

TablesDemography.mpp
^^^^^^^^^^^^^^^^^^^^

.. include:: code/TablesDemography.mpp
   :start-after: NOTE(TablesDemography, EN)
   :end-before: */

.. include:: code/TablesDemography.mpp
   :start-after: */
   :code:

TablesEducation.mpp
^^^^^^^^^^^^^^^^^^^

.. include:: code/TablesEducation.mpp
   :start-after: NOTE(TablesEducation, EN)
   :end-before: */

.. include:: code/TablesEducation.mpp
   :start-after: */
   :code:

TablesFamily.mpp
^^^^^^^^^^^^^^^^

.. include:: code/TablesFamily.mpp
   :start-after: NOTE(TablesFamily, EN)
   :end-before: */

.. include:: code/TablesFamily.mpp
   :start-after: */
   :code:

TablesLongtermCare.mpp
^^^^^^^^^^^^^^^^^^^^^^

.. include:: code/TablesLongtermCare.mpp
   :start-after: NOTE(TablesLongtermCare, EN)
   :end-before: */

.. include:: code/TablesLongtermCare.mpp
   :start-after: */
   :code:

TablesValidation.mpp
^^^^^^^^^^^^^^^^^^^^

.. include:: code/TablesValidation.mpp
   :start-after: NOTE(TablesValidation, EN)
   :end-before: */

.. include:: code/TablesValidation.mpp
   :start-after: */
   :code: