metawards.movers.go_record¶
-
metawards.movers.
go_record
(moves: MoveRecord, network: _Union[Network, Networks], infections: Infections, record: MoveRecord = None, **kwargs) → None¶ This go function will perform all (or as many possible) moves from the passed ‘moves’ MoveRecord. This will move specific individuals between specific demographics, stages and ward(s) / ward link(s).
If you want a record of all moves, then pass in ‘record’, which will be updated.
- Parameters
moves (MoveRecord) – 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
record (MoveRecord) – An optional record to which to record the moves that are performed