Human migration tracking report (ReportHumanMigrationTracking.csv)¶
The human migration tracking report is a CSV-formatted report that provides details about human travel during simulations. The finished report will provide one line for each surviving individual that migrates during the simulation.
The report name is ReportHumanMigrationTracking.csv, and is produced via the libhumanmigrationtracking.dll file. See Custom reporters for information on using dynamic link library (DLL) files.
Configuration¶
There are no special parameters that need to be configured to generate the report. However, the simulation must have migration enabled (see the migration parameters in Configuration parameters).
Report structure and channel descriptions¶
The file contains the following data channels:
Data channel |
Data type |
Description |
|---|---|---|
Time |
integer |
The day that an individual leaves their current node. |
IndividualID |
integer |
The ID of the migrating individual. |
AgeYears |
integer |
The age (in years) of the migrating individual. |
Gender |
string |
The gender of the migrating individual (M or F). |
IsAdult |
enum |
Possible values are T or F; T (true) if individual’s age is greater than the configuration parameter Minimum_Adult_Age_Years. |
Home_NodeID |
string |
The external ID of the node the individual considers to be their ‘home’ node. |
From_NodeID |
string |
The external ID of the node the individual is moving from. |
To_NodeID |
string |
the external ID of the node the individual is moving to. |
MigrationType |
enum |
Possible values are air, local, sea, regional, local, family, intervention; the type of migration that is occurring. |
Event |
enum |
Possible values are Emigrating or SimulationEnd. Emigrating means the individual is moving, SimulationEnd means the simulation has finished. |
Example¶
The following is an example of ReportHumanMigrationTracking.csv.
Time |
IndividualID |
AgeYears |
Gender |
IsAdult |
Home_NodeID |
From_NodeID |
To_NodeID |
MigrationType |
Event |
|---|---|---|---|---|---|---|---|---|---|
2 |
46 |
94.6986 |
F |
T |
1 |
1 |
4 |
local |
Emigrating |
4 |
108 |
35.7116 |
M |
T |
2 |
2 |
5 |
local |
Emigrating |
9 |
108 |
35.7253 |
M |
T |
2 |
5 |
2 |
regional |
Emigrating |
12 |
46 |
94.726 |
F |
T |
1 |
4 |
9 |
regional |
Emigrating |
13 |
46 |
94.7287 |
F |
T |
1 |
9 |
6 |
local |
Emigrating |
17 |
108 |
35.7472 |
M |
T |
2 |
2 |
5 |
local |
Emigrating |
22 |
46 |
94.7534 |
F |
T |
1 |
6 |
7 |
regional |
Emigrating |
23 |
108 |
35.7637 |
M |
T |
2 |
5 |
2 |
regional |
Emigrating |
25 |
108 |
35.7691 |
M |
T |
2 |
2 |
1 |
local |
Emigrating |
28 |
46 |
94.7698 |
F |
T |
1 |
7 |
4 |
local |
Emigrating |
35 |
46 |
94.789 |
F |
T |
1 |
4 |
7 |
regional |
Emigrating |
37 |
46 |
94.7945 |
F |
T |
1 |
7 |
4 |
local |
Emigrating |
44 |
46 |
94.8137 |
F |
T |
1 |
4 |
8 |
regional |
Emigrating |
100 |
1 |
38.9821 |
M |
T |
1 |
1 |
1 |
home |
SimulationEnd |
100 |
46 |
94.9643 |
F |
T |
1 |
8 |
8 |
regional |
SimulationEnd |
100 |
108 |
35.9719 |
M |
T |
2 |
1 |
1 |
local |
SimulationEnd |