Configuration parameters¶

The parameters described in this reference section determine the behavior of a simulation. Simulations are configured in a configuration file. This file is a JavaScript Object Notation (JSON) formatted file that contains mostly a flat list of JSON key-value pairs. For information on JSON, see EMOD parameter reference.

Warning

Parameters are case-sensitive. For Boolean parameters, set to 1 for true or 0 for false.

The tables below contain only parameters available when using the HIV simulation type.

Cluster options ¶

Parameter	Data type	Minimum	Maximum	Default	Description	Example
Load_Balance_Filename	string	NA	NA	UNINITIALIZED STRING	Path to input file used when a static load balancing scheme is selected.
Num_Cores	integer	NA	NA	NA	Number of cores used to run a simulation. This is used by the infrastructure that runs the job, such as an HPC cluster or the Regression scripts, and is not used by the DTK.

Demographics ¶

Parameter	Data type	Minimum	Maximum	Default	Description
Age_Initialization_Distribution_Type	enum	NA	NA	DISTRIBUTION_OFF	Method for initializing the age distribution in the simulated population. Possible values are: DISTRIBUTION_OFF - All individuals default to age 20-years-old. DISTRIBUTION_SIMPLE - Individual ages are drawn from a distribution whose functional form and parameters are specified in the IndividualAttributes demographics input layers: AgeDistributionFlag, AgeDistribution1, and AgeDistribution2. DISTRIBUTION_COMPLEX - Individual ages are drawn from a piecewise linear distribution specified in the IndividualAttributes demographics input layer AgeDistribution.
Base_Population_Scale_Factor	float	0	3.40E+38	1	If Population_Scale_Type is set to FIXED_SCALING, the initial simulation population is uniformly scaled over the entire area to adjust for historical or future population density.
Birth_Rate_Dependence	enum	NA	NA	FIXED_BIRTH_RATE	This parameter determines how the birth rate specified in the demographics file is used. Possible values are: FIXED_BIRTH_RATE- The absolute rate at which new individuals are born. POPULATION_DEP_RATE - Scales the node population to determine the birth rate. DEMOGRAPHIC_DEP_RATE - Scales the female population within fertility age ranges to determine the birth rate. INDIVIDUAL_PREGNANCIES - Results in a similar birth rate as DEMOGRAPHIC_DEP_RATE, but pregnancies are assigned on an individual basis and result in a 40-week pregnancy for a specific individual with a birth at the end, INDIVIDUAL_PREGNANCIES_BY_URBAN_AND_AGE, and INDIVIDUAL_PREGNANCIES_BY_AGE_AND_YEAR.
Death_Rate_Dependence	enum	NA	NA	NONDISEASE_MORTALITY_OFF	This parameter determines how the death rate specified in the demographics file is used. Possible values are: NONDISEASE_MORTALITY_OFF, NONDISEASE_MORTALITY_BY_AGE_AND_GENDER and NONDISEASE_MORTALITY_BY_YEAR_AND_AGE_FOR_EACH_GENDER.
Enable_Aging	boolean	0	1	1	Set to 1 to account for aging in the population. Set to 0 to assume that the population does not age.
Enable_Birth	boolean	0	1	1	Set to 1 to enable individuals to be added to the simulation by birth.
Enable_Demographics_Birth	boolean	0	1	0	Assumes that newborn characteristics such as sickle-cell status are heterogeneous. Set to 0 to assume by default that all newborns have identical characteristics.
Enable_Demographics_Builtin	boolean	0	1	0	Uses demographics input files to configure the initial population. Enter 0 to use a standard testing sandbox which is useful for testing and validating code pathways.
Enable_Demographics_Gender	boolean	0	1	1	Enable_Demographics_Gender=0 assigns gender based on a 50/50 draw, while Enable_Demographics_Gender=1 draws from a male/female ratio that is randomly smeared by a Gaussian of width 1%.
Enable_Demographics_Other	boolean	0	1	0	Includes the impact of other relevant demographic factors. For example, fraction of individuals above poverty, urban/rural characteristics, heterogeneous initial immunity and risk. Set to 0 to run the simulation without other relevant demographic factors.
Enable_Disease_Mortality	boolean	0	1	1	Set to 1 to enable disease mortality. Set to 0 to disable disease mortality.
Enable_Heterogeneous_Intranode_Transmission	boolean	0	1	0	Set to 1 to enable heterogeneous intra-node disease transmission. Requires individual property definitions and beta matrix to be specified. Set to 0 to disable.
Enable_Vital_Dynamics	boolean	0	1	1	Set to 1 as a master switch to enable vital dynamics (births and deaths). Set to 0 to disable vital dynamics. Even when set to 1, the individual toggles for births and deaths can still disable these.
Population_Scale_Type	enum	NA	NA	USE_INPUT_FILE	Either use the initial population specified in the demographics input file or a fixed scaling of this value based on the population scaling factor parameter. Possible values are: USE_INPUT_FILE and FIXED_SCALING.

Event recorder report settings ¶

Parameter	Data type	Minimum	Maximum	Default	Description
Report_Event_Recorder	boolean	0	1	0	Enables or disables the ReportEventRecorder.csv report.
Report_Event_Recorder_Ignore_Events_In_List	boolean	0	1	0	f this flag is set to true, all events listed in Report_Event_Recorder_Events will be ignored. If it is set to false, all events will be recorded.
Report_Event_Recorder_Individual_Properties	Dynamic String Set	NA	NA	NA	Fraction of individuals in the target demographic that will receive this intervention.

General disease ¶

Parameter	Data type	Minimum	Maximum	Default	Description
Acquisition_Blocking_Immunity_Duration_Before_Decay	float	0	45000	0	Number of days after infection until acquisition-blocking immunity begins to decay. Relevant only when Enable_Immunity and Enable_Immune_Decay parameters are set to 1.
Animal_Reservoir_Type	enum	NA	NA	NO_ZOONOSIS	Configures whether there is an animal reservoir and how the risk of zoonosis in configured. Use of the animal reservoir sets a low constant baseline of infectivity beyond what is present in the human population. It allows a more random introduction of cases in continuous time, which is more applicable for various situations such as zoonosis. Possible values are: NO_ZOONOSIS, CONSTANT_ZOONOSIS where the daily rate of zoonotic infection is configured by the parameter Zoonosis_Rate, and ZOONOSIS_FROM_DEMOGRAPHICS where the zoonosis rate is additionally scaled by the node-specific Zoonosis value in the NodeAttributes section of a demographics overlay file. See Zoonosis_Rate.
Base_Incubation_Period	float	0	3.40E+38	6	Average duration, in days, of the incubation period before infected individuals becomes infectious.
Base_Infectious_Period	float	0	3.40E+38	6	Average duration, in days, of the infectious period before the infection is cleared.
Base_Infectivity	float	0	1000	0.3	The Base_Infectivity parameter determines the base infectiousness of individuals before accounting for transmission-blocking effects of acquired immunity and/or campaign interventions. It has a slightly different meaning for each of the disease types. GENERIC_SIM: The average number of individuals per time step who will be exposed to infection by one infectious individual. In the case of super-infection, the infectiousness is summed over all infections. VECTOR_SIM: The probability of infecting a mosquito during a successful blood meal (modulated by the vector parameter Acquire_Modifier). For vector simulations, the sum infectiousness of an individual is not allowed to exceed 100%. MALARIA_SIM: This simple scale factor is not used. Instead, gametocyte abundances and cytokine-mediated infectiousness are modeled explicitly.
Base_Mortality	float	0	1000	0.001	The base mortality of the infection before accounting for individual immune modification factors. Depending on the setting of Mortality_Time_Course, this is either the daily probability of the disease being fatal (DAILY_MORTALITY) or the probability of death at the end of the infection duration (MORTALITY_AFTER_INFECTIOUS).
Enable_Immune_Decay	boolean	0	1	1	Set to 1 if immunity decays after an infection clears. Set to 0 if recovery from the disease confers complete immunity for life.
Enable_Immunity	boolean	0	1	1	Set to 1 if an individual has protective immunity after an infection clears. Set to 0 if recovery from the infection does not affect the individual’s future immunity.
Enable_Maternal_Transmission	boolean	0	1	0	Set to 1 to account for infection of infants at birth by infected mothers. Set to 0 to assume that infection is not transmitted by mothers to infants at birth.
Enable_Superinfection	boolean	0	1	0	Set to 1 if an individual can have multiple infections with the same agent simultaneously. Set to 0 if multiple infections are not possible. See the Max_Individual_Infections parameter.
Immunity_Acquisition_Factor	float	0	1000	0	Multiplicative reduction in probability of reacquiring the disease. Relevant only when Enable_Immunity and Enable_Immune_Decay parameters are set to 1.
Immunity_Initialization_Distribution_Type	enum	NA	NA	DISTRIBUTION_OFF	Method for initializing the immunity distribution in the simulated population. Possible values are: DISTRIBUTION_OFF - All individuals default to no immunity. DISTRIBUTION_SIMPLE - Individual immunities are drawn from a distribution whose functional form and parameters are specified in the IndividualAttributes demographics input layers: ImmunityDistributionFlag, ImmunityDistribution1, and ImmunityDistribution2. DISTRIBUTION_COMPLEX - Individual immnunities are drawn from an age-dependent piecewise l.
Immunity_Mortality_Factor	float	0	1000	0	Multiplicative reduction in probability of dying from infection after getting re-infected. Relevant only when Enable_Immunity and Enable_Immune_Decay parameters are set to 1.
Immunity_Transmission_Factor	float	0	1000	0	Multiplicative reduction in probability of transmitting infection after getting re-infected. Relevant only when Enable_Immunity and Enable_Immune_Decay parameters are set to 1.
Incubation_Period_Distribution	enum	NA	NA	NOT_INITIALIZED	Distribution of duration of incubation period. Can be fixed or exponentially distributed with an average duration from Base_Incubation_Period. Possible values are: FIXED_DURATION and EXPONENTIAL_DURATION.
Incubation_Period_Max	float	0.6	3.40E+38	0	The maximum length of the incubation period. Used when Incubation_Period_Distribution is UNIFORM_DURATION.
Incubation_Period_Mean	float	0	3.40E+38	6	The standard deviation used when Incubation_Period_Distribution is either GAUSSIAN_DURATION or POISSON_DURATION.
Incubation_Period_Min	float	0	3.40E+38	0	The minimum length of the incubation period. Used when the Incubation_Period_Distribution is UNIFORM_DURATION.
Incubation_Period_Std_Dev	float	0	3.40E+38	1	The standard deviation incubation period. Used when the Incubation_Period_Distribution is GAUSSIAN_DURATION.
Infection_Updates_Per_Timestep	integer	0	144	1	Number of infection updates executed during each timestep. A timestep defaults to one day.
Infectious_Period_Distribution	enum	NA	NA	NOT_INITIALIZED	Distribution of duration of infectious period. Can be fixed or exponentially distributed with an average duration from Base_Infectious_Period. Possible values are: FIXED_DURATION, EXPONENTIAL_DURATION.
Infectious_Period_Max	float	0.6	3.40E+38	0	The maximum length of the infectious period. Used when Infectious_Period_Distribution is UNIFORM_DURATION.
Infectious_Period_Mean	float	0	3.40E+38	6	The mean of the infectious period. Used when Infectious_Period_Distribution is either GAUSSIAN_DURATION or POISSON_DURATION.
Infectious_Period_Min	float	0	3.40E+38	0	The minimum length of the infectious period. Used when the Infectious_Period_Distribution is UNIFORM_DURATION.
Infectious_Period_Std_Dev	float	0	3.40E+38	1	The standard deviation of the infectious period. Used when the Infectious_Period_Distribution is GAUSSIAN_DURATION.
Infectivity_Scale_Type	enum	NA	NA	CONSTANT_INFECTIVITY	Alter infectivity by time or season. Possible values are: CONSTANT_INFECTIVITY - No infectivity correction is applied. FUNCTION_OF_TIME_AND_LATITUDE - Infectivity is corrected for approximate seasonal forcing. The use of a seasonal infectivity correction is a proxy for the effects of varying climate. From October through March, infectivity increases in the Northern Hemisphere and decreases in the Southern Hemisphere. From April through September, the trend reverses. Regions closer to the equator have reduced forcing compared to temperate regions. This is not a substitute for the weather-driven vector dynamics of vector-borne and malaria simulations. FUNCTION_OF_CLIMATE - Allows infectivity to be modulated by weather directly, for example, relative humidity in airborne simulations or rainfall in environmental simulations. There is no default climate dependence enabled for generic simulations. EXPONENTIAL_FUNCTION_OF_TIME - To facilitate certain burn-in scenarios, infectivity ramps up from zero at the beginning of the simulation according to the functional form, 1-exp(-rate*time), where the rate is specified by the parameter Infectivity_Scaling_Rate.
Maternal_Transmission_Probability	float	0	1	0	Probability of transmission of infection from mother to infant at birth. Relevant only if Enable_Maternal_Transmission is set to 1. Note: This parameter should be set to 0 and ignored for malaria and vector simulations.
Max_Individual_Infections	integer	0	1000	1	Limit on the number of infections that an individual can have simultaneously. Note: Relevant only if the Enable_Superinfection parameter is set to 1 to allow multiple infections.
Mortality_Blocking_Immunity_Decay_Rate	float	0	1000	0.001	Rate at which mortality-blocking immunity decays after the mortality-blocking immunity offset period. Relevant only when Enable_Immunity and Enable_Immune_Decay parameters are set to 1.
Mortality_Time_Course	enum	NA	NA	DAILY_MORTALITY	Determines whether disease deaths are calculated on every time step or once at the end of the disease duration. Possible values are: DAILY_MORTALITY and MORTALITY_AFTER_INFECTIOUS.
Number_Basestrains	integer	1	10	1	The number of base strains in the simulation, such as antigenic variants.
Number_Substrains	integer	1	16777200	256	The number of disease substrains for each base strain, such as genetic variants.
Population_Density_Infectivity_Correction	enum	NA	NA	CONSTANT_INFECTIVITY	Correction to alter infectivity by population density set in the Population_Density_C50 parameter. Measured in people per sq. km. Possible values are: CONSTANT_INFECTIVITY and SATURATING_FUNCTION_OF_DENSITY. Note: Sparsely populated areas have a lower infectivity, while densely populated areas have a higher infectivity which rises to saturate at the Base_Infectivity value.
Transmission_Blocking_Immunity_Decay_Rate	float	0	1000	0.001	Rate at which transmission-blocking immunity decays after the base transmission-blocking immunity offset period. Relevant only when Enable_Immunity and Enable_Immune_Decay parameters are set to 1.
Transmission_Blocking_Immunity_Duration_Before_Decay	float	0	45000	0	Number of days after infection until transmission-blocking immunity begins to decay. Relevant only when Enable_Immunity and Enable_Immune_Decay parameters are set to 1.
Zoonosis_Rate	float	0	1	0	The daily rate of zoonotic infection per individual when the Animal_Reservoir_Type parameter is set to either CONSTANT_ZOONOSIS or ZOONOSIS_FROM_DEMOGRAPHICS.

Geography and environment ¶

Parameter	Data type	Minimum	Maximum	Default	Description
Air_Temperature_Variance	float	0	5	2	The standard deviation (in degrees Celsius) for normally distributed noise applied to the daily air temperature values when Climate_Model is configured as CLIMATE_CONSTANT or CLIMATE_BY_DATA. Only used if the Enable_Climate_Stochasticity is set to 1.
Base_Air_Temperature	float	-55	45	22	The value of air temperature where Climate_Model is set to CLIMATE_CONSTANT.
Base_Land_Temperature	float	-55	60	26	The value of land temperature where Climate_Model is set to CLIMATE_CONSTANT.
Base_Rainfall	float	0	150	10	The value of rainfall per day in mm when Climate_Model is set to CLIMATE_CONSTANT.
Base_Relative_Humidity	float	0	1	0.75	The value of humidity where Climate_Model is set to CLIMATE_CONSTANT.
Climate_Model	enum	NA	NA	CLIMATE_OFF	Determines how the climate of a simulation is configured and from what file(s). Possible values are: CLIMATE_OFF, CLIMATE_CONSTANT - Uses the conditional parameters that give the fixed values of temperature or rain for land temperature, air temperature, rainfall and humidity. CLIMATE_KOPPEN - Uses an input file that decodes Koppen codes by geographic location. CLIMATE_BY_DATA - Reads everything out of several input files with additional parameters that allow the addition of stochasticity or scale offsets.
Climate_Update_Resolution	enum	NA	NA	CLIMATE_UPDATE_YEAR	Update resolution for data in climate files. Possible values are: CLIMATE_UPDATE_YEAR, CLIMATE_UPDATE_MONTH, CLIMATE_UPDATE_WEEK, CLIMATE_UPDATE_DAY and CLIMATE_UPDATE_HOUR.
Default_Geography_Initial_Node_Population	integer	0	1000000	1000	When using the default geography (i.e. Enable_Demographics_Initial = 0), this is the initial number of individuals in each node.
Default_Geography_Torus_Size	integer	3	100	10	When using the default geography (i.e. Enable_Demographics_Initial = 0), this is the square root of the number of nodes in the simulation. For migration, the nodes are assumed to be a torus.
Enable_Climate_Stochasticity	boolean	0	1	0	Controls overall stochasticity for climate. Use value 0 to disable all additional climate stochasticity. Use value 1 to enable additional variation as specified by the parameters: Air_Temperature_Variance, Land_Temperature_Variance, Enable_Rainfall_Stochasticity and Relative_Humidity_Variance.
Enable_Rainfall_Stochasticity	boolean	0	1	1	Set to 0 to disable rainfall stochasticity. Set to 1 to enable stochastic variation of rainfall drawn from an exponential distribution (with a mean value as the daily rainfall from the Climate_Model values, CLIMATE_CONSTANT or CLIMATE_BY_DATA).
Land_Temperature_Offset	float	-20	20	0	The linear shift of land surface temperature in degrees Celsius. This is only used or needed when Climate_Model is set to CLIMATE_BY_DATA.
Land_Temperature_Variance	float	0	7	2	The standard deviation (in degrees Celsius) for normally distributed noise applied to the daily land temperature values when Climate_Model is configured as CLIMATE_CONSTANT or CLIMATE_BY_DATA. Only used if the Enable_Climate_Stochasticity is set to 1.
Node_Grid_Size	float	0.004167	90	0.004167	Spatial resolution indicating the node grid size for a simulation in degrees.
Rainfall_In_mm_To_Fill_Swamp	float	1	10000	1000	Millimeters of rain to fill larval habitat to capacity. Only used for vector species with Habitat_Type set to BRACKISH_SWAMP.
Rainfall_Scale_Factor	float	0.1	10	1	The scalar used in multiplying rainfall value(s). This is only used or needed when Climate_Model is set to CLIMATE_BY_DATA.
Relative_Humidity_Scale_Factor	float	0.1	10	1	The scalar used in multiplying relative humidity value(s). This is only used or needed when Climate_Model is set to CLIMATE_BY_DATA.
Relative_Humidity_Variance	float	0	0.12	0.05	The standard deviation (in percentage, %) for normally distributed noise applied to the daily relative humidity values when Climate_Model is configured as CLIMATE_CONSTANT or CLIMATE_BY_DATA. Only used if the Enable_Climate_Stochasticity is set to 1.

Input files ¶

Parameter	Data type	Minimum	Maximum	Default	Description
Air_Migration_Filename	string	NA	NA		Path of input file defining patterns of migration by airplane.
Air_Temperature_Filename	string	NA	NA	air_temp.json	Path of input file defining air temperature data measured 2 meters above ground. Relevant only if Climate_Model is set to CLIMATE_BY_DATA.
Campaign_Filename	string	NA	NA		Path of the simulation campaign file. This configuration file defines campaign related settings and thus, is an optional file, only required when interventions are part of the simulation.
Demographics_Filenames	Vector String	NA	NA		Array of demographics files containing information on the identity and demographics of the region to simulate.
Koppen_Filename	string	NA	NA	UNINITIALIZED STRING	Path to input file used to specify Koppen climate classifications. This is only used or needed when Climate_Model is set to CLIMATE_KOPPEN.
Land_Temperature_Filename	string	NA	NA	land_temp.json	Path of input file defining temperature data measured at land surface. Relevant only if Climate_Model is set to CLIMATE_BY_DATA.
Local_Migration_Filename	string	NA	NA		Path of input file defining patterns of migration to adjacent nodes by foot travel.
Rainfall_Filename	string	NA	NA	rainfall.json	Path of input file defining rainfall data. Relevant only if Climate_Model is set to CLIMATE_BY_DATA.
Regional_Migration_Filename	string	NA	NA		Path of input file defining 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.
Relative_Humidity_Filename	string	NA	NA	rel_hum.json	Path of input file defining relative humidity data measured 2 meters above ground. Relevant only if Climate_Model is set to CLIMATE_BY_DATA.
Sea_Migration_Filename	string	NA	NA		Path of input file defining patterns of migration by ship.

Migration ¶

Parameter	Data type	Minimum	Maximum	Default	Description
Air_Migration_Roundtrip_Duration	float	0	10000	1	The average time spent at the destination node during a round-trip migration by airplane.
Air_Migration_Roundtrip_Probability	float	0	1	0.8	Likelihood that an individual who flies to another cell will return to the cell of origin during the next migration. Relevant only when Enable_Air_Migration is selected.
Enable_Air_Migration	boolean	0	1	0	Set to 1 to account for migration by airplane in and out of cities with airports. Set to 0 to assume by default that no migration occurs by air travel.
Enable_Local_Migration	boolean	0	1	0	Set to 1 to enable local migration, the diffusion of people in and out of nearby nodes by foot travel. Set to 0 to disable local migration.
Enable_Migration_Heterogeneity	boolean	0	1	1	Set to 1 to use migration rate distribution in the demographics file. Set to 0 to assume by default that the same migration rate applies for all individuals.
Enable_Regional_Migration	boolean	0	1	0	Set to 1 to account for migration by road vehicle in and out of nodal cities in the road network. Set to 0 to assume by default that no migration occurs by road travel.
Enable_Sea_Migration	boolean	0	1	0	Set to 1 to account for migration on ships in and out of coastal cities with seaports. Set to 0 to assume by default that no migration occurs by sea travel.
Local_Migration_Roundtrip_Duration	float	0	10000	1	The average time spent at the destination node during a round-trip migration by foot travel.
Local_Migration_Roundtrip_Probability	float	0	1	0.95	Likelihood that an individual who walks into a neighboring cell will return to the cell of origin during the next migration. Relevant only when Enable_Local_Migration is selected.
Migration_Model	enum	NA	NA	NO_MIGRATION	Model to use for migration. Possible values are: NO_MIGRATION, FIXED_RATE_MIGRATION, VARIABLE_RATE_MIGRATION and LEVY_FLIGHTS. Note: VARIABLE_RATE_MIGRATION and LEVY FLIGHTS are currently not supported.
Migration_Pattern	enum	NA	NA	RANDOM_WALK_DIFFUSION	The type of roundtrip. For example, a single roundtrip. Possible values are: RANDOM_WALK_DIFFUSION, SINGLE_ROUND_TRIPS and WAYPOINTS_HOME.
Regional_Migration_Roundtrip_Duration	float	0	10000	1	The average time spent at the destination node during a round-trip migration by road network.
Regional_Migration_Roundtrip_Probability	float	0	1	0.1	Likelihood that an individual who travels by vehicle to another cell will return to the cell of origin during the next migration. Relevant only when Enable_Regional_Migration is checked.
Roundtrip_Waypoints	integer	0	1000	10	The maximum number of points reached during a trip before steps are retraced on the return trip home.
Sea_Migration_Roundtrip_Duration	float	0	10000	1	The average time spent at the destination node during a round-trip migration by ship.
Sea_Migration_Roundtrip_Probability	float	0	1	0.25	Likelihood that an individual who travels by ship into a neighboring cell will return to the cell of origin during the next migration. Relevant only when Enable_Sea_Migration is checked.

Output options ¶

Parameter	Data type	Maximum	Default	Description
Enable_Default_Reporting	boolean	1	1	Enables and disables the default InsetChart.json report.
Enable_Demographics_Reporting	boolean	1	1	Outputs demographic summary data and age-binned reports to file.
Enable_Property_Output	boolean	1	0	Use value 0 to disable Individual_Property reports (separate file). Use value 1 to enable.
Enable_Spatial_Output	boolean	1	0	Use value 0 to disable all spatial output channels. Use value 1 to enable spatial output of all channels listed in the array parameter: Spatial_Output_Channels. For full documentation of spatial output channels, please see the online documentation.
Report_Event_Recorder	boolean	1	1	Enables or disables the ReportEventRecorder.csv report.

Sampling ¶

Parameter	Data type	Minimum	Maximum	Default	Description
Base_Individual_Sample_Rate	float	0	1	1	Base rate of sampling for individuals. This rate equals the fraction of individuals in each node being sampled.
Individual_Sampling_Type	enum	NA	NA	TRACK_ALL	Type of individual human sampling. Possible values are: TRACK_ALL, FIXED_SAMPLING, ADAPTED_SAMPLING_BY_POPULATION_SIZE, ADAPTED_SAMPLING_BY_AGE_GROUP, and ADAPTED_SAMPLING_BY_AGE_GROUP_AND_POP_SIZE.
Max_Node_Population_Samples	float	1	3.40E+38	30	Number of individuals when the sampling rate starts dropping to the rate of adapted sampling by population size.

Scaling factors ¶

Parameter	Data type	Minimum	Maximum	Default	Description
x_Air_Migration	float	0	3.40E+38	1	Multiplier for rate of migration by air.
x_Birth	float	0	3.40E+38	1	Multiplier of birth rate from input demographics file.
x_Local_Migration	float	0	3.40E+38	1	Multiplier for rate of migration by foot travel.
x_Other_Mortality	float	0	3.40E+38	1	Multiplier for scaling mortality from causes other than disease being simulated.
x_Regional_Migration	float	0	3.40E+38	1	Multiplier for rate of migration by road vehicle.
x_Sea_Migration	float	0	3.40E+38	1	Multiplier for rate of migration by sea.
x_Temporary_Larval_Habitat	double	NA	NA	1	Scales the habitat size for all mosquito populations.

Simulation setup ¶

Parameter	Data type	Minimum	Maximum	Default	Description
Config_Name	string	NA	NA	UNINITIALIZED STRING	User-supplied title naming a configuration.
Enable_Interventions	boolean	0	1	0	Set to 1 to load campaign interventions from file. Set to 0 to run a baseline simulation without campaigns.
Run_Number	integer	0	2147480000	1	Sets the random number seed through a bit manipulation process for USE_PSEUDO_DES. When running a multi-core simulation, combines with processor rank to produce independent random number streams for each process.
Simulation_Duration	float	0	1000000	1	Elapsed time noted in days from the start to the end of a simulation.
Simulation_Timestep	float	0	1000000	1	Value indicating simulation time step in days.
Simulation_Type	enum	NA	NA	GENERIC_SIM	Type of disease being simulated. Supported values include GENERIC_SIM, VECTOR_SIM, MALARIA_SIM, TB_SIM, STI_SIM, HIV_SIM, and PY_SIM. To query the values supported for your specific build, use the –version option.
Start_Time	float	0	1000000	1	Time noted in days when the simulation begins. This time influences the point in the temporal input data, such as where in the climate input the DTK starts running the simulation. Note: The Start_Day of campaign events is in absolute time. So, time relative to the beginning of the simulation depends on this parameter.

Spatial output channels ¶

Parameter	Data type	Minimum	Maximum	Default	Description	Example
Spatial_Output_Channels	Fixed String Set	NA	NA	[]	An array of channel names for spatial output by Node and time step. The data from each channel will be written to a separate binary file. Channel names include Air_Temperature, Births, Campaign_Cost, Disease_Deaths, Human_Infectious_Reservoir, Infection_Rate, Land_Temperature, New_Infections, New_Reported_Infections, Population, Rainfall and Relative_Humidity.