MetaWards.movers API Detail

Functions

go_isolate(network[, go_from, …])

This go function will move individuals from the “from” demographic(s) to the “to” demographic if they show any signs of infection (the disease stage is greater or equal to ‘self_isolate_stage’.

go_record(moves, network, Networks], …)

This go function will perform all (or as many possible) moves from the passed ‘moves’ MoveRecord.

go_stage([go_from, from_demographic, go_to, …])

This go function will move individuals from the “go_from” demographic(s) to the “go_to” demographic, as well as the ‘from_stage’ disease stage(s) to the ‘to_stage’ diseaes stage(s).

go_to([go_from, from_demographic, go_to, …])

This go function will move individuals from the “go_from” demographic(s) to the “go_to” demographic, as well as the ‘from_stage’ disease stage(s) to the ‘to_stage’ diseaes stage(s), as well as ‘from_ward’ ward(s) to ‘to_ward’ ward(s).

go_ward(generator, network, Networks], …)

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

move_custom(custom_function, stage, **kwargs)

This returns the default list of ‘go_XXX’ functions that are called in sequence for each iteration of the model run.

move_default(**kwargs)

This is the default mover.

MoveGenerator(from_demographic, int, …)

MoveRecord()

This class holds a record of mover-initiated moves.