.. image:: Figures/logo.png :scale: 100 % :align: right Model Code ========== This section is a technical documentation of the microWELT model. It is organized module by module, the modules being grouped by types (see below). The documentation is generated automatically from the most recent version of the model code. Each module documentation contains a text description, followed by the model code. .. include:: code/model_info.mpp :start-after: NOTE(model_info, EN) :end-before: */ The Simulation Engine --------------------- model_core.mpp ^^^^^^^^^^^^^^ .. include:: code/model_core.mpp :start-after: NOTE(model_core, EN) :end-before: */ .. include:: code/model_core.mpp :start-after: */ :code: modgen_time_based.mpp ^^^^^^^^^^^^^^^^^^^^^ .. include:: code/modgen_time_based.mpp :start-after: NOTE(modgen_time_based, EN) :end-before: */ .. include:: code/modgen_time_based.mpp :start-after: */ :code: _CountryContext.mpp ^^^^^^^^^^^^^^^^^^^ .. include:: code/_CountryContext.mpp :start-after: NOTE(_CountryContext, EN) :end-before: */ .. include:: code/_CountryContext.mpp :start-after: */ :code: Actor Core Modules ------------------ PersonCore.mpp ^^^^^^^^^^^^^^ .. include:: code/PersonCore.mpp :start-after: NOTE(PersonCore, EN) :end-before: */ .. include:: code/PersonCore.mpp :start-after: */ :code: StateCore.mpp ^^^^^^^^^^^^^ .. include:: code/StateCore.mpp :start-after: NOTE(StateCore, EN) :end-before: */ .. include:: code/StateCore.mpp :start-after: */ :code: ClockCore.mpp ^^^^^^^^^^^^^ .. include:: code/ClockCore.mpp :start-after: NOTE(ClockCore, EN) :end-before: */ .. include:: code/ClockCore.mpp :start-after: */ :code: ObservationCore.mpp ^^^^^^^^^^^^^^^^^^^ .. include:: code/ObservationCore.mpp :start-after: NOTE(ObservationCore, EN) :end-before: */ .. include:: code/ObservationCore.mpp :start-after: */ :code: GlobalsCore.mpp ^^^^^^^^^^^^^^^ .. include:: code/GlobalsCore.mpp :start-after: NOTE(GlobalsCore, EN) :end-before: */ .. include:: code/GlobalsCore.mpp :start-after: */ :code: Behavioural Modules ------------------- FertilityAgePeriod.mpp ^^^^^^^^^^^^^^^^^^^^^^ .. include:: code/FertilityAgePeriod.mpp :start-after: NOTE(FertilityAgePeriod, EN) :end-before: */ .. include:: code/FertilityAgePeriod.mpp :start-after: */ :code: FertilityByEducation.mpp ^^^^^^^^^^^^^^^^^^^^^^^^ .. include:: code/FertilityByEducation.mpp :start-after: NOTE(FertilityByEducation, EN) :end-before: */ .. include:: code/FertilityByEducation.mpp :start-after: */ :code: MaleChildlessness.mpp ^^^^^^^^^^^^^^^^^^^^^ .. include:: code/MaleChildlessness.mpp :start-after: NOTE(MaleChildlessness, EN) :end-before: */ .. include:: code/MaleChildlessness.mpp :start-after: */ :code: MortalityPeriodLifeTable.mpp ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. include:: code/MortalityPeriodLifeTable.mpp :start-after: NOTE(MortalityPeriodLifeTable, EN) :end-before: */ .. include:: code/MortalityPeriodLifeTable.mpp :start-after: */ :code: MortalityByEducation.mpp ^^^^^^^^^^^^^^^^^^^^^^^^ .. include:: code/MortalityByEducation.mpp :start-after: NOTE(MortalityByEducation, EN) :end-before: */ .. include:: code/MortalityByEducation.mpp :start-after: */ :code: EducBaseFate.mpp ^^^^^^^^^^^^^^^^ .. include:: code/EducBaseFate.mpp :start-after: NOTE(EducBaseFate, EN) :end-before: */ .. include:: code/EducBaseFate.mpp :start-after: */ :code: EducRefinedFate.mpp ^^^^^^^^^^^^^^^^^^^ .. include:: code/EducRefinedFate.mpp :start-after: NOTE(EducRefinedFate, EN) :end-before: */ .. include:: code/EducRefinedFate.mpp :start-after: */ :code: EducationPattern.mpp ^^^^^^^^^^^^^^^^^^^^ .. include:: code/EducationPattern.mpp :start-after: NOTE(EducationPattern, EN) :end-before: */ .. include:: code/EducationPattern.mpp :start-after: */ :code: EducationAlignment.mpp ^^^^^^^^^^^^^^^^^^^^^^ .. include:: code/EducationAlignment.mpp :start-after: NOTE(EducationAlignment, EN) :end-before: */ .. include:: code/EducationAlignment.mpp :start-after: */ :code: Emigration.mpp ^^^^^^^^^^^^^^ .. include:: code/Emigration.mpp :start-after: NOTE(Emigration, EN) :end-before: */ .. include:: code/Emigration.mpp :start-after: */ :code: Immigration.mpp ^^^^^^^^^^^^^^^ .. include:: code/Immigration.mpp :start-after: NOTE(Immigration, EN) :end-before: */ .. include:: code/Immigration.mpp :start-after: */ :code: NetMigration.mpp ^^^^^^^^^^^^^^^^ .. include:: code/NetMigration.mpp :start-after: NOTE(NetMigration, EN) :end-before: */ .. include:: code/NetMigration.mpp :start-after: */ :code: FemalePartnershipStatus.mpp ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. include:: code/FemalePartnershipStatus.mpp :start-after: NOTE(FemalePartnershipStatus, EN) :end-before: */ .. include:: code/FemalePartnershipStatus.mpp :start-after: */ :code: PartnerMatching.mpp ^^^^^^^^^^^^^^^^^^^ .. include:: code/PartnerMatching.mpp :start-after: NOTE(PartnerMatching, EN) :end-before: */ .. include:: code/PartnerMatching.mpp :start-after: */ :code: FamilyLinks.mpp ^^^^^^^^^^^^^^^ .. include:: code/FamilyLinks.mpp :start-after: NOTE(FamilyLinks, EN) :end-before: */ .. include:: code/FamilyLinks.mpp :start-after: */ :code: BirthDays.mpp ^^^^^^^^^^^^^ .. include:: code/BirthDays.mpp :start-after: NOTE(BirthDays, EN) :end-before: */ .. include:: code/BirthDays.mpp :start-after: */ :code: CalendarYearChange.mpp ^^^^^^^^^^^^^^^^^^^^^^ .. include:: code/CalendarYearChange.mpp :start-after: NOTE(CalendarYearChange, EN) :end-before: */ .. include:: code/CalendarYearChange.mpp :start-after: */ :code: Accounting Modules ------------------ NtaBase.mpp ^^^^^^^^^^^ .. include:: code/NtaBase.mpp :start-after: NOTE(NtaBase, EN) :end-before: */ .. include:: code/NtaBase.mpp :start-after: */ :code: NtaIndicators.mpp ^^^^^^^^^^^^^^^^^ .. include:: code/NtaIndicators.mpp :start-after: NOTE(NtaIndicators, EN) :end-before: */ .. include:: code/NtaIndicators.mpp :start-after: */ :code: NtaFullGenAccounts.mpp ^^^^^^^^^^^^^^^^^^^^^^ .. include:: code/NtaFullGenAccounts.mpp :start-after: NOTE(NtaFullGenAccounts, EN) :end-before: */ .. include:: code/NtaFullGenAccounts.mpp :start-after: */ :code: Output Modules -------------- MicroDataOutput.mpp ^^^^^^^^^^^^^^^^^^^ .. include:: code/MicroDataOutput.mpp :start-after: NOTE(MicroDataOutput, EN) :end-before: */ .. include:: code/MicroDataOutput.mpp :start-after: */ :code: TablesPopulation.mpp ^^^^^^^^^^^^^^^^^^^^ .. include:: code/TablesPopulation.mpp :start-after: NOTE(TablesPopulation, EN) :end-before: */ .. include:: code/TablesPopulation.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: TablesFertility.mpp ^^^^^^^^^^^^^^^^^^^ .. include:: code/TablesFertility.mpp :start-after: NOTE(TablesFertility, EN) :end-before: */ .. include:: code/TablesFertility.mpp :start-after: */ :code: TablesMigration.mpp ^^^^^^^^^^^^^^^^^^^ .. include:: code/TablesMigration.mpp :start-after: NOTE(TablesMigration, EN) :end-before: */ .. include:: code/TablesMigration.mpp :start-after: */ :code: TablesMortality.mpp ^^^^^^^^^^^^^^^^^^^ .. include:: code/TablesMortality.mpp :start-after: NOTE(TablesMortality, EN) :end-before: */ .. include:: code/TablesMortality.mpp :start-after: */ :code: TablesNtaBasics.mpp ^^^^^^^^^^^^^^^^^^^ .. include:: code/TablesNtaBasics.mpp :start-after: NOTE(TablesNtaBasics, EN) :end-before: */ .. include:: code/TablesNtaBasics.mpp :start-after: */ :code: TablesNtaIndicators.mpp ^^^^^^^^^^^^^^^^^^^^^^^ .. include:: code/TablesNtaIndicators.mpp :start-after: NOTE(TablesNtaIndicators, EN) :end-before: */ .. include:: code/TablesNtaIndicators.mpp :start-after: */ :code: TablesNtaGenAccounts.mpp ^^^^^^^^^^^^^^^^^^^^^^^^ .. include:: code/TablesNtaGenAccounts.mpp :start-after: NOTE(TablesNtaGenAccounts, EN) :end-before: */ .. include:: code/TablesNtaGenAccounts.mpp :start-after: */ :code: TablesNtaValidation.mpp ^^^^^^^^^^^^^^^^^^^^^^^ .. include:: code/TablesNtaValidation.mpp :start-after: NOTE(TablesNtaValidation, EN) :end-before: */ .. include:: code/TablesNtaValidation.mpp :start-after: */ :code: TablesNtaVisualisation.mpp ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. include:: code/TablesNtaVisualisation.mpp :start-after: NOTE(TablesNtaVisualisation, EN) :end-before: */ .. include:: code/TablesNtaVisualisation.mpp :start-after: */ :code: