MovementClause

movement_model.MovementClause()

A movement clause is basically a function which calculates how many individuals should move between all of the geo nodes, and then epymorph decides by random draw which individuals move (as identified by their disease status, or IPM compartment). It also has various settings which determine when the clause is active (for example, only move people Monday-Friday at the start of the day) and when the individuals that were moved by the clause should return home (for example, stay for two days and then return at the end of the day).

Attributes

leaves: TickIndex

On which tau step does this movement clause apply?

returns: TickDelta

When do the movers from this clause return home?

predicate: MovementPredicate

When does this movement clause apply?

Methods

Name	Description
evaluate	Implement this method to provide logic for the clause. Your implementation is free to use data, dim, and rng. You can also use defer to utilize another MovementClause instance.
is_active	Should this movement clause be applied this tick?