Skip to main content
Ctrl+K

RobotSwarmSimulator

  • Installation
  • User Guide
  • API Reference
  • Development
  • GitHub
  • Installation
  • User Guide
  • API Reference
  • Development
  • GitHub

Section Navigation

  • swarmsim
    • swarmsim.agent
      • swarmsim.agent.Agent
      • swarmsim.agent.DiffDriveAgent
      • swarmsim.agent.DroneAgent
      • swarmsim.agent.MazeAgent
      • swarmsim.agent.ModeSwitchingAgent
      • swarmsim.agent.StaticAgent
      • swarmsim.agent.UnicycleAgent
      • swarmsim.agent.control
        • swarmsim.agent.control.AbstractController
        • swarmsim.agent.control.AgentMethodController
        • swarmsim.agent.control.BinaryController
        • swarmsim.agent.control.Controller
        • swarmsim.agent.control.HomogeneousController
        • swarmsim.agent.control.HumanController
        • swarmsim.agent.control.LevyController
        • swarmsim.agent.control.StaticController
    • swarmsim.cache
      • swarmsim.cache.ExternalSimulationArchive
    • swarmsim.config
      • swarmsim.config.OutputTensorConfig
      • swarmsim.config.ResultsConfig
    • swarmsim.gui
      • swarmsim.gui.abstractGUI
      • swarmsim.gui.agentGUI
      • swarmsim.gui.connectivityGUI
      • swarmsim.gui.controllerGUI
      • swarmsim.gui.fullControlGUI
    • swarmsim.metrics
      • swarmsim.metrics.AbstractMetric
      • swarmsim.metrics.AgentsAtGoal
      • swarmsim.metrics.Aggregation
      • swarmsim.metrics.AlgebraicConnectivity
      • swarmsim.metrics.AngularMomentum
      • swarmsim.metrics.AverageSpeed
      • swarmsim.metrics.BehaviorFactory
      • swarmsim.metrics.BerlingerCircularity
      • swarmsim.metrics.Centroid
      • swarmsim.metrics.CirclePacking
      • swarmsim.metrics.Circliness
      • swarmsim.metrics.ConvexHull
      • swarmsim.metrics.CoordinateTest
      • swarmsim.metrics.DelaunayDispersal
      • swarmsim.metrics.DistanceSizeRatio
      • swarmsim.metrics.DistanceToGoal
      • swarmsim.metrics.GroupRotationBehavior
      • swarmsim.metrics.Orbit
      • swarmsim.metrics.PersistentHomology
      • swarmsim.metrics.RadialVariance
      • swarmsim.metrics.RandomBoxAggregation
      • swarmsim.metrics.RandomBoxSampling
      • swarmsim.metrics.ScatterBehavior
      • swarmsim.metrics.SensorOffset
      • swarmsim.metrics.SensorRotation
      • swarmsim.metrics.SensorSignal
      • swarmsim.metrics.SubGroupWrapper
      • swarmsim.metrics.TotalCollisions
    • swarmsim.sensors
      • swarmsim.sensors.AbstractSensor
      • swarmsim.sensors.BinaryFOVSensor
      • swarmsim.sensors.BinaryLOSSensor
      • swarmsim.sensors.GenomeDependentSensor
      • swarmsim.sensors.RegionalSensor
      • swarmsim.sensors.StaticSensor
    • swarmsim.util
      • swarmsim.util.asdict
      • swarmsim.util.collections
      • swarmsim.util.collider
        • swarmsim.util.collider.AABB
        • swarmsim.util.collider.AngleSensitiveCC
        • swarmsim.util.collider.Collider
      • swarmsim.util.conversion
        • swarmsim.util.conversion.ControllerConverter
      • swarmsim.util.geometry
        • swarmsim.util.geometry.ConvexHull
        • swarmsim.util.geometry.Point
        • swarmsim.util.geometry.Polygon
        • swarmsim.util.geometry.svg_extraction
      • swarmsim.util.pdutils
      • swarmsim.util.pid
      • swarmsim.util.processing
        • swarmsim.util.processing.multicoreprocessing
      • swarmsim.util.signal
        • swarmsim.util.signal.Signal
      • swarmsim.util.statistics_tools
      • swarmsim.util.timer
    • swarmsim.world
      • swarmsim.world.RectangularWorld
      • swarmsim.world.World
      • swarmsim.world.WorldIO
      • swarmsim.world.generation
        • swarmsim.world.generation.Maze
      • swarmsim.world.goals
        • swarmsim.world.goals.Goal
        • swarmsim.world.goals.GoalFactory
        • swarmsim.world.goals.GrowthRegion
      • swarmsim.world.objects
        • swarmsim.world.objects.DetectionRegion
        • swarmsim.world.objects.ObjectFactory
        • swarmsim.world.objects.StaticObject
        • swarmsim.world.objects.TriggerRegion
        • swarmsim.world.objects.Wall
        • swarmsim.world.objects.WorldObject
      • swarmsim.world.simulate
      • swarmsim.world.spawners
        • swarmsim.world.spawners.AgentSpawner
        • swarmsim.world.spawners.DonutSpawner
        • swarmsim.world.spawners.ExcelSpawner
        • swarmsim.world.spawners.FixedInit
        • swarmsim.world.spawners.Spawner
      • swarmsim.world.subscribers
        • swarmsim.world.subscribers.World2Gif
        • swarmsim.world.subscribers.WorldSubscriber
    • swarmsim.yaml
      • swarmsim.yaml.include
      • swarmsim.yaml.mathexpr
      • swarmsim.yaml.np_representer
      • swarmsim.yaml.pathlib_representer
      • swarmsim.yaml.unknown
  • API Reference
  • swarmsim
  • swarmsim.agent

swarmsim.agent#

Houses agent submodules.

Agents are the main objects in the simulation.

All agents must inherit from Agent.

Subpackages

control

Houses controller submodules.

Modules

Agent

Base Agent Config and Class to be inherited by all agents.

DiffDriveAgent

DroneAgent

MazeAgent

MazeAgent has Unicycle Dynamics and can move based on sensor info.

ModeSwitchingAgent

StaticAgent

An Agent Class and Config for a non-moving agent.

UnicycleAgent

control

Houses controller submodules.

previous

swarmsim

next

swarmsim.agent.Agent

Edit on GitHub

This Page

  • Show Source

© Copyright 2025, Connor Mattson, Kevin Zhu.

Created using Sphinx 8.2.3.

Built with the PyData Sphinx Theme 0.16.1.

Last built Jul 03, 2025.