APIs

• Model
  • Model
    • Model.running
    • Model.steps
    • Model.time
    • Model.random
    • Model.rng
    • Model.scenario
    • Model.scenario
    • Model.agents
    • Model.agent_types
    • Model.agents_by_type
    • Model.register_agent()
    • Model.deregister_agent()
    • Model.run_model()
    • Model.step()
    • Model.batch()
    • Model.clear_all_class_subscriptions()
    • Model.clear_all_subscriptions()
    • Model.notify()
    • Model.observe()
    • Model.observe_class()
    • Model.remove_all_agents()
    • Model.suppress()
    • Model.unobserve()
    • Model.unobserve_class()
    • Model.schedule_event()
    • Model.schedule_recurring()
    • Model.run_for()
    • Model.run_until()
• Agent
  • Agent
    • Agent.model
    • Agent.unique_id
    • Agent.remove()
    • Agent.step()
    • Agent.create_agents()
    • Agent.from_dataframe()
    • Agent.random
    • Agent.rng
    • Agent.scenario
    • Agent.start_action()
    • Agent.interrupt_for()
    • Agent.cancel_action()
    • Agent.is_busy
• AgentSet
  • AbstractAgentSet
    • AbstractAgentSet.model
    • AbstractAgentSet.select()
    • AbstractAgentSet.agg()
    • AbstractAgentSet.get()
    • AbstractAgentSet.set()
    • AbstractAgentSet.to_list()
    • AbstractAgentSet.add()
    • AbstractAgentSet.discard()
    • AbstractAgentSet.remove()
    • AbstractAgentSet.groupby()
    • AbstractAgentSet.shuffle()
    • AbstractAgentSet.sort()
    • AbstractAgentSet.do()
    • AbstractAgentSet.shuffle_do()
    • AbstractAgentSet.map()
    • AbstractAgentSet.clear()
    • AbstractAgentSet.isdisjoint()
    • AbstractAgentSet.pop()
  • AgentSet
    • AgentSet.random
    • AgentSet.shuffle()
    • AgentSet.sort()
    • AgentSet.do()
    • AgentSet.shuffle_do()
    • AgentSet.map()
    • AgentSet.add()
    • AgentSet.discard()
    • AgentSet.remove()
    • AgentSet.agg()
    • AgentSet.clear()
    • AgentSet.count()
    • AgentSet.get()
    • AgentSet.groupby()
    • AgentSet.index()
    • AgentSet.isdisjoint()
    • AgentSet.pop()
    • AgentSet.select()
    • AgentSet.set()
    • AgentSet.to_list()
  • GroupBy
    • GroupBy.groups
    • GroupBy.get_group()
    • GroupBy.map()
    • GroupBy.do()
    • GroupBy.count()
    • GroupBy.agg()
• Time
  • Event
    • Event.time
    • Event.fn
    • Event.priority
    • Event.unique_id
    • Event.execute()
    • Event.cancel()
  • EventGenerator
    • EventGenerator.model
    • EventGenerator.function
    • EventGenerator.schedule
    • EventGenerator.priority
    • EventGenerator.is_active
    • EventGenerator.execution_count
    • EventGenerator.next_scheduled_time
    • EventGenerator.start()
    • EventGenerator.stop()
    • EventGenerator.pause()
    • EventGenerator.resume()
  • EventList
    • EventList.add_event()
    • EventList.peek_ahead()
    • EventList.pop_event()
    • EventList.compact()
    • EventList.is_empty()
    • EventList.remove()
    • EventList.clear()
  • Priority
    • Priority.conjugate()
    • Priority.bit_length()
    • Priority.bit_count()
    • Priority.to_bytes()
    • Priority.from_bytes()
    • Priority.as_integer_ratio()
    • Priority.is_integer()
    • Priority.real
    • Priority.imag
    • Priority.numerator
    • Priority.denominator
  • Schedule
    • Schedule.interval
    • Schedule.start
    • Schedule.end
    • Schedule.count
• Discrete Space
  • Cell
    • Cell.coordinate
    • Cell.position
    • Cell.agents
    • Cell.capacity
    • Cell.random
    • Cell.position
    • Cell.connect()
    • Cell.disconnect()
    • Cell.add_agent()
    • Cell.remove_agent()
    • Cell.is_empty
    • Cell.is_full
    • Cell.agents
    • Cell.neighborhood
    • Cell.get_neighborhood()
  • CellAgent
    • CellAgent.cell
    • CellAgent.remove()
  • 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.find_nearest_cell()
    • DiscreteSpace.add_cell()
    • DiscreteSpace.remove_cell()
    • DiscreteSpace.add_connection()
    • DiscreteSpace.remove_connection()
    • DiscreteSpace.all_cells
    • DiscreteSpace.empties
    • DiscreteSpace.select_random_empty_cell()
  • FixedAgent
    • FixedAgent.remove()
  • Grid
    • Grid.dimensions
    • Grid.torus
    • Grid.capacity
    • Grid.random
    • Grid._try_random
    • Grid.width
    • Grid.height
    • Grid.create_property_layer()
    • Grid.add_property_layer()
    • Grid.remove_property_layer()
    • Grid.get_neighborhood_mask()
    • Grid.find_nearest_cell()
    • Grid.select_random_empty_cell()
    • Grid.cells_with_capacity
    • Grid.select_random_cell_with_capacity()
  • Grid2DMovingAgent
    • Grid2DMovingAgent.move()
  • HexGrid
    • HexGrid.find_nearest_cell()
  • Network
    • Network.find_nearest_cell()
    • Network.add_cell()
    • Network.remove_cell()
    • Network.add_connection()
    • Network.remove_connection()
  • OrthogonalMooreGrid
  • OrthogonalVonNeumannGrid
  • VoronoiGrid
    • VoronoiGrid.find_nearest_cell()
  • Cell
    • Cell.coordinate
    • Cell.position
    • Cell.agents
    • Cell.capacity
    • Cell.random
    • Cell.position
    • 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
    • FixedCell.cell
  • 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.find_nearest_cell()
    • 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.create_property_layer()
    • Grid.add_property_layer()
    • Grid.remove_property_layer()
    • Grid.get_neighborhood_mask()
    • Grid.find_nearest_cell()
    • Grid.select_random_empty_cell()
    • Grid.cells_with_capacity
    • Grid.select_random_cell_with_capacity()
  • OrthogonalMooreGrid
  • OrthogonalVonNeumannGrid
  • HexGrid
    • HexGrid.find_nearest_cell()
  • Network
    • Network.find_nearest_cell()
    • Network.add_cell()
    • Network.remove_cell()
    • Network.add_connection()
    • Network.remove_connection()
  • Delaunay
    • Delaunay.add_point()
    • Delaunay.export_triangles()
    • Delaunay.export_voronoi_regions()
  • VoronoiGrid
    • VoronoiGrid.find_nearest_cell()
• 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()
• 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
  • Continuous Space
    • ContinuousSpace
    • HasPositionProtocol
    • ContinuousSpaceAgent
  • Continuous Space
    • ContinuousSpace
    • HasPositionProtocol
    • ContinuousSpaceAgent
  • Scenarios
    • rescale_samples()
    • Scenario