.. Inhabit documentation master file, created by
   sphinx-quickstart on Mon Aug  7 15:44:24 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

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.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   intro
   usage
   code
   api
   calibration_workflow
   performance_analysis
   contributing

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`