Skip to content


Repository files navigation


Build Status GitHub Issues GitHub last-commit

Flee is an agent-based modelling toolkit which is purpose-built for simulating the movement of individuals across geographical locations. Flee is currently used primarily for modelling the movements of forcibly displaced persons (FDPs).

Full documentation of Flee is available at

Official releases will be done on (flee-release is deprecated and will be removed in due course.)

Parallel performance testing

Parallel tests can be performed using The interface is as follows:

mpirun -np python3 tests/ [options]

Options can be as follows:

  • "-p", "--parallelmode" - Parallelization mode ([advanced], classic, cl-hilat OR adv-lowlat).
  • "-N", "--initialagents" - Number of agents at the start of the simulation [100000].
  • "-d", "--newagentsperstep", Number of agents added per time step [1000].
  • "-t", "--simulationperiod", Duration of the simulation in days [10].

Here are a few settings good for benchmarking:

  • mpirun -np <cores> python3 -N 500000 -p advanced -d 10000 -t 10
  • mpirun -np <cores> python3 -N 500000 -p classic -d 10000 -t 10
  • mpirun -np <cores> python3 -N 500000 -p cl-hilat -d 10000 -t 10
  • mpirun -np <cores> python3 -N 500000 -p adv-lowlat -d 10000 -t 10


The development on Flee has been made possible through funding from the Horizon 2020 funded HiDALGO project (grant no. 824115, and VECMA (grant no. 800925,