metawards.movers.go_to

metawards.movers.go_to(nthreads: int = 1, **kwargs) → None

This go function will move individuals from the “from” demographic(s) to the “to” demographic. This can move a subset of individuals is ‘fraction’ is less than 1, e.g. 0.5 would move 50% of individuals.

Parameters:

• from (DemographicID or DemographicIDs) – ID (name or index) or IDs of the demographics to scan for infected individuals
• to (DemographicID) – ID (name or index) of the demographic to send infected individuals to
• network (Networks) – The networks to be modelled. This must contain all of the demographics that are needed for this go function
• fraction (float) – The fraction of individuals to move, e.g. 0.75 would move 75% of the individuals