API Reference

This section provides a detailed API reference for the Inhabit model’s codebase. It leverages Sphinx’s autosummary directive to generate a high-level overview of modules, linking to more detailed documentation for each.

inhabit_matrix

Combine dwellings and households function to inhabit matrix.

scripts.allocation

Create a matrix with preferences where to move in to per household category.

scripts.alloc_calibration

This script evaluates the yearly results of the dwelling allocation process.

scripts.census_calibration

Census Calibration Module for Housing Data.

scripts.dwelling

Load dwelling information from SOEP (Socio-Economic Panel).

scripts.dwelling_stock

Dwelling Stock Management Module

scripts.dwell_stock_interface

scripts.evaluation_plots

scripts.filters

Define filters for SOEP (Socio-Economic Panel) dataframes.

scripts.household

Define functions to count households by income, household type, age and household size.

scripts.household_stock

Load household stock data and insert it into inhabit matrix.

scripts.inputs

Input configuration loader for the inhabit housing model.

scripts.load_housing_model_ds

Load all housing model related information.

scripts.misc

Define several global variables, paths and basic functions.

scripts.move_out_rate

Evaluate the inhabit matrices and move out matrices created by inhabit_matrix.py.

scripts.occupation_charts

Create charts to evaluate all inhabit tables over time.

scripts.soep_loader

Load SOEP (Socio-Economic Panel) data.

Indices and tables