APIs

• Model
  • Model
    • Model.running
    • Model.steps
    • Model.random
    • Model.rng
    • Model.agents
    • Model.agent_types
    • Model.agents_by_type
    • Model.register_agent()
    • Model.deregister_agent()
    • Model.run_model()
    • Model.step()
    • Model.reset_randomizer()
    • Model.reset_rng()
    • Model.remove_all_agents()
• Agent
  • Agent
    • Agent.model
    • Agent.unique_id
    • Agent.pos
    • Agent.remove()
    • Agent.step()
    • Agent.create_agents()
    • Agent.random
    • Agent.rng
  • AgentSet
    • AgentSet.model
    • AgentSet.select()
    • AgentSet.shuffle()
    • AgentSet.sort()
    • AgentSet.do()
    • AgentSet.shuffle_do()
    • AgentSet.map()
    • AgentSet.agg()
    • AgentSet.get()
    • AgentSet.set()
    • AgentSet.add()
    • AgentSet.discard()
    • AgentSet.remove()
    • AgentSet.groupby()
    • AgentSet.clear()
    • AgentSet.count()
    • AgentSet.index()
    • AgentSet.isdisjoint()
    • AgentSet.pop()
  • GroupBy
    • GroupBy.groups
    • GroupBy.map()
    • GroupBy.do()
    • GroupBy.count()
    • GroupBy.agg()
• Spaces
  • Classes
  • accept_tuple_argument()
  • is_integer()
  • warn_if_agent_has_position_already()
  • is_single_argument_function()
  • PropertyLayer
    • PropertyLayer.name
    • PropertyLayer.width
    • PropertyLayer.height
    • PropertyLayer.data
    • PropertyLayer.set_cell()
    • PropertyLayer.set_cells()
    • PropertyLayer.modify_cell()
    • PropertyLayer.modify_cells()
    • PropertyLayer.select_cells()
    • PropertyLayer.aggregate_property()
  • SingleGrid
    • SingleGrid.remove_agent()
    • SingleGrid.add_property_layer()
    • SingleGrid.agents
    • SingleGrid.coord_iter()
    • SingleGrid.default_val()
    • SingleGrid.empty_mask
    • SingleGrid.exists_empty_cells()
    • SingleGrid.get_neighborhood()
    • SingleGrid.get_neighborhood_mask()
    • SingleGrid.get_neighbors()
    • SingleGrid.is_cell_empty()
    • SingleGrid.iter_neighborhood()
    • SingleGrid.iter_neighbors()
    • SingleGrid.move_agent()
    • SingleGrid.move_agent_to_one_of()
    • SingleGrid.move_to_empty()
    • SingleGrid.out_of_bounds()
    • SingleGrid.remove_property_layer()
    • SingleGrid.select_cells()
    • SingleGrid.swap_pos()
    • SingleGrid.torus_adj()
  • MultiGrid
    • MultiGrid.default_val()
    • MultiGrid.remove_agent()
    • MultiGrid.iter_neighbors()
    • MultiGrid.add_property_layer()
    • MultiGrid.agents
    • MultiGrid.coord_iter()
    • MultiGrid.empty_mask
    • MultiGrid.exists_empty_cells()
    • MultiGrid.get_neighborhood()
    • MultiGrid.get_neighborhood_mask()
    • MultiGrid.get_neighbors()
    • MultiGrid.is_cell_empty()
    • MultiGrid.iter_neighborhood()
    • MultiGrid.move_agent()
    • MultiGrid.move_agent_to_one_of()
    • MultiGrid.move_to_empty()
    • MultiGrid.out_of_bounds()
    • MultiGrid.remove_property_layer()
    • MultiGrid.select_cells()
    • MultiGrid.swap_pos()
    • MultiGrid.torus_adj()
  • HexSingleGrid
    • HexSingleGrid.add_property_layer()
    • HexSingleGrid.agents
    • HexSingleGrid.coord_iter()
    • HexSingleGrid.default_val()
    • HexSingleGrid.empty_mask
    • HexSingleGrid.exists_empty_cells()
    • HexSingleGrid.get_neighborhood()
    • HexSingleGrid.get_neighborhood_mask()
    • HexSingleGrid.get_neighbors()
    • HexSingleGrid.is_cell_empty()
    • HexSingleGrid.iter_neighborhood()
    • HexSingleGrid.iter_neighbors()
    • HexSingleGrid.move_agent()
    • HexSingleGrid.move_agent_to_one_of()
    • HexSingleGrid.move_to_empty()
    • HexSingleGrid.out_of_bounds()
    • HexSingleGrid.remove_agent()
    • HexSingleGrid.remove_property_layer()
    • HexSingleGrid.select_cells()
    • HexSingleGrid.swap_pos()
    • HexSingleGrid.torus_adj()
  • HexMultiGrid
    • HexMultiGrid.add_property_layer()
    • HexMultiGrid.agents
    • HexMultiGrid.coord_iter()
    • HexMultiGrid.default_val()
    • HexMultiGrid.empty_mask
    • HexMultiGrid.exists_empty_cells()
    • HexMultiGrid.get_neighborhood()
    • HexMultiGrid.get_neighborhood_mask()
    • HexMultiGrid.get_neighbors()
    • HexMultiGrid.is_cell_empty()
    • HexMultiGrid.iter_neighborhood()
    • HexMultiGrid.iter_neighbors()
    • HexMultiGrid.move_agent()
    • HexMultiGrid.move_agent_to_one_of()
    • HexMultiGrid.move_to_empty()
    • HexMultiGrid.out_of_bounds()
    • HexMultiGrid.remove_agent()
    • HexMultiGrid.remove_property_layer()
    • HexMultiGrid.select_cells()
    • HexMultiGrid.swap_pos()
    • HexMultiGrid.torus_adj()
  • ContinuousSpace
    • ContinuousSpace.agents
    • ContinuousSpace.move_agent()
    • ContinuousSpace.remove_agent()
    • ContinuousSpace.get_neighbors()
    • ContinuousSpace.get_heading()
    • ContinuousSpace.get_distance()
    • ContinuousSpace.torus_adj()
    • ContinuousSpace.out_of_bounds()
  • NetworkGrid
    • NetworkGrid.agents
    • NetworkGrid.default_val()
    • NetworkGrid.get_neighborhood()
    • NetworkGrid.get_neighbors()
    • NetworkGrid.move_agent()
    • NetworkGrid.remove_agent()
    • NetworkGrid.is_cell_empty()
    • NetworkGrid.get_cell_list_contents()
    • NetworkGrid.get_all_cell_contents()
    • NetworkGrid.iter_cell_list_contents()
• Discrete Space
  • Cell
    • Cell.coordinate
    • Cell.agents
    • Cell.capacity
    • Cell.random
    • Cell.add_agent()
    • Cell.agents
    • Cell.connect()
    • Cell.disconnect()
    • Cell.get_neighborhood()
    • Cell.is_empty
    • Cell.is_full
    • Cell.neighborhood
    • Cell.remove_agent()
  • CellAgent
    • CellAgent.cell
    • CellAgent.remove()
  • CellCollection
    • CellCollection.cells
    • CellCollection.agents
    • CellCollection.random
    • CellCollection.select()
    • CellCollection.select_random_agent()
    • CellCollection.select_random_cell()
  • DiscreteSpace
    • DiscreteSpace.capacity
    • DiscreteSpace.all_cells
    • DiscreteSpace.random
    • DiscreteSpace.cell_klass
    • DiscreteSpace.empties
    • DiscreteSpace.property_layers
    • DiscreteSpace.add_cell()
    • DiscreteSpace.add_connection()
    • DiscreteSpace.agents
    • DiscreteSpace.all_cells
    • DiscreteSpace.empties
    • DiscreteSpace.remove_cell()
    • DiscreteSpace.remove_connection()
    • DiscreteSpace.select_random_empty_cell()
  • FixedAgent
    • FixedAgent.remove()
  • Grid
    • Grid.dimensions
    • Grid.torus
    • Grid.capacity
    • Grid.random
    • Grid._try_random
    • Grid.height
    • Grid.select_random_empty_cell()
    • Grid.width
  • Grid2DMovingAgent
    • Grid2DMovingAgent.move()
  • HexGrid
  • Network
    • Network.add_cell()
    • Network.add_connection()
    • Network.remove_cell()
    • Network.remove_connection()
  • OrthogonalMooreGrid
  • OrthogonalVonNeumannGrid
  • PropertyLayer
    • PropertyLayer.name
    • PropertyLayer.dimensions
    • PropertyLayer.data
    • PropertyLayer.aggregate()
    • PropertyLayer.from_data()
    • PropertyLayer.modify_cells()
    • PropertyLayer.select_cells()
    • PropertyLayer.set_cells()
  • VoronoiGrid
  • Cell
    • Cell.coordinate
    • Cell.agents
    • Cell.capacity
    • Cell.random
    • Cell.connect()
    • Cell.disconnect()
    • Cell.add_agent()
    • Cell.remove_agent()
    • Cell.is_empty
    • Cell.is_full
    • Cell.agents
    • Cell.neighborhood
    • Cell.get_neighborhood()
  • HasCellProtocol
  • HasCell
  • BasicMovement
    • BasicMovement.move_to()
    • BasicMovement.move_relative()
  • FixedCell
  • CellAgent
    • CellAgent.cell
    • CellAgent.remove()
  • FixedAgent
    • FixedAgent.remove()
  • Grid2DMovingAgent
    • Grid2DMovingAgent.move()
  • CellCollection
    • CellCollection.cells
    • CellCollection.agents
    • CellCollection.random
    • CellCollection.select_random_cell()
    • CellCollection.select_random_agent()
    • CellCollection.select()
  • DiscreteSpace
    • DiscreteSpace.capacity
    • DiscreteSpace.all_cells
    • DiscreteSpace.random
    • DiscreteSpace.cell_klass
    • DiscreteSpace.empties
    • DiscreteSpace.property_layers
    • DiscreteSpace.agents
    • DiscreteSpace.add_cell()
    • DiscreteSpace.remove_cell()
    • DiscreteSpace.add_connection()
    • DiscreteSpace.remove_connection()
    • DiscreteSpace.all_cells
    • DiscreteSpace.empties
    • DiscreteSpace.select_random_empty_cell()
  • pickle_gridcell()
  • unpickle_gridcell()
  • Grid
    • Grid.dimensions
    • Grid.torus
    • Grid.capacity
    • Grid.random
    • Grid._try_random
    • Grid.width
    • Grid.height
    • Grid.select_random_empty_cell()
  • OrthogonalMooreGrid
  • OrthogonalVonNeumannGrid
  • HexGrid
  • Network
    • Network.add_cell()
    • Network.remove_cell()
    • Network.add_connection()
    • Network.remove_connection()
  • Delaunay
    • Delaunay.add_point()
    • Delaunay.export_triangles()
    • Delaunay.export_voronoi_regions()
  • VoronoiGrid
• Data collection
  • DataCollector
    • DataCollector.collect()
    • DataCollector.add_table_row()
    • DataCollector.get_model_vars_dataframe()
    • DataCollector.get_agent_vars_dataframe()
    • DataCollector.get_agenttype_vars_dataframe()
    • DataCollector.get_table_dataframe()
• Batchrunner
  • batch_run()
• Visualization
  • Jupyter Visualization
    • create_space_component()
    • split_model_params()
    • check_param_is_fixed()
    • make_initial_grid_layout()
    • copy_renderer()
    • AgentPortrayalStyle
    • PropertyLayerStyle
    • make_altair_space()
    • make_mpl_plot_component()
    • make_mpl_space_component()
    • make_plot_component()
    • make_space_component()
  • User Parameters
    • UserParam
    • Slider
  • Matplotlib-based visualizations
    • make_space_matplotlib()
    • make_mpl_space_component()
    • make_plot_measure()
    • make_mpl_plot_component()
    • collect_agent_data()
    • draw_space()
    • draw_property_layers()
    • draw_orthogonal_grid()
    • draw_hex_grid()
    • draw_network()
    • draw_continuous_space()
    • draw_voronoi_grid()
  • Altair-based visualizations
    • make_space_altair()
    • make_altair_space()
    • chart_property_layers()
    • make_altair_plot_component()
  • Command Console
    • ConsoleEntry
    • CaptureOutput
    • InteractiveConsole
    • ConsoleManager
    • format_command_html()
    • format_output_html()
  • Portrayal Components
    • AgentPortrayalStyle
    • PropertyLayerStyle
  • Backends
    • AltairBackend
    • MatplotlibBackend
    • AbstractRenderer
    • AltairBackend
    • MatplotlibBackend
  • Space Renderer
    • SpaceRenderer
  • Space Drawers
    • BaseSpaceDrawer
    • OrthogonalSpaceDrawer
    • HexSpaceDrawer
    • NetworkSpaceDrawer
    • ContinuousSpaceDrawer
    • VoronoiSpaceDrawer
• Experimental
  • Devs
    • Priority
    • SimulationEvent
    • EventList
    • Simulator
    • ABMSimulator
    • DEVSimulator
  • Continuous Space
    • ContinuousSpace
    • HasPositionProtocol
    • ContinuousSpaceAgent
  • Continuous Space
    • ContinuousSpace
    • HasPositionProtocol
    • ContinuousSpaceAgent