Function Reference

🚁 The Helipad class

The main model object used to build, run, and interface with a model.

πŸ€Ήβ€β™‚οΈ The agent and baseAgent classes

The agents who interact in a model.

Built-In Primitives

  • 🏘 MultiLevel β€” A special primitive which is also itself a full model
  • 🟦 Patch β€” forms the grid on which other agents move in a spatial model

πŸ—„ The data class

Collects and exports model data as it runs

πŸ—‚ Containers and Model Parts

The ingredients of a model, and the objects that contain them

  • 🎚 Params / Param β€” Settings that can be adjusted from the control panel
  • ⚑️ Shocks / Shock β€” Automatically shock parameters
  • 🎟 Events / Event β€” Record when a model reaches a certain condition
  • πŸ• Breeds / Breed β€” Create multiple agent types
  • πŸ’ Primitives / Primitive β€” Create different basic agent roles
  • 🧺 Goods / Good β€” Things that agents can possess and trade
  • βš“οΈ Hooks β€” insert your code into the model runtime
  • funcStore β€” A generic container class

πŸ•Έ The Edge class

Connect agents to each other.

πŸŽ› The Cpanel class

The Tkinter or Jupyer GUI for adjusting parameters before running the model.


πŸ“ˆ Visualization

Display data live as the model runs.

πŸŽ’ Miscellaneous

Utility Functions

Coordinate Systems

Data Structures