Inset chart output report¶
The inset chart output report is output with every simulation. It is a JSON-formatted file with the channel output results of the simulation, consisting of simulation-wide averages by time step. The channels in an inset chart are fully specified by the simulation type and cannot be altered without making changes to the EMOD source code. The file name is InsetChart.json. You can use the information contained in the file to create a chart, but EMOD does not automatically output a chart.
The file contains a header and a channels section.
Header¶
The header section contains the following parameters.
Parameter |
Data type |
Description |
---|---|---|
DateTime |
string |
The time stamp indicating when the report was generated. |
DTK_Version |
string |
The version of EMOD used. |
Report_Type |
string |
The type of output report. |
Report_Version |
string |
The format version of the report. |
Start_Time |
integer |
The time noted in days when the simulation begins. |
Simulation_Timestep |
integer |
The number of days in each time step. |
Timesteps |
integer |
The number of time steps in this simulation. |
Channels |
integer |
The number of channels in the simulation. |
Example¶
The following is a sample of an InsetChart.json file for a simulation with five time steps.
{
"Header": {
"DateTime": "Thu Dec 03 11:28:34 2015",
"DTK_Version": "5738 HIV-Ongoing 2015/11/18 13:00:39",
"Report_Type": "InsetChart",
"Report_Version": "3.2",
"Start_Time": 0,
"Simulation_Timestep": 1,
"Timesteps": 5,
"Channels": 17
},
"Channels": {
"Births": {
"Units": "Births",
"Data": [
0,
0,
0,
0,
0
]
},
"Campaign Cost": {
"Units": "USD",
"Data": [
0,
0,
0,
0,
0
]
},
"Cumulative Infections": {
"Units": "",
"Data": [
0,
0,
0,
0,
0
]
},
"Cumulative Reported Infections": {
"Units": "",
"Data": [
0,
0,
0,
0,
0
]
},
"Disease Deaths": {
"Units": "",
"Data": [
0,
0,
0,
0,
0
]
},
"Exposed Population": {
"Units": "Exposed Fraction",
"Data": [
0,
0,
0,
0,
0
]
},
"Human Infectious Reservoir": {
"Units": "Total Infectivity",
"Data": [
0,
0,
0,
0,
0
]
},
"Infected": {
"Units": "Infected Fraction",
"Data": [
0,
0,
0,
0,
0
]
},
"Infectious Population": {
"Units": "Infectious Fraction",
"Data": [
0,
0,
0,
0,
0
]
},
"Log Prevalence": {
"Units": "Log Prevalence",
"Data": [-10, -10, -10, -10, -10]
},
"New Infections": {
"Units": "",
"Data": [
0,
0,
0,
0,
0
]
},
"New Reported Infections": {
"Units": "",
"Data": [
0,
0,
0,
0,
0
]
},
"Daily (Human) Infection Rate": {
"Units": "Infection Rate",
"Data": [
0,
0,
0,
0,
0
]
},
"Recovered Population": {
"Units": "Recovered (Immune) Fraction",
"Data": [
0,
0,
0,
0,
0
]
},
"Statistical Population": {
"Units": "Population",
"Data": [
900,
900,
900,
900,
900
]
},
"Susceptible Population": {
"Units": "Susceptible Fraction",
"Data": [
1,
1,
1,
1,
1
]
},
"Waning Population": {
"Units": "Waning Immunity Fraction",
"Data": [
0,
0,
0,
0,
0
]
}
}
}
Channels¶
The channels section contains the following parameters.
Parameter |
Data type |
Description |
---|---|---|
<Channel_Title> |
string |
The title of the particular channel. |
Units |
string |
The units used for this channel. |
Data |
array |
A list of the channel data at each time step. |
When running typhoid simulations, the following channels are included in the InsetChart.json file.
Channel |
Description |
---|---|
Births |
The live births cumulative up to that day. |
Campaign Cost |
The cost of campaigns cumulative up to that day (set by the Cost_To_Consumer parameter). |
Contact Contagion Population |
The population scaled volume of simulated typhoid in the contact reservoir on that day. |
Daily (Human) Infection Rate |
The per-person daily rate of human infection (Human Infectious Reservoir divided by Statistical Population). |
Environmental Contagion Population |
The population scaled volume of simulated typhoid in the environmental reservoir on that day. |
Human Infectious Reservoir |
The total node infectivity, after modifications by the infectious reservoir, seasonality, climate, etc. (if present). The expected number of infections distributed via the contact route, absent immunity or interventions. |
Infected |
The fraction of the population currently infected and infectious. |
Log Prevalence |
The logarithm of the population prevalence. |
New Infections |
The number of new typhoid infections on that day. |
New Infections By Route (CONTACT) |
The number of new typhoid infections contracted through the contact route on that day. |
New Infections By Route (ENVIRONMENT) |
The number of new typhoid infections contracted through the environmental route on that day. |
Newly Symptomatic |
The number of individuals who developed acute typhoid symptoms on that day. |
Statistical Population |
The total number of individuals in the simulation on that day. |
Symptomatic Population |
The total number of individuals currently experiencing acute typhoid symptoms. |