Input files

The following parameters set the paths to the the campaign file and the input files for climate, migration, demographics, and load-balancing.

Note

Parameters are case-sensitive. For Boolean parameters, set to 1 for true or 0 for false. Minimum, maximum, or default values of “NA” indicate that those values are not applicable for that parameter.

EMOD does not use true defaults; that is, if the dependency relationships indicate that a parameter is required, you must supply a value for it. However, many of the tools used to work with EMOD will use the default values provided below.

JSON format does not permit comments, but you can add “dummy” parameters to add contextual information to your files. Any keys that are not EMOD parameter names will be ignored by the model.

Parameter

Data type

Minimum

Maximum

Default

Description

Example

Air_Migration_Filename

string

NA

NA

“”

The path to the input file that defines patterns of migration by airplane. Enable_Air_Migration must be set to true (1). See Migration files for information on migration files.

 
{
  "Migration_Model": "FIXED_RATE_MIGRATION",
  "Enable_Air_Migration": 1,
  "Air_Migration_Filename": "../Global_1degree_air_migration.bin"
}

Air_Temperature_Filename

string

NA

NA

_add-your-air-temperature-file_.bin

The path to the input file that defines air temperature data measured two meters above ground. Climate_Model must be set to CLIMATE_BY_DATA. The file must be in .bin format.

 
{
  "Climate_Model": "CLIMATE_BY_DATA",
  "Air_Temperature_Filename": "Namawala_single_node_air_temperature_daily.bin"
}

Campaign_Filename

string

NA

NA

The path to the campaign file. It is required when interventions are part of the simulation and Enable_Interventions is set to true (1). The file must be in .json format.

 
{
  "Enable_Interventions": 1,
  "Campaign_Filename": "campaign.json"
}

Demographics_Filename

string

NA

NA

UNINITIALIZED STRING

DEPRECATED: Path of demographics file containing information on the identity and demographics of the region to simulate. Use Demographics_Filenames instead.

Demographics_Filenames

array of strings

NA

NA

[]

An array of the paths to demographics files containing information on the identity and demographics of the region to simulate. The files must be in .json format. Note that this parameter is only required when Enable_Demographics_Builtin is set to 0.

 
{
  "Demographics_Filenames": [
    "Namawala_single_node_demographics.json",
    "Namawala_demographics_overlay.json"
  ]
}

Family_Migration_Filename

string

NA

NA

“”

The name of the binary file to use to configure family migration. Enable_Family_Migration must be set to true (1). See Migration files for information on migration files.

 
{
  "Migration_Model": "FIXED_RATE_MIGRATION",
  "Enable_Family_Migration": 1,
  "Family_Migration_Filename": "../inputs/family_migration.bin"
}

Koppen_Filename

string

NA

NA

_add-your-koppen-climate-file_.json

The path to the input file used to specify Koppen climate classifications. Climate_Model must be set to CLIMATE_KOPPEN.

 
{
  "Koppen_Filename": "Mad_2_5arcminute_koppen.dat"
}

Land_Temperature_Filename

string

NA

NA

_add-your-land-temp-file_.bin

The path of the input file defining temperature data measured at land surface; used only when Climate_Model is set to CLIMATE_BY_DATA. The file must be in .bin format.

 
{
  "Land_Temperature_Filename": "Namawala_single_node_land_temperature_daily.bin"
}

Load_Balance_Filename

string

NA

NA

UNINITIALIZED STRING

The path to the input file used when a static load balancing scheme is selected. The file must be in .json format.

 
{
  "Load_Balance_Filename": "GitHub_426_LoadBalance.json"
}

Local_Migration_Filename

string

NA

NA

“”

The path of the input file which defines patterns of migration to adjacent nodes by foot travel. See Migration files for information on migration files.

 
{
  "Local_Migration_Filename": "Local_Migration.bin"
}

Rainfall_Filename

string

NA

NA

_add-your-rainfall-file_.bin

The path of the input file which defines rainfall data. Climate_Model must be set to CLIMATE_BY_DATA. The file must be in .bin format.

 
{
  "Rainfall_Filename": "Namawala_single_node_rainfall_daily.bin"
}

Regional_Migration_Filename

string

NA

NA

“”

The path of the input file which defines patterns of migration by vehicle via road or rail network. If the node is not on a road or rail network, regional migration focuses on the closest hub city in the network. The file must be in .bin format. See Migration files for information on migration files.

 
{
  "Regional_Migration_Filename": "Regional_Migration.bin"
}

Relative_Humidity_Filename

string

NA

NA

_add-your-relative-humidity-file__hum.bin

The path of the input file which defines relative humidity data measured 2 meters above ground. Climate_Model must be set to CLIMATE_BY_DATA. The file must be in .bin format.

 
{
  "Relative_Humidity_Filename": "Namawala_single_node_relative_humidity_daily.bin"
}

Sea_Migration_Filename

string

NA

NA

“”

The path of the input file which defines patterns of migration by ship. Only used when Enable_Sea_Migration is set to true (1). The file must be in .bin format. See Migration files for information on migration files.

 
{
  "Sea_Migration_Filename": "5x5_Households_Work_Migration.bin"
}

Serialized_Population_Filenames

array of strings

NA

NA

NA

An array of filenames with serialized population data. The number of filenames must match the number of cores used for the simulation. The files must be in .dtk format. Serialized population files are created using Serialization_Time_Steps.

 
{
  "Serialized_Population_Filenames": [
    "state-00010.dtk"
  ]
}

Serialized_Population_Path

string

NA

NA

.

The root path for the serialized population files. Serialized population files are created using Serialization_Time_Steps.

 
{
  "Serialized_Population_Path": "../00_Generic_Version_1_save/output"
}

Vector_Migration_Filename_Local

string

NA

NA

UNSPECIFIED_FILE

The path to the vector migration file which defines patterns of vector migration to adjacent nodes. Enable_Vector_Migration must be set to 1. The file must be in .bin format.

 
{
  "Vector_Migration_Filename_Local": "5x5_Households_Local_Vector_Migration.bin"
}

Vector_Migration_Filename_Regional

string

NA

NA

UNSPECIFIED_FILE

The path to the vector migration file which defines patterns of vector migration to non-adjacent nodes. Enable_Vector_Migration must be set to 1. The file must be in .bin format.

 
{
  "Vector_Migration_Filename_Regional": "5x5_Households_Regional_Vector_Migration.bin"
}