MigrateIndividuals

The MigrateIndividuals intervention class is used to force migration and is separate from the normal migration system. However, it does require that human migration is enabled.

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.

The table below describes all possible parameters with which this class can be configured. The JSON example that follows shows one potential configuration.

Parameter	Example	Description	Type	Min	Max	Default
Disqualifying_Properties	link	A list of IndividualProperty key:value pairs that cause an intervention to be aborted (persistent interventions will stop being distributed to individuals with these values). See parameters for more information. Generally used to control the flow of health care access. For example, to prevent the same individual from accessing health care via two different routes at the same time.	array of strings	nan	nan	[]
Dont_Allow_Duplicates	link	If an individual's container has an intervention, set to true (1) to prevent them from receiving another copy of the intervention. Supported by all intervention classes.	boolean	0	1	0
Duration_At_Node_Constant	link	The duration at node to use for all individuals, in days, when Duration_At_Node_Distribution is set to CONSTANT_DISTRIBUTION.	float	0	3.40282e+38	-1
Duration_At_Node_Distribution	link	The distribution type to use for assigning the duration of time an individual or family spends at a destination node after intervention-based migration. Each assigned value is a random draw from the distribution. Possible values are: NOT_INITIALIZED No distribution set. CONSTANT_DISTRIBUTION Use the same value for each individual. Set Duration_At_Node_Constant. UNIFORM_DISTRIBUTION Use a `uniform` distribution with a given minimum and maximum. Set Duration_At_Node_Max and Duration_At_Node_Min. GAUSSIAN_DISTRIBUTION The distribution is `Gaussian` (or normal). Values are resampled to ensure >= 0. Set Duration_At_Node_Gaussian_Mean and Duration_At_Node_Gaussian_Std_Dev. EXPONENTIAL_DISTRIBUTION The distribution is `exponential` with a given mean. Set Duration_At_Node_Exponential. WEIBULL_DISTRIBUTION Use a `Weibull` distribution with a given shape and scale. Set Duration_At_Node_Kappa and Duration_At_Node_Lambda. LOG_NORMAL_DISTRIBUTION Use a `log-normal` distribution with a given mean and standard deviation of the natural log. Set Duration_At_Node_Log_Normal_Mu and Duration_At_Node_Log_Normal_Sigma. POISSON_DISTRIBUTION Use a `Poisson` distribution with a given mean. Set Duration_At_Node_Poisson_Mean. DUAL_CONSTANT_DISTRIBUTION Use a distribution where some individuals are set to a value of zero and the rest to a given value. Set Duration_At_Node_Proportion_0 and Peak_2_Value. This distribution does not use the parameters set for CONSTANT_DISTRIBUTION. DUAL_EXPONENTIAL_DISTRIBUTION Use two `exponential` distributions with given means. Set Duration_At_Node_Mean_1, Duration_At_Node_Mean_2, and Duration_At_Node_Proportion_1. This distribution does not use the parameters set for EXPONENTIAL_DISTRIBUTION. .. _Gaussian: https://en.wikipedia.org/wiki/Normal_distribution .. _exponential: https://en.wikipedia.org/wiki/Exponential_distribution .. _Weibull: https://en.wikipedia.org/wiki/Weibull_distribution .. _log-normal: https://en.wikipedia.org/wiki/Log-normal_distribution .. _uniform: https://en.wikipedia.org/wiki/Uniform_distribution(continuous) .. _Poisson: https://en.wikipedia.org/wiki/Poisson_distribution	enum	nan	nan	NOT_INITIALIZED
Duration_At_Node_Exponential	link	The mean of the duration at node after migration, in days, when Duration_At_Node_Distribution is set to EXPONENTIAL_DISTRIBUTION.	float	0	3.40282e+38	-1
Duration_At_Node_Gaussian_Mean	link	The mean of the duration at node after migration, in days, when Duration_At_Node_Distribution is set to GAUSSIAN_DISTRIBUTION.	float	0	3.40282e+38	-1
Duration_At_Node_Gaussian_Std_Dev	link	The standard deviation of the duration at node after migration, in days, when Duration_At_Node_Distribution is set to GAUSSIAN_DISTRIBUTION.	float	1.17549e-38	3.40282e+38	-1
Duration_At_Node_Kappa	link	The shape value for the duration at node after migration, in days, when Duration_At_Node_Distribution is set to WEIBULL_DISTRIBUTION.	float	1.17549e-38	3.40282e+38	-1
Duration_At_Node_Lambda	link	The scale value for the duration at node after migration, in days, when Duration_At_Node_Distribution is set to WEIBULL_DISTRIBUTION.	float	1.17549e-38	3.40282e+38	-1
Duration_At_Node_Log_Normal_Mu	link	The mean of the natural log of the duration at node after migration, in days, when Duration_At_Node_Distribution is set to LOG_NORMAL_DISTRIBUTION.	float	-3.40282e+38	1.70141e+38	3.40282E+38
Duration_At_Node_Log_Normal_Sigma	link	The standard deviation of the natural log of the duration at node after migration, in days, when Duration_At_Node_Distribution is set to LOG_NORMAL_DISTRIBUTION.	float	-3.40282e+38	1.70141e+38	3.40282E+38
Duration_At_Node_Max	link	The maximum duration at node after migration, in days, when Duration_At_Node_Distribution is set to UNIFORM_DISTRIBUTION.	float	0	3.40282e+38	-1
Duration_At_Node_Mean_1	link	The mean of the first exponential distribution, in days, when Duration_At_Node_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION.	float	1.17549e-38	3.40282e+38	-1
Duration_At_Node_Mean_2	link	The mean of the second exponential distribution, in days, when Duration_At_Node_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION.	float	1.17549e-38	3.40282e+38	-1
Duration_At_Node_Min	link	The minimum duration at node after migration, in days, when Duration_At_Node_Distribution is set to UNIFORM_DISTRIBUTION.	float	0	3.40282e+38	-1
Duration_At_Node_Peak_2_Value	link	The duration at node value, in days, to assign to the remaining individuals when Duration_At_Node_Distribution is set to DUAL_CONSTANT_DISTRIBUTION.	float	0	3.40282e+38	-1
Duration_At_Node_Poisson_Mean	link	The mean of the duration at node after migration, in days, when Duration_At_Node_Distribution is set to POISSON_DISTRIBUTION.	float	0	3.40282e+38	-1
Duration_At_Node_Proportion_0	link	The proportion of individuals to assign a value of zero days at node when Duration_At_Node_Distribution is set to DUAL_CONSTANT_DISTRIBUTION.	float	0	1	-1
Duration_At_Node_Proportion_1	link	The proportion of individuals in the first exponential distribution when Duration_At_Node_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION.	float	0	1	-1
Duration_Before_Leaving_Constant	link	The duration before leaving to use for every individual, in days, when Duration_Before_Leaving_Distribution is set to CONSTANT_DISTRIBUTION.	float	0	3.40282e+38	-1
Duration_Before_Leaving_Distribution	link	The distribution type to use for assigning the duration of time an individual or family waits before migrating to the destination node after intervention-based migration. Each assigned value is a random draw from the distribution. Possible values are: NOT_INITIALIZED No distribution set. CONSTANT_DISTRIBUTION Use the same value for each individual. Set Duration_Before_Leaving_Constant. UNIFORM_DISTRIBUTION Use a `uniform` distribution with a given minimum and maximum. Set Duration_Before_Leaving_Max and Duration_Before_Leaving_Min. GAUSSIAN_DISTRIBUTION The distribution is `Gaussian` (or normal). Values are resampled to ensure >= 0. Set Duration_Before_Leaving_Gaussian_Mean and Duration_Before_Leaving_Gaussian_Std_Dev. EXPONENTIAL_DISTRIBUTION The distribution is `exponential` with a given mean. Set Duration_Before_Leaving_Exponential. WEIBULL_DISTRIBUTION Use a `Weibull` distribution with a given shape and scale. Set Duration_Before_Leaving_Kappa and Duration_Before_Leaving_Lambda. LOG_NORMAL_DISTRIBUTION Use a `log-normal` distribution with a given mean and standard deviation of the natural log. Set Duration_Before_Leaving_Log_Normal_Mu and Duration_Before_Leaving_Log_Normal_Sigma. POISSON_DISTRIBUTION Use a `Poisson` distribution with a given mean. Set Duration_Before_Leaving_Poisson_Mean. DUAL_CONSTANT_DISTRIBUTION Use a distribution where some individuals are set to a value of zero and the rest to a given value. Set Duration_Before_Leaving_Proportion_0 and Peak_2_Value. This distribution does use the parameters set for CONSTANT_DISTRIBUTION. DUAL_EXPONENTIAL_DISTRIBUTION Use two `exponential` distributions with given means. Set Duration_Before_Leaving_Mean_1, Duration_Before_Leaving_Mean_2, and Duration_Before_Leaving_Proportion_1. This distribution does not use the parameters set for EXPONENTIAL_DISTRIBUTION. .. _Gaussian: https://en.wikipedia.org/wiki/Normal_distribution .. _exponential: https://en.wikipedia.org/wiki/Exponential_distribution .. _Weibull: https://en.wikipedia.org/wiki/Weibull_distribution .. _log-normal: https://en.wikipedia.org/wiki/Log-normal_distribution .. _uniform: https://en.wikipedia.org/wiki/Uniform_distribution(continuous) .. _Poisson: https://en.wikipedia.org/wiki/Poisson_distribution	enum	nan	nan	NOT_INITIALIZED
Duration_Before_Leaving_Exponential	link	The mean of the duration before leaving node, in days, when Duration_Before_Leaving_Distribution is set to EXPONENTIAL_DISTRIBUTION.	float	0	3.40282e+38	-1
Duration_Before_Leaving_Gaussian_Mean	link	The mean of the duration before leaving the node, in days, when Duration_Before_Leaving_Distribution is set to GAUSSIAN_DISTRIBUTION.	float	0	3.40282e+38	-1
Duration_Before_Leaving_Gaussian_Std_Dev	link	The standard deviation of the duration before leaving the node, in days, when Duration_Before_Leaving_Distribution is set to GAUSSIAN_DISTRIBUTION.	float	1.17549e-38	3.40282e+38	1
Duration_Before_Leaving_Kappa	link	The shape value for the duration before leaving the node, in days, when Duration_Before_Leaving_Distribution is set to WEIBULL_DISTRIBUTION.	float	1.17549e-38	3.40282e+38	-1
Duration_Before_Leaving_Lambda	link	The scale value for the duration before leaving the node, in days, when Duration_Before_Leaving_Distribution is set to WEIBULL_DISTRIBUTION.	float	1.17549e-38	3.40282e+38	-1
Duration_Before_Leaving_Log_Normal_Mu	link	The mean of the natural log of the duration before leaving the node, in days, when Duration_Before_Leaving_Distribution is set to LOG_NORMAL_DISTRIBUTION.	float	-3.40282e+38	1.70141e+38	3.40282E+38
Duration_Before_Leaving_Log_Normal_Sigma	link	The standard deviation of the natural log of the duration before leaving the node, in days, when Duration_Before_Leaving_Distribution is set to LOG_NORMAL_DISTRIBUTION.	float	-3.40282e+38	1.70141e+38	3.40282E+38
Duration_Before_Leaving_Max	link	The maximum duration before leaving the node, in days, when Duration_Before_Leaving_Distribution is set to UNIFORM_DISTRIBUTION.	float	0	3.40282e+38	-1
Duration_Before_Leaving_Mean_1	link	The mean of the first exponential distribution, in days, when Duration_Before_Leaving_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION.	float	1.17549e-38	3.40282e+38	-1
Duration_Before_Leaving_Mean_2	link	The mean of the second exponential distribution, in days, when Duration_Before_Leaving_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION.	float	1.17549e-38	3.40282e+38	-1
Duration_Before_Leaving_Min	link	The minimum duration before leaving the node, in days, when Duration_Before_Leaving_Distribution is set to UNIFORM_DISTRIBUTION.	float	0	3.40282e+38	-1
Duration_Before_Leaving_Peak_2_Value	link	The duration before leaving the node, in days, to assign to the remaining individuals when Duration_Before_Leaving_Distribution is set to DUAL_CONSTANT_DISTRIBUTION.	float	0	3.40282e+38	-1
Duration_Before_Leaving_Poisson_Mean	link	The mean of the duration before leaving the node, in days, when Duration_Before_Leaving is set to POISSON_DISTRIBUTION.	float	0	3.40282e+38	-1
Duration_Before_Leaving_Proportion_0	link	The proportion of individuals to assign a value of zero days before leaving the node when Duration_Before_Leaving_Distribution is set to DUAL_CONSTANT_DISTRIBUTION.	float	0	1	-1
Duration_Before_Leaving_Proportion_1	link	The proportion of individuals in the first exponential distribution when Duration_Before_Leaving_Distribution is set to DUAL_EXPONENTIAL_DISTRIBUTION.	float	0	1	-1
Intervention_Name	link	The optional name used to refer to this intervention as a means to differentiate it from others that use the same class.	string	nan	nan	nan
Is_Moving	link	Set to true (1) to indicate the individual is permanently moving to a new home node for intervention-based migration.	boolean	0	1	0
New_Property_Value	link	An optional IndividualProperty key:value pair that will be assigned when the intervention is distributed. See parameters for more information. Generally used to indicate the broad category of health care cascade to which an intervention belongs to prevent individuals from accessing care through multiple pathways. For example, if an individual must already be taking a particular medication to be prescribed a new one.	string	nan	nan	nan
NodeID_To_Migrate_To	link	The destination node ID for intervention-based migration.	integer	0	4.29497e+09	0

link