repast4py package

Submodules

• repast4py.context module
  • SharedContext
    • SharedContext.add()
    • SharedContext.add_projection()
    • SharedContext.add_value_layer()
    • SharedContext.agent()
    • SharedContext.agents()
    • SharedContext.contains_type()
    • SharedContext.get_projection()
    • SharedContext.ghost_agent()
    • SharedContext.move_agents()
    • SharedContext.remove()
    • SharedContext.request_agents()
    • SharedContext.size()
    • SharedContext.synchronize()
• repast4py.core module
  • Agent
    • Agent.id
    • Agent.local_rank
    • Agent.type
    • Agent.uid
    • Agent.uid_rank
  • AgentManager
    • AgentManager.add_ghost()
    • AgentManager.add_ghosts_to_projection()
    • AgentManager.add_local()
    • AgentManager.add_req_ghost()
    • AgentManager.delete_ghost()
    • AgentManager.delete_ghosted()
    • AgentManager.delete_local()
    • AgentManager.get_ghost()
    • AgentManager.get_local()
    • AgentManager.is_ghosted_to()
    • AgentManager.is_requested()
    • AgentManager.remove_ghost()
    • AgentManager.remove_local()
    • AgentManager.set_as_ghosted()
    • AgentManager.tag_as_ghosted()
    • AgentManager.untag_as_ghosted()
  • BoundedProjection
  • GhostAgent
    • GhostAgent.agent
    • GhostAgent.ref_count
  • GhostedAgent
    • GhostedAgent.agent
    • GhostedAgent.ghost_ranks
  • SharedProjection
• repast4py.checkpoint module
  • Checkpoint
    • Checkpoint.restore()
    • Checkpoint.restore_agents()
    • Checkpoint.restore_network()
    • Checkpoint.restore_random()
    • Checkpoint.restore_schedule()
    • Checkpoint.restore_space()
    • Checkpoint.save()
    • Checkpoint.save_agents()
    • Checkpoint.save_network()
    • Checkpoint.save_random()
    • Checkpoint.save_schedule()
    • Checkpoint.save_space()
  • DEFAULT_TAG
  • IGNORE_EVT
• repast4py.geometry module
  • BoundingBox
    • BoundingBox.xextent
    • BoundingBox.xmin
    • BoundingBox.yextent
    • BoundingBox.ymin
    • BoundingBox.zextent
    • BoundingBox.zmin
  • find_1d_nghs_periodic()
  • find_1d_nghs_sticky()
  • find_2d_nghs_periodic()
  • find_2d_nghs_sticky()
  • find_3d_nghs_periodic()
  • find_3d_nghs_sticky()
  • get_num_dims()
• repast4py.logging module
  • DCDataSource
    • DCDataSource.dtype
    • DCDataSource.name
    • DCDataSource.value
  • DataSource
    • DataSource.dtype
    • DataSource.name
    • DataSource.value
  • ReducingDataLogger
    • ReducingDataLogger.dtype
    • ReducingDataLogger.log()
    • ReducingDataLogger.name
    • ReducingDataLogger.reduce()
    • ReducingDataLogger.size
  • ReducingDataSet
    • ReducingDataSet.close()
    • ReducingDataSet.log()
    • ReducingDataSet.write()
  • TabularLogger
    • TabularLogger.close()
    • TabularLogger.log_row()
    • TabularLogger.write()
  • create_loggers()
• repast4py.network module
  • DirectedSharedNetwork
    • DirectedSharedNetwork.graph
    • DirectedSharedNetwork.comm
    • DirectedSharedNetwork.names
    • DirectedSharedNetwork.add_edge()
    • DirectedSharedNetwork.is_directed
    • DirectedSharedNetwork.num_edges()
  • SharedNetwork
    • SharedNetwork.graph
    • SharedNetwork.add()
    • SharedNetwork.add_edge()
    • SharedNetwork.add_nodes()
    • SharedNetwork.clear_edges()
    • SharedNetwork.contains_edge()
    • SharedNetwork.edge_count
    • SharedNetwork.is_directed
    • SharedNetwork.node_count
    • SharedNetwork.num_edges()
    • SharedNetwork.remove()
    • SharedNetwork.remove_edge()
    • SharedNetwork.update_edge()
  • UndirectedSharedNetwork
    • UndirectedSharedNetwork.graph
    • UndirectedSharedNetwork.comm
    • UndirectedSharedNetwork.name
    • UndirectedSharedNetwork.add_edge()
    • UndirectedSharedNetwork.is_directed
    • UndirectedSharedNetwork.num_edges()
  • read_network()
  • write_network()
• repast4py.parameters module
  • create_args_parser()
  • init_params()
  • params
• repast4py.random module
  • default_rng
  • init()
  • seed
• repast4py.schedule module
  • EvtType
    • EvtType.END
    • EvtType.ONE_TIME
    • EvtType.REPEATING
    • EvtType.STOP
    • EvtType.VOID
  • OneTimeEvent
    • OneTimeEvent.reschedule()
    • OneTimeEvent.void()
  • PriorityType
    • PriorityType.BY_PRIORITY
    • PriorityType.FIRST
    • PriorityType.LAST
    • PriorityType.RANDOM
  • RepeatingEvent
    • RepeatingEvent.reschedule()
    • RepeatingEvent.void()
  • Schedule
    • Schedule.execute()
    • Schedule.next_tick()
    • Schedule.schedule_event()
    • Schedule.schedule_repeating_event()
  • ScheduleGroup
    • ScheduleGroup.add_evt()
    • ScheduleGroup.execute()
    • ScheduleGroup.execute_evts()
    • ScheduleGroup.reset()
    • ScheduleGroup.size
    • ScheduleGroup.sort()
  • ScheduledEvent
    • ScheduledEvent.reschedule()
    • ScheduledEvent.void()
  • SharedScheduleRunner
    • SharedScheduleRunner.execute()
    • SharedScheduleRunner.schedule_end_event()
    • SharedScheduleRunner.schedule_event()
    • SharedScheduleRunner.schedule_repeating_event()
    • SharedScheduleRunner.schedule_stop()
    • SharedScheduleRunner.stop()
    • SharedScheduleRunner.tick()
  • create_arg_evt()
  • init_schedule_runner()
  • runner()
• repast4py.space module
  • BorderType
    • BorderType.Periodic
    • BorderType.Sticky
  • CartesianTopology
    • CartesianTopology.comm
    • CartesianTopology.compute_buffer_nghs()
    • CartesianTopology.coordinates
    • CartesianTopology.local_bounds
    • CartesianTopology.procs_per_dim
  • ContinuousPoint
    • ContinuousPoint._reset_from_array()
    • ContinuousPoint.coordinates
    • ContinuousPoint.x
    • ContinuousPoint.y
    • ContinuousPoint.z
  • ContinuousSpace
    • ContinuousSpace.add()
    • ContinuousSpace.contains()
    • ContinuousSpace.get_agent()
    • ContinuousSpace.get_agents()
    • ContinuousSpace.get_agents_within()
    • ContinuousSpace.get_location()
    • ContinuousSpace.move()
    • ContinuousSpace.name
    • ContinuousSpace.remove()
  • DiscretePoint
    • DiscretePoint._reset_from_array()
    • DiscretePoint.coordinates
    • DiscretePoint.x
    • DiscretePoint.y
    • DiscretePoint.z
  • Grid
    • Grid.add()
    • Grid.contains()
    • Grid.get_agent()
    • Grid.get_agents()
    • Grid.get_location()
    • Grid.move()
    • Grid.name
    • Grid.remove()
  • OccupancyType
    • OccupancyType.Multiple
    • OccupancyType.Single
  • SharedCSpace
    • SharedCSpace.add()
    • SharedCSpace.contains()
    • SharedCSpace.get_agent()
    • SharedCSpace.get_agents()
    • SharedCSpace.get_agents_within()
    • SharedCSpace.get_local_bounds()
    • SharedCSpace.get_location()
    • SharedCSpace.get_num_agents()
    • SharedCSpace.get_random_local_pt()
    • SharedCSpace.move()
    • SharedCSpace.name
    • SharedCSpace.remove()
  • SharedGrid
    • SharedGrid.add()
    • SharedGrid.contains()
    • SharedGrid.get_agent()
    • SharedGrid.get_agents()
    • SharedGrid.get_local_bounds()
    • SharedGrid.get_location()
    • SharedGrid.get_num_agents()
    • SharedGrid.get_random_local_pt()
    • SharedGrid.move()
    • SharedGrid.name
    • SharedGrid.remove()
• repast4py.util module
  • find_free_filename()
  • is_empty()
• repast4py.value_layer module
  • ReadWriteValueLayer
    • ReadWriteValueLayer.bounds
    • ReadWriteValueLayer.get()
    • ReadWriteValueLayer.get_nghs()
    • ReadWriteValueLayer.read_grid
    • ReadWriteValueLayer.set()
    • ReadWriteValueLayer.swap_layers()
    • ReadWriteValueLayer.write_grid
  • SharedValueLayer
  • ValueLayer
    • ValueLayer.bounds
    • ValueLayer.get()
    • ValueLayer.get_nghs()
    • ValueLayer.grid
    • ValueLayer.set()

Module contents

repast4py is an agent-based modeling framework for distributed simulation.

The MPI namespace used throughout repast4py is available as:

from repast4py import MPI

In the default build this is the real mpi4py.MPI. When repast4py is built single-rank (with the R4PY_NO_MPI environment variable set), it is instead a pure-Python substitute that requires neither a native MPI library nor mpi4py: in that case MPI.COMM_WORLD has size 1, rank 0, and all collective operations are identities / no-ops. Either way, MPI.COMM_WORLD is the communicator passed to shared projections and contexts.