CliMaPan-Lab

Getting Started

  • Installation
    • Requirements
    • Dependencies
      • Core Dependencies
    • Installation Methods
      • Install from Source (Recommended)
      • Install from GitHub
      • Install in Development Mode
      • Virtual Environment (Recommended)
    • Verify Installation
    • Troubleshooting
      • Common Issues
      • System-specific Notes
  • Quick Start Guide
    • Basic Simulation
    • Running Different Scenarios
      • Business as Usual (BAU)
      • Carbon Tax Scenario
      • Pandemic Scenario
      • Combined Climate and Pandemic
      • Climate Damage Scenarios
    • Command Line Interface
      • Basic Run
      • With Visualization
      • Multiple Runs
      • Custom Parameters
      • Climate Damage Options
    • Analyzing Results
    • Basic Visualization
    • Key Parameters
      • Economic Settings
      • COVID Settings
      • Climate Settings
      • Simulation Settings
    • Next Steps
  • Climate Module
    • Climate Damage Types
      • AggPop (Aggregate Population)
      • Idiosyncratic
      • None
    • Climate Parameters
    • Climate Variables
    • Command Line Usage
    • Integration with Economic Scenarios
      • Carbon Tax Scenarios
      • COVID-Climate Interactions
    • Historical Context
    • Best Practices
    • Example Analysis

API Reference

  • API Reference
    • Economic Model
      • EconModel
        • EconModel.setup()
        • EconModel.step()
        • EconModel.initiate_step()
        • EconModel.stepwise_forecast()
        • EconModel.stepwise_produce()
        • EconModel.stepwise_after_production()
        • EconModel.stepwise_termination()
        • EconModel.update()
        • EconModel.end()
      • Model Architecture
      • Model Components
      • Key Methods
        • EconModel.__init__()
        • EconModel.setup()
        • EconModel.step()
        • EconModel.run()
    • Economic Agents
      • Consumers
        • Consumer
      • Firms
        • Consumer Goods Firms
        • Capital Goods Firms
        • Energy Firms
      • Banks
        • Bank
      • Government
        • Government
      • Climate Module
        • Climate
    • Main Model
      • EconModel
        • EconModel.setup()
        • EconModel.step()
        • EconModel.initiate_step()
        • EconModel.stepwise_forecast()
        • EconModel.stepwise_produce()
        • EconModel.stepwise_after_production()
        • EconModel.stepwise_termination()
        • EconModel.update()
        • EconModel.end()
    • Core Parameters

Model Documentation

  • ODD+D Protocol Documentation for CliMaPan-Lab
    • Overview
      • Purpose
      • Entities, State Variables, and Scales
      • Process Overview and Scheduling
        • Temporal Granularity
        • Stopping Condition
    • Design Concepts (ODD core + ODD+D extensions)
    • Decision Logic (ODD+D Extension)
      • Households
      • Firms
        • Exit and Replacement
      • Banks
      • Government
      • Pandemic Module
      • Bounded Rationality and Uncertainty
    • Details
      • Initialization
      • Input Data
      • Submodels
    • Appendices
      • Appendix A: Parameter Overview
      • Appendix B: Simulation Configuration and Modularity
        • Model Configuration
        • Shock Dynamics and Event Handling
      • Appendix C: Epidemic Network Structure
      • Appendix D: Model Limitations
      • Appendix E: Output Format and Data Export
      • Acronyms and Abbreviations

Development

  • Contributing to CliMaPan-Lab
    • Development Setup
    • Running Tests
    • Code Style
    • Submitting Changes
    • Documentation
    • Reporting Issues
  • Changelog
    • Version 0.1.0 (2026-01-30)
    • Version 0.0.4 (2025-08-19)
    • Version 0.0.3 (2025-07-21)
    • Version 0.0.2 (2025-07-20)
    • Version 0.0.1 (2025-07-15)
  • License
    • MIT License
CliMaPan-Lab
  • Overview: module code

All modules for which code is available

  • climapan_lab.src.banks.Bank
  • climapan_lab.src.climate.Climate
  • climapan_lab.src.consumers.Consumer
  • climapan_lab.src.firms.BrownEnergyFirm
  • climapan_lab.src.firms.CapitalGoodsFirm
  • climapan_lab.src.firms.ConsumerGoodsFirm
  • climapan_lab.src.firms.GreenEnergyFirm
  • climapan_lab.src.governments.Goverment
  • climapan_lab.src.models

© Copyright 2025, Paola D'Orazio, Anh-Duy Pham, Hong Son Nguyen.

Built with Sphinx using a theme provided by Read the Docs.