Welcome to the Inhabit Model Documentation!
The Inhabit model is a powerful simulation tool designed to project and analyze the dynamics between household characteristics and dwelling stock over time. Leveraging SOEP (Socio-Economic Panel) data, it constructs a cross-tabulated inhabit matrix, providing insights into housing occupancy patterns, mobility, and demographic shifts.
This documentation serves as a comprehensive guide to understanding, using, and extending the Inhabit model.
Contents:
- Introduction to Inhabit
- Usage Guide
- Code Analysis and API Reference
- Module: Inhabit Matrix Core
- Module: Allocation Logic
- Module: Census Calibration
- Module: Dwelling Stock Management
- Module: Filters
- Module: Household Stock Management
- Module: Input Configuration
- Module: Miscellaneous Utilities
- Module: Move Out Rate Calculation
- Module: SOEP Data Loader
- Module: Household Classification
- Module: Dwelling Classification
- Module: Dwelling Stock Interface
- Module: Load Housing Model Data
- Module: Household Stock Matching (ML)
- Module: Allocation Calibration and Evaluation
- Module: Analysis Charts
- Module: Dwelling Stock Charts
- Module: Evaluation Plots
- Module: Living Space Charts
- Module: Occupation Charts
- Module: Check Values Labels
- API Reference
- inhabit_matrix
- scripts.allocation
- scripts.alloc_calibration
- scripts.census_calibration
- scripts.dwelling
- scripts.dwelling_stock
- scripts.dwell_stock_interface
- scripts.evaluation_plots
- scripts.filters
- scripts.household
- scripts.household_stock
- scripts.inputs
- scripts.load_housing_model_ds
- scripts.misc
- scripts.move_out_rate
- scripts.occupation_charts
- scripts.soep_loader
- Indices and tables
- Inhabit Data Calibration Workflow
- Performance Analysis and Optimization
- Contributing to Inhabit