CliMaPan-Lab Documentation
==========================

.. image:: https://img.shields.io/badge/python-3.8+-blue.svg
   :target: https://www.python.org/downloads/
   :alt: Python 3.8+

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
   :target: https://opensource.org/licenses/MIT
   :alt: License: MIT

.. image:: https://github.com/a11to1n3/CliMaPan-Lab/workflows/CI/badge.svg
   :target: https://github.com/a11to1n3/CliMaPan-Lab/actions
   :alt: CI Status

Welcome to CliMaPan-Lab
-----------------------

CliMaPan-Lab is a comprehensive agent-based economic modeling framework that integrates 
climate change and pandemic dynamics. This documentation provides detailed information 
about installation, usage, API reference, and examples.

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   installation
   quickstart
   climate

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   api/index

.. toctree::
   :maxdepth: 2
   :caption: Model Documentation

   odd_protocol

.. toctree::
   :maxdepth: 1
   :caption: Development

   contributing
   changelog
   license

Key Features
------------

* **Agent-Based Modeling**: Comprehensive economic agents including consumers, firms, banks, and government
* **Climate Integration**: Climate shocks and economic impacts modeling with detailed step-by-step dynamics
* **Pandemic Dynamics**: COVID-19 effects on economic activity with SEIR-like disease progression
* **Policy Analysis**: Carbon taxes, fiscal policies, and intervention scenarios
* **Flexible Scenarios**: Various economic and environmental conditions
* **Comprehensive Testing**: 60+ tests across 5 categories ensuring reliability
* **Extensive Documentation**: Well-documented codebase with detailed inline comments explaining agent lifecycles, simulation flow, and component interactions

Quick Links
-----------

* :doc:`installation` - Get started with installing CliMaPan-Lab
* :doc:`quickstart` - Run your first simulation
* :doc:`api/index` - Complete API documentation

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

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