API
This is an overview of all functions, structs, and constructors, i.e., a collection of the docstrings. Please consult the following pages to find information about the respective topics.
| Section | Description |
|---|---|
| Batches | Structs and Functions used for running different scenarios (a batch of simulations). |
| Contacts | Structs and Functions used for creating and analyzing contact structures within the simulation. |
| Individuals | Individual agents and all related structs and functions for their behavior and characteristics. |
| Infections and Immunity | Transmission and infection related functions. |
| Interventions | Structs and functions used to created and apply intervention strategies (vaccinations, NPIs, measures, strategies). |
| Logger | Different logger. |
| Mapping | Creating an infection map. |
| Misc | Misc. Helper functions, AGS-related functions and validation. |
| Movie | Creating an infection dynamics movie. |
| Pathogens | Structs and functions related to the pathogens of the simulation. |
| Plotting | Creating plots based on simulation runs and output data. |
| Population | Collections of individuals of a simulation. |
| Post Processing | Data processing features supplying reports, plots, or other data analyses. |
| Reporting | Creating simulation reports. |
| Result Data | All processed data of a simulation run. |
| Settings | Structs and functions to specify the settings (households, schools, workplaces) within one simulation. |
| Simulation | Management of a simulation run, holding all necessary information. |