API Reference

This part of the documentation covers all the interfaces of archABM. For parts where archABM depends on external libraries, we document the most important right here and provide links to the canonical documentation.

Actions(env, db)	Actions applied to any asset in Database
AerosolModel(params)	Aerosol transmission estimator
Creator(env, config, db)	Initializes the required assets to run a simulation: Options, AerosolModel, Event, Place, Actions, Person.
Database()	In-memory database of the simulation components
Engine(config)	Core class of the archABM package
Event(model, place, duration)	Event primitive
Options(env, db, params)	Stores general options for the simulation
Parameters(__dict__)	Helper to access dictionary elements as class attributes
Person(env, db, params)	Person primitive
Place(env, db, params)	Place primitive
Results(config)	Simulation history processing and export
Snapshot(header)	Stores the state of an agent at a given time