Economic Agents

CliMaPan-Lab includes several types of economic agents with comprehensive inline documentation explaining their behavior, state management, and lifecycle within the simulation.

Consumers

The Consumer agent represents households/individuals with detailed lifecycle documentation covering income sources, consumption decisions, wealth management, employment status, and epidemiological state progression.

Key Features: * Income Management: Wages, dividends, interest, and transfers * Consumption Decisions: Based on wealth and subsistence needs * Employment Dynamics: Hiring, firing, and firm attachment * COVID Progression: SEIR-like disease dynamics by age group * Climate Effects: Wealth impacts from climate shocks

class climapan_lab.src.consumers.Consumer(model: BaseModel, agent_id: int)

Bases: Agent

A consumer agent

setup()

Override in subclasses to initialize agent attributes.

reset()

desired_C()

Calculate desired consumption based on wealth and subsistence needs

update_wealth()

Update wealth after income and consumption

receiveHiring(firmID)

Process hiring by a firm

receiveFiring()

Process firing by a firm

updateMemoryAfterHiringFiring()

Update employment memory after hiring/firing

updateMemory(unemplRate)

Track recent unemployment rates (used in wage formation early on)

setConsumption(value)

Set realized consumption value

getConsumption()

Get realized consumption value

get_desired_consumption()

Get desired consumption in physical units

update_deposit(amount)

Adjust deposit by amount

set_deposit(deposit)

Set deposit to specific value

wealth_loss(loss_percentage)

Apply wealth loss (used during climate shocks)

get_deposit()

Get current deposit level

getEmploymentState()

Check if employed worker

getUnemploymentState()

Check if unemployed worker

setEmployment(value)

Set employment status

isWorker()

Check if consumer is a worker

getSumEmploymentState()

getIdentity()

Get agent ID

getFinancialDifficultyIndicator()

setWage(wage=None)

Set wage with unemployment dole fallback

getIncome()

Get total income this period

getWage()

Get current wage

setConsumerType(consumerType)

Set consumer type (workers/capitalists/energy owners)

getConsumerType()

Get consumer type

getBelongToFirm()

Get firm ID if employed

setDiv(div)

Set dividend (only for owners)

getDiv()

Get dividend income

gov_transfer(value)

Receive government transfer

setAgeGroup(ageGroup)

Set age group (young/working/elderly)

getAgeGroup()

Get age group

setCovidState(state=None, time=None, duration=None, nextState=None)

Set COVID state with transition parameters

getCovidState()

Get full COVID state dict

getCovidStateAttr(attr)

Get specific COVID state attribute

propagateContact(inf_f, inf_c, p_firm, p_community)

Calculate infection probability from contacts

progressCovid()

Main COVID progression dispatcher by current state

setSickLeaves(date)

Record sick leave date

getSickLeaves()

Get list of sick leave dates

resetSickLeaves()

Clear sick leave records

isDead()

Check if consumer is dead

isEmployed()

Check if consumer is employed

setObtainedCredit(obtainedCredit)

Set obtained credit amount

getObtainedCredit()

Get obtained credit amount

setDead()

Zero-out economic state and mark as dead

Firms

All firm types inherit from GoodsFirmBase which provides comprehensive documentation covering the monthly production lifecycle, financial management, labor relations, and policy interactions.

Firm Lifecycle (Monthly): 1. Planning: Set production targets and budget requirements 2. Hiring: Labor market participation and wage calculation 3. Production: Physical production function execution 4. Sales: Market transactions and price setting 5. Settlement: Cost accounting, profit calculation, capital updates 6. Taxes/Dividends: Policy compliance and owner income distribution

Consumer Goods Firms

Produce final consumption goods with demand-driven production planning.

class climapan_lab.src.firms.ConsumerGoodsFirm(model: BaseModel, agent_id: int)

Bases: GoodsFirmBase

A ConsumerGoodsFirm agent

setup()

Override in subclasses to initialize agent attributes.

prepareForecast()

Reset per-step aggregates and scope the current consumer pool.

calculate_input_demand()

Plan production and input demands based on demand forecasts.

produce()

Calculate actual production based on inputs and sick leave adjustments.

price_setting()

Function to set price base on mark up over cost

compute_net_profit(eps=1e-08)

Calculate profit after all costs, taxes, and owner payments

update_capital_growth()

Update capital growth from purchases

Capital Goods Firms

Produce capital equipment for other firms with investment-driven demand.

class climapan_lab.src.firms.CapitalGoodsFirm(model: BaseModel, agent_id: int)

Bases: GoodsFirmBase

A CapitalGoodsFirm agent

setup()

Override in subclasses to initialize agent attributes.

prepareForecast()

Reset per-step aggregates and scope the current employee pool.

calculate_input_demand()

Plan production and inputs using simple exponential smoothing.

produce()

Calculate actual production based on inputs and sick leave adjustments.

price_setting()

Function to set price base on mark up over cost

compute_net_profit(eps=1e-08)

Calculate profit after all costs, taxes, and owner payments

update_capital_growth()

Update internal capital growth target

Energy Firms

Provide energy inputs to production with environmental impact differentiation.

class climapan_lab.src.firms.GreenEnergyFirm(model: BaseModel, agent_id: int)

Bases: EnergyFirmBase

A GreenEnergyFirm agent

setup()

Override in subclasses to initialize agent attributes.

class climapan_lab.src.firms.BrownEnergyFirm(model: BaseModel, agent_id: int)

Bases: EnergyFirmBase

A BrownEnergyFirm agent

setup()

Override in subclasses to initialize agent attributes.

Banks

class climapan_lab.src.banks.Bank(model: BaseModel, agent_id: int)

Bases: Agent

A bank agent

setup()

Override in subclasses to initialize agent attributes.

agentAssign()

sommaW(eps=1e-08)

This internal function of the Bank class is used to propagate the main functions of the bank

reset_bank()

Government

class climapan_lab.src.governments.Government(model: BaseModel, agent_id: int)

Bases: Agent

A government agent

setup()

Override in subclasses to initialize agent attributes.

checkConsistency()

agentAssign()

transfer_expenditure(value)

E_Gov()

UE_Gov()

update_budget(value)

issue_bond()

Climate Module

The Climate module provides comprehensive step-by-step documentation of climate dynamics including emissions tracking, CO₂ concentration updates, temperature changes, and economic impact calculations.

Climate Process (Monthly): 1. Emissions Aggregation: Collect and scale emissions from all firms 2. Carbon Cycle Update: CO₂ concentration with accumulation and mean-reversion 3. Temperature Dynamics: Radiative forcing and e-folding temperature updates 4. Shock Detection: Climate threshold monitoring and trigger activation 5. Damage Calculation: Economic and mortality impact assessment

Shock Types: * Aggregate Population: Population-level mortality impacts * Idiosyncratic: Individual-level survival calculations

class climapan_lab.src.climate.Climate(model: BaseModel, agent_id: int)

Bases: Agent

setup()

Override in subclasses to initialize agent attributes.

initGDP(GDP)

Store baseline GDP for normalization in damage functions or shock scaling.

initAggregatedIncome()

Store baseline aggregate income (wage + non-wage) for later shock scaling.

progress(list_firm)

Advance the climate system by one economic period (called monthly from EconModel).

Steps:

1. Aggregate emissions from firms (green vs brown).

2. Update CO2 concentration with accumulation & reversion.

3. Compute radiative forcing and update temperature using e-folding time.

4. If temperature jump condition met, compute & flag a climate shock.

process_aggregate_damage()

Compute aggregate damages:

• ETD (economic/output) as a function of GDP, concentration ratio, and parameters.

• ETM (labor/employment) as a function of workers_t, GDP ratio, and parameters.

These are stored as attributes and can be recorded/used elsewhere.

getPM()

Return population mortality (PM) computed for aggregate shocks.

getAliveConsumersPostShock()

Return the computed number of post-shock survivors for idiosyncratic shocks.