Public releases of the FLEE agent-based modelling code.
djgroen_flee-release
djgroen
Overview
Abstract
# Flee
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 refugees and internally displaces persons (IDPs).
Flee is currently closed-source, but will be released periodically under a BSD 3-clause license once the first journal paper is accepted.
## Main source files
| file name | what it does |
| -------------------------- | -------------------------------------------:|
| flee/flee.py | Main ABM kernel |
| flee/SimulationSettings.py | Data structure for global sim parameters. |
| analysis.py | Library with statistical analysis routines. |
| DataTable.py | Data Handling kernel for csv data. |
## Testing Flee
Flee consists of a range of testing scripts. These include, but are not limited to:
| script name | what it does |
| -------------------- | ------------------------------------:|
| test\_datatable.py | Test data loading from CSV |
| test\_removelink.py | Test link removal |
| test\_retrofit.py | Test time retrofitting functionality |
| test\_toy\_escape.py | Test toy escape scenario |
| test\_close\_location.py | Test closing and opening of locations |
All tests can be run with Python 3, no arguments need to be specified.
## Active simulations
| script name | what it does |
| ------------------- | ------------------------------------:|
| maliv2.py | Mali simulation |
| burundi.py | Burundi simulation |
| car.py | CAR simulation |
| ssudan-csv.py | South Sudan simulation |
| iraq-idp.py | Iraq simulation (IDPs only) |
## Perform a simple test
rm test-output/*
python3 test_csv.py > test-output/out.csv
python3 plot-flee-output.py test-output
## Run a CAR simulation
rm test-output/*
python3 car-csv.py SimSettings/default.csv > test-output/out.csv
python3 plot-flee-output.py test-output
## Run a parallel test simulation
mpirun -np <number of cores> test_par.py
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 refugees and internally displaces persons (IDPs).
Flee is currently closed-source, but will be released periodically under a BSD 3-clause license once the first journal paper is accepted.
## Main source files
| file name | what it does |
| -------------------------- | -------------------------------------------:|
| flee/flee.py | Main ABM kernel |
| flee/SimulationSettings.py | Data structure for global sim parameters. |
| analysis.py | Library with statistical analysis routines. |
| DataTable.py | Data Handling kernel for csv data. |
## Testing Flee
Flee consists of a range of testing scripts. These include, but are not limited to:
| script name | what it does |
| -------------------- | ------------------------------------:|
| test\_datatable.py | Test data loading from CSV |
| test\_removelink.py | Test link removal |
| test\_retrofit.py | Test time retrofitting functionality |
| test\_toy\_escape.py | Test toy escape scenario |
| test\_close\_location.py | Test closing and opening of locations |
All tests can be run with Python 3, no arguments need to be specified.
## Active simulations
| script name | what it does |
| ------------------- | ------------------------------------:|
| maliv2.py | Mali simulation |
| burundi.py | Burundi simulation |
| car.py | CAR simulation |
| ssudan-csv.py | South Sudan simulation |
| iraq-idp.py | Iraq simulation (IDPs only) |
## Perform a simple test
rm test-output/*
python3 test_csv.py > test-output/out.csv
python3 plot-flee-output.py test-output
## Run a CAR simulation
rm test-output/*
python3 car-csv.py SimSettings/default.csv > test-output/out.csv
python3 plot-flee-output.py test-output
## Run a parallel test simulation
mpirun -np <number of cores> test_par.py
Authoring entity
| Agency Name | Role |
|---|---|
| djgroen | owner |
Language
English
Methods, software and scripts
Software
| Name | Libraries or packages used |
|---|---|
| Python |
os, time, csv, analysis, warnings, copy, muscle, pandas, mpi4py, numpy, networkx, FormatPyplotFigures, StoreDiagnostics, datamanager, random, matplotlib, flee, CalculateDiagnostics, sys, datetime, analyze_graph, math, outputanalysis
|
| Shell |
License
| Name |
|---|
| BSD 3-Clause "New" or "Revised" License |
Metadata production
Producers
| Name | Role |
|---|---|
| GitHub Bot | bot |
Date of Production
01 December 2019