metawards.movers.go_stage

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

This go function will move individuals from the “from_stage” stage(s) of the “from” demographic(s) to the “to_stage” stage of the “to” demographic. This can move a subset of individuals if ‘fraction’ is less than 1, e.g. 0.5 would move 50% of individuals (chosen using a random binomial distribution)

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 isolation demographic to send infected individuals to
• from_stage (int or list[int]) – The stage to move from (or list of stages if there are multiple from demographics)
• to_stage (int) – The stage to move to
• network (Networks) – The networks to be modelled. This must contain all of the demographics that are needed for this go function
• fraction (float or List[float]) – The fraction (percentage) of individuals who are moved.
• rngs – Thread-safe random number generators used to choose the fraction of individuals