CampaignEventByYear

The CampaignEventByYear event class determines when to distribute the intervention based on the calendar year. See the following JSON example and table, which shows all available parameters for this campaign event.

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	Data type	Minimum	Maximum	Default	Description	Example
Event_Coordinator_Config	json object	NA	NA	NA	An object that specifies how the event is handled by the simulation. It specifies which Event Coordinator class will handle the event, and then configures the coordinator. This description starts with specifying class, and then the other fields depend on the class.	{ "Event_Coordinator_Config": { "class": "StandardInterventionDistributionEventCoordinator", "Demographic_Coverage": 1.0 } }
Nodeset_Config	json object	NA	NA	NA	An object that specifies in which nodes the interventions will be distributed. Set to one of the Nodeset_Config classes.	{ "Nodeset_Config": { "class": "NodeSetAll" } }
Start_Year	float	1900	2200	1900	The absolute year of the simulation to activate the event’s event coordinator. To have the intervention applied other than at the beginning of the year, you must enter a decimal value after the year. For example, 2010.5 would have the intervention applied halfway through the year 2010.	{ "Start_Year": 1962 }

{
    "Events": [{
        "class": "CampaignEventByYear",
        "Event_Name": "Everyone initiates ART",
        "Start_Year": 2025,
        "Nodeset_Config": {
            "class": "NodeSetAll"
        },
        "Event_Coordinator_Config": {
            "class": "StandardInterventionDistributionEventCoordinator",
            "Target_Demographic": "Everyone",
            "Demographic_Coverage": 1,
            "Travel_Linked": 0,
            "Intervention_Config": {
                "class": "ARTBasic"
            }
        }
    }]
}

Nodeset_Config classes

The following classes determine in which nodes the event will occur.

NodeSetAll

The event will occur in all nodes in the simulation. This class has no associated parameters. For example,

{
    "Nodeset_Config": {
        "class": "NodeSetAll"
    }
}

NodeSetNodeList

The event will occur in the nodes listed by Node ID.

Parameter	Data type	Minimum	Maximum	Default	Description	Example
Node_List	array of integers	NA	NA	NA	A comma-separated list of node IDs in which this event will occur.	{ "Nodeset_Config": { "class": "NodeSetNodeList", "Node_List": [ 1, 5, 27 ] } }

NodeSetPolygon

The event will occur in the nodes that fall within a given polygon.

Parameter	Data type	Minimum	Maximum	Default	Description	Example
Polygon_Format	enum	NA	NA	SHAPE	The type of polygon to create. Currently, SHAPE is the only supported value.	{ "Nodeset_Config": { "class": "NodeSetPolygon", "Polygon_Format": "SHAPE", "Vertices": "-122.320726936496,47.6597902588541 -122.320406460197,47.6520988276782 -122.308388598985,47.6471314450438" } }
Vertices	string	NA	NA	UNINTIALIZED STRING	Comma-separated list of latitude/longitude points that bound a polygon.	{ "Nodeset_Config": { "class": "NodeSetPolygon", "Polygon_Format": "SHAPE", "Vertices": "-122.320726936496,47.6597902588541 -122.320406460197,47.6520988276782 -122.308388598985,47.6471314450438" } }