metawards.movers.go_ward

metawards.movers.go_ward(generator: MoveGenerator, network: _Union[Network, Networks], infections: Infections, rngs, nthreads: int = 1, record: MoveRecord = None, **kwargs) → None

This go function will move individuals according to the flexible move specification described by the passed ‘generator’.

If you want a record of all moves, then pass in ‘record’, which will be updated.

Parameters
  • generator (MoveGenerator) – Fully describes all of the moves that should be performed

  • network (Network or Networks) – The network(s) in which the individuals will be moved

  • infections (Infections) – Current record of infections

  • nthreads (int) – Number of threads over which to parallelise the move

  • rngs – Thread-safe random number generators used to choose the fraction of individuals

  • record (MoveRecord) – An optional record to which to record the moves that are performed