API Reference#
This is the API reference for the swarmsim
package.
The world
contains all the objects that will be simulated.
The population
is the collection of agents in the world.
An agent
is an object that exists in the world and has volition.
A population
often has multiple agents, each of
which can have a different type, controller, or set of sensors.
spawners
can create new agents and
add them to the population
.
A world can have one or more metrics
which reduce the state
of the world. They can describe the behavior of the agents and are useful for
quantifying or training global behaviors.
A world can have subscribers
which allow user-defined
hooks to run each step()
of the simulation.
The config
module houses the initialization machinery and class registry.
The yaml
module provides additional functionality on top of PyYAML’s yaml
module.
The util
module contains miscellaneous utility functions.
The gui
module contains user interface
and other display code not related to the world simulation.