Simulation setup

These parameters determine the basic setup of a simulation including the type of simulation you are running, such as "GENERIC_SIM" or "MALARIA_SIM", the simulation duration, and the time step duration.

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	Type	Min	Max	Default	Description
Base_Year	float	1900	2200	2015	The absolute time in years when the simulation begins. This can be combined with CampaignEventByYear to trigger campaign events (Start_Year for events must be after Base_Year).
Config_Name	string	NA	NA	UNINITIALIZED STRING	The optional, user-supplied title naming a configuration file.
Custom_Coordinator_Events	array of strings	NA	NA	[]	The list of valid, user-defined Coordinator Events that will be included in the campaign. These are specifically events which apply with EventCoordinators, such completing distribution of a collection of interventions. Any event used in the campaign must be in this list. See example.
Custom_Individual_Events	array of strings	NA	NA	[]	The list of valid, user-defined Individual Events that will be included in the campaign. These are specifically events which apply at an individual level, such as receiving a vaccine. Any individual event used in the campaign must either be one of the built-in events or in this list. See Event list for a list of all possible built-in events. See example.
Custom_Node_Events	array of strings	NA	NA	[]	The list of valid, user-defined Node Events that will be included in the campaign. These are specifically events which apply at the node/location level, such as finishing using an EnvironmentalDiagnostic. Any event used in the campaign must be in this list. See example.
Enable_Interventions	boolean	0	1	0	Controls whether or not campaign interventions will be used in the simulation. Set Campaign_Filename to the path of the file that contains the campaign interventions.
Enable_Skipping	boolean	0	1	0	Controls whether or not the simulation uses an optimization that can increase performance by up to 50% in some cases by probabilistically exposing individuals rather than exposing every single person. Useful in low-prevalence, high-population scenarios.
Enable_Termination_On_Zero_Total_Infectivity	boolean	0	1	0	Controls whether or not the simulation should be ended when total infectivity falls to zero. Supported only in single-node simulations.
Memory_Usage_Halting_Threshold_Working_Set_MB	integer	0	1.00E+06	8000	The maximum size (in MB) of working set memory before the system throws an exception and halts.
Memory_Usage_Warning_Threshold_Working_Set_MB	integer	0	1.00E+06	7000	The maximum size (in MB) of working set memory before memory usage statistics are written to the log regardless of log level.
Minimum_End_Time	float	0	1000000	0	The minimum time that the simulation must reach before checking for early termination conditions. Enable_Abort_Zero_Infectivity must be set to 1 (true).
Node_Grid_Size	float	0.00416	90	0.004167	The spatial resolution indicating the node grid size for a simulation in degrees.
Random_Number_Generator_Policy	enum	NA	NA	ONE_PER_CORE	The policy that determines if random numbers are generated for objects in a simulation on a per-core or per-node basis. The following values are available: ONE_PER_CORE A random number generator (RNG) is created for each computing core running a simulation. When running a simulation on a single core, there will be only one RNG. If running the single simulation on multiple cores, each core will have its own RNG. The RNGs on the different cores start out such that they will not generate the same stream of random numbers. Prior to |EMOD_s| 2.19, all simulations used this policy. ONE_PER_NODE An RNG is created for each geographic node in the simulation. The advantages of this policy are that 1) an event that causes a random number to be drawn in one node does not cause things to change in another node and 2) changing a simulation from single core to multi-core will not change the results. The RNGs on the different nodesstart out such that they will not generate the same stream of random numbers.
Random_Number_Generator_Type	enum	NA	NA	USE_PSEUDO_DES	The type of random number generator to use for objects in a simulation. Must set the RNG seed in Run_Number. The following values are available: USE_PSEUDO_DES Based on Numerical Recipes in C. The Art of Scientific Computing <https://en.wikipedia.org/wiki/Numerical_Recipes>, 2nd ed. Press, William H. et. al, 1992. Prior to |EMOD_s| 2.19, this was the only generator available. USE_LINEAR_CONGRUENTIAL Based on The Structure of Linear Congruential Sequences <https://www.researchgate.net/publication/242477888_The_Structure_of_Linear_Congruential_Sequences>, Marsaglia, George, 1972. USE_AES_COUNTER Based on AES in CTR Mode encryption as implemented in Intel (R) Advanced Encryption Standard (AES) New Instruction Set <https://software.intel.com/sites/default/files/article/165683/aes-wp-2012-09-22-v01.pdf>_.
Run_Number	integer	0	65535	1	Sets the random number seed used with Random_Number_Generator_Type and Random_Number_Generator_Policy to assign random numbers to objects in a simulation. This value must be different for each simulation run to ensure model stochasticity.
Simulation_Duration	float	0	1000000	1	The elapsed time (in days) from the start to the end of a simulation.
Simulation_Timestep	float	0	1000000	1	The duration of a simulation time step, in days.
Simulation_Type	enum	NA	NA	GENERIC_SIM	The type of disease being simulated. Possible IDM-supported values are: * GENERIC_SIM * VECTOR_SIM * MALARIA_SIM * TBHIV_SIM * STI_SIM * HIV_SIM * ENVIRONMENTAL_SIM * TYPHOID_SIM
Start_Time	float	0	1000000	1	The time, in days, when the simulation begins. This time is used to identify the starting values of the temporal input data, such as specifying which day's climate values should be used for the first day of 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.