API Reference

This section contains the complete API documentation for CliMaPan-Lab.

• Economic Model
  • EconModel
  • Model Architecture
  • Model Components
  • Key Methods
• Economic Agents
  • Consumers
  • Firms
  • Banks
  • Government
  • Climate Module

Main Model

class climapan_lab.EconModel(parameters: Dict[str, Any])

Bases: Model

setup()

Initialize the agents and network of the model.

step()

Define the models’ events per simulation step.

initiate_step()

This internal function of the model is used to reset temporary variables or to accumulate variable every step

stepwise_forecast()

This internal function of the model is used to make forecast for some of the agents for the upcoming time step, if neccessary

stepwise_produce()

This internal function of the model is used to propagate the production of the firm agents

stepwise_after_production(eps=1e-08)

This internal function of the model is used to do jobs after production

stepwise_termination()

This internal function of the model is used to clean up and summarize stepwise variables

update(eps=1e-08)

Record metrics for analysis

end()

Record evaluation measures at the end of the simulation.

Core Parameters

Base parameters for CliMaPan-Lab economic model. This module exports the default economic parameters for the simulation.