Skip to content

API Reference

Complete API documentation for ElectoralSim.

Core

Class/Function Description
ElectionModel Main simulation model
Config Configuration dataclass
PartyConfig Party configuration

Behavior Models

Class Description
BehaviorEngine Combines multiple behavior models
ProximityModel Spatial/ideological voting
ValenceModel Non-policy candidate appeal
RetrospectiveModel Economic/incumbent voting
StrategicVotingModel Duverger's Law effects
WastedVoteModel Tactical voting
SociotropicPocketbookModel Economic perception

Electoral Systems

Function Description
dhondt_allocation D'Hondt seat allocation
sainte_lague_allocation Sainte-Laguë allocation
hare_quota_allocation Hare quota (LR)
droop_quota_allocation Droop quota
irv_election Instant Runoff Voting
stv_election Single Transferable Vote
approval_voting Approval voting
condorcet_winner Condorcet winner detection

Metrics

Function Description
gallagher_index Disproportionality measure
effective_number_of_parties Laakso-Taagepera ENP
efficiency_gap Gerrymandering metric

Coalition & Government

Function/Class Description
form_government Coalition formation
minimum_winning_coalitions Find MWCs
minimum_connected_winning Find MCWs
coalition_strain Calculate strain
GovernmentSimulator Stability simulation

Opinion Dynamics

Class Description
OpinionDynamics Social network opinion evolution