EMOD-API
v1.8.6
emod_api
Glossary
EMOD-API
IDM docs
»
emodpy
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
X
A
add() (in module emod_api.campaign)
AddAgeDependentTransmission() (emod_api.demographics.Demographics.Demographics method)
AddIndividualPropertyAndHINT() (emod_api.demographics.Demographics.Demographics method)
AddSeasonalForcing() (in module emod_api.demographics.DemographicsTemplates)
AgeStructureUNWPP() (in module emod_api.demographics.DemographicsTemplates)
AgesYears() (emod_api.migration.Migration.Migration property)
AIR (emod_api.migration.Migration.Migration attribute)
append() (emod_api.serialization.dtkFileTools.DtkFile.Contents method)
(emod_api.serialization.dtkFileTools.DtkFile.Objects method)
application() (in module emod_api.config.dtk_post_process_adhocevents)
(in module emod_api.config.dtk_pre_process_adhocevents)
(in module emod_api.config.dtk_pre_process_w5ml)
(in module emod_api.schema.dtk_post_process_schema)
apply_to_defaults_or_nodes() (in module emod_api.demographics.demographics_utils)
arcsec_to_deg() (in module emod_api.demographics.DemographicsGenerator)
as_dataframe() (emod_api.channelreports.channels.ChannelReport method)
as_dictionary() (emod_api.channelreports.channels.Channel method)
(emod_api.channelreports.channels.Header method)
asset collection
assets
Author() (emod_api.migration.Migration.Migration property)
author() (emod_api.serialization.dtkFileTools.DtkFile property)
(emod_api.weather.weather.Metadata property)
(emod_api.weather.weather.Weather property)
B
BaseInputFile (class in emod_api.demographics.BaseInputFile)
basicNode() (in module emod_api.demographics.Node)
BroadcastEvent() (in module emod_api.interventions.common)
BroadcastEventToOtherNodes() (in module emod_api.interventions.common)
builder
byte_count() (emod_api.serialization.dtkFileTools.DtkFile property)
C
change_ser_pop() (in module emod_api.serialization.CensusAndModPop)
Channel (class in emod_api.channelreports.channels)
channel_names() (emod_api.channelreports.channels.ChannelReport property)
ChannelReport (class in emod_api.channelreports.channels)
channels() (emod_api.channelreports.channels.ChannelReport property)
chunk_count() (emod_api.serialization.dtkFileTools.DtkFile property)
chunk_sizes() (emod_api.serialization.dtkFileTools.DtkFile property)
chunks() (emod_api.serialization.dtkFileTools.DtkFile property)
compress() (emod_api.serialization.dtkFileSupport.EllZeeFour class method)
(emod_api.serialization.dtkFileSupport.Snappy class method)
(emod_api.serialization.dtkFileSupport.Uncompressed class method)
(in module emod_api.serialization.dtkFileTools)
compressed() (emod_api.serialization.dtkFileTools.DtkFile property)
compression() (emod_api.serialization.dtkFileTools.DtkFile property)
ConstantMortality() (in module emod_api.demographics.DemographicsTemplates)
construct() (in module emod_api.demographics.grid_construction)
ConstructNodesFromDataFrame() (in module emod_api.demographics.DemographicsInputDataParsers)
create_age_and_gender_dependent_migration_file() (in module emod_api.migration.inspect)
create_age_dependent_migration_file() (in module emod_api.migration.inspect)
create_basic_migration_file() (in module emod_api.migration.inspect)
create_gender_dependent_migration_file() (in module emod_api.migration.inspect)
creation_date() (emod_api.weather.weather.Metadata property)
(emod_api.weather.weather.Weather property)
D
data() (emod_api.channelreports.channels.Channel property)
(emod_api.spatialreports.spatial.SpatialNode property)
(emod_api.spatialreports.spatial.SpatialReport property)
(emod_api.weather.weather.Weather property)
(emod_api.weather.weather.WeatherNode property)
datavalue_count() (emod_api.weather.weather.Metadata property)
(emod_api.weather.weather.Weather property)
DatavalueCount() (emod_api.migration.Migration.Layer property)
(emod_api.migration.Migration.Migration property)
date() (emod_api.serialization.dtkFileTools.DtkFile property)
DateCreated() (emod_api.migration.Migration.Migration property)
default_density (emod_api.demographics.Node.Node attribute)
default_population (emod_api.demographics.Node.Node attribute)
DefaultSusceptibilityDistribution() (in module emod_api.demographics.DemographicsTemplates)
DelayedIntervention() (in module emod_api.interventions.common)
Demographics (class in emod_api.demographics.Demographics)
DemographicsGenerator (class in emod_api.demographics.DemographicsGenerator)
DemographicsType (class in emod_api.demographics.DemographicsGenerator)
do_mapping_from_events() (in module emod_api.config.dtk_pre_process_adhocevents)
do_nodes() (in module emod_api.interventions.utils)
dtk_to_schema() (in module emod_api.schema.get_schema)
dtk_version() (emod_api.channelreports.channels.ChannelReport property)
(emod_api.channelreports.channels.Header property)
DtkFile (class in emod_api.serialization.dtkFileTools)
DtkFile.Contents (class in emod_api.serialization.dtkFileTools)
DtkFile.Objects (class in emod_api.serialization.dtkFileTools)
DtkFileV1 (class in emod_api.serialization.dtkFileTools)
DtkFileV2 (class in emod_api.serialization.dtkFileTools)
DtkFileV2.NodesV2 (class in emod_api.serialization.dtkFileTools)
DtkFileV3 (class in emod_api.serialization.dtkFileTools)
DtkFileV3.NodesV3 (class in emod_api.serialization.dtkFileTools)
DtkFileV4 (class in emod_api.serialization.dtkFileTools)
DtkHeader (class in emod_api.serialization.dtkFileTools)
duplicate_nodeID_check() (in module emod_api.demographics.DemographicsInputDataParsers)
E
EllZeeFour (class in emod_api.serialization.dtkFileSupport)
emod_api
module
emod_api.campaign
module
emod_api.channelreports
module
emod_api.channelreports.channels
module
emod_api.config
module
emod_api.config.default_from_schema
module
emod_api.config.default_from_schema_no_validation
module
emod_api.config.dtk_post_process_adhocevents
module
emod_api.config.dtk_pre_process_adhocevents
module
emod_api.config.dtk_pre_process_w5ml
module
emod_api.config.from_overrides
module
emod_api.config.from_poi_and_binary
module
emod_api.config.from_schema
module
emod_api.config.schema_to_config
module
emod_api.demographics
module
emod_api.demographics.BaseInputFile
module
emod_api.demographics.Demographics
module
emod_api.demographics.demographics_utils
module
emod_api.demographics.DemographicsGenerator
module
emod_api.demographics.DemographicsInputDataParsers
module
emod_api.demographics.DemographicsTemplates
module
emod_api.demographics.grid_construction
module
emod_api.demographics.Node
module
emod_api.interventions
module
emod_api.interventions.common
module
emod_api.interventions.import_pressure
module
emod_api.interventions.outbreak
module
emod_api.interventions.simple_vaccine
module
emod_api.interventions.utils
module
emod_api.migration
module
emod_api.migration.inspect
module
emod_api.migration.Migration
module
emod_api.schema
module
emod_api.schema.dtk_post_process_schema
module
emod_api.schema.get_schema
module
emod_api.schema_to_class
module
emod_api.serialization
module
emod_api.serialization.CensusAndModPop
module
emod_api.serialization.dtkFileSupport
module
emod_api.serialization.dtkFileTools
module
emod_api.serialization.dtkFileUtility
module
emod_api.serialization.SerializedPopulation
module
emod_api.spatialreports
module
emod_api.spatialreports.spatial
module
emod_api.tabularoutput
module
emod_api.weather
module
emod_api.weather.weather
module
EquilibriumAgeDistFromBirthAndMortRates() (in module emod_api.demographics.DemographicsTemplates)
EveryoneInitiallySusceptible() (in module emod_api.demographics.DemographicsTemplates)
examine_migration_file() (in module emod_api.migration.inspect)
experiment
F
FAMILY (emod_api.migration.Migration.Migration attribute)
FEMALE (emod_api.migration.Migration.Migration attribute)
fill_nodes_legacy() (in module emod_api.demographics.DemographicsInputDataParsers)
finalize() (emod_api.schema_to_class.ReadOnlyDict method)
find() (in module emod_api.serialization.SerializedPopulation)
flattenConfig() (in module emod_api.config.from_overrides)
flush() (emod_api.serialization.SerializedPopulation.SerializedPopulation method)
from_csv() (emod_api.weather.weather.Weather class method)
(in module emod_api.demographics.Demographics)
from_data() (emod_api.demographics.Node.Node class method)
from_dataframe() (in module emod_api.demographics.DemographicsGenerator)
from_demog_and_param_gravity() (in module emod_api.migration.Migration)
from_file() (emod_api.migration.Migration.Migration static method)
(emod_api.weather.weather.Metadata class method)
(in module emod_api.demographics.Demographics)
(in module emod_api.demographics.DemographicsGenerator)
from_params() (in module emod_api.demographics.Demographics)
(in module emod_api.migration.Migration)
from_pop_csv() (in module emod_api.demographics.Demographics)
from_template_node() (in module emod_api.demographics.Demographics)
FullRisk() (in module emod_api.demographics.DemographicsTemplates)
G
GenderDataType() (emod_api.migration.Migration.Migration property)
generate_demographics() (emod_api.demographics.DemographicsGenerator.DemographicsGenerator method)
generate_file() (emod_api.demographics.BaseInputFile.BaseInputFile method)
(emod_api.demographics.Demographics.Demographics method)
generate_headers() (emod_api.demographics.BaseInputFile.BaseInputFile method)
generate_metadata() (emod_api.demographics.DemographicsGenerator.DemographicsGenerator method)
generate_nodes() (emod_api.demographics.DemographicsGenerator.DemographicsGenerator method)
get_adhocs() (in module emod_api.campaign)
get_bbox() (in module emod_api.demographics.grid_construction)
get_class_with_defaults() (in module emod_api.schema_to_class)
get_config_from_default_and_params() (in module emod_api.config.default_from_schema_no_validation)
get_default_for_complex_type() (in module emod_api.schema_to_class)
get_event() (in module emod_api.campaign)
get_grid_cell_id() (in module emod_api.demographics.grid_construction)
get_next_individual_suid() (emod_api.serialization.SerializedPopulation.SerializedPopulation method)
get_next_infection_suid() (emod_api.serialization.SerializedPopulation.SerializedPopulation method)
get_node() (emod_api.demographics.Demographics.Demographics method)
get_node_ids_from_file() (in module emod_api.demographics.Demographics)
get_node_pops_from_params() (in module emod_api.demographics.Demographics)
get_parameters() (in module emod_api.serialization.SerializedPopulation)
get_schema() (in module emod_api.campaign)
get_trigger_list() (in module emod_api.campaign)
get_waning_from_params() (in module emod_api.interventions.utils)
get_xpix_ypix() (in module emod_api.demographics.Node)
H
Header (class in emod_api.channelreports.channels)
header() (emod_api.channelreports.channels.ChannelReport property)
(emod_api.serialization.dtkFileTools.DtkFile property)
high-performance computing (HPC)
HSB() (in module emod_api.interventions.common)
I
id() (emod_api.demographics.Node.Node property)
(emod_api.spatialreports.spatial.SpatialNode property)
(emod_api.weather.weather.WeatherNode property)
id_reference() (emod_api.weather.weather.Metadata property)
(emod_api.weather.weather.Weather property)
IDREF_GRUMP1DEGREE (emod_api.migration.Migration.Migration attribute)
IDREF_GRUMP2PT5ARCMIN (emod_api.migration.Migration.Migration attribute)
IDREF_GRUMP30ARCSEC (emod_api.migration.Migration.Migration attribute)
IDREF_LEGACY (emod_api.migration.Migration.Migration attribute)
IdReference() (emod_api.migration.Migration.Migration property)
init_resolution_from_file() (emod_api.demographics.Node.Node class method)
InitAgeUniform() (in module emod_api.demographics.DemographicsTemplates)
InitPrevUniform() (in module emod_api.demographics.DemographicsTemplates)
InitRiskUniform() (in module emod_api.demographics.DemographicsTemplates)
InitSusceptConstant() (in module emod_api.demographics.DemographicsTemplates)
InterpolationType() (emod_api.migration.Migration.Migration property)
interval() (emod_api.spatialreports.spatial.SpatialReport property)
INTERVENTION (emod_api.migration.Migration.Migration attribute)
InvalidResolution
L
lat_lon_from_nodeid() (in module emod_api.demographics.Node)
Layer (class in emod_api.migration.Migration)
LINEAR_INTERPOLATION (emod_api.migration.Migration.Migration attribute)
load_default_config_as_rod() (in module emod_api.config.default_from_schema_no_validation)
LOCAL (emod_api.migration.Migration.Migration attribute)
lon_lat_2_point() (in module emod_api.demographics.grid_construction)
M
main() (in module emod_api.migration.inspect)
make_config_from_poi() (in module emod_api.config.from_poi_and_binary)
make_config_from_poi_and_config_dict() (in module emod_api.config.from_poi_and_binary)
make_config_from_poi_and_config_file() (in module emod_api.config.from_poi_and_binary)
make_config_from_poi_and_schema() (in module emod_api.config.from_poi_and_binary)
MALE (emod_api.migration.Migration.Migration attribute)
MAX_AGE (emod_api.migration.Migration.Migration attribute)
Metadata (class in emod_api.weather.weather)
metadata() (emod_api.weather.weather.Weather property)
Migration (class in emod_api.migration.Migration)
MigrationType() (emod_api.migration.Migration.Migration property)
module
emod_api
emod_api.campaign
emod_api.channelreports
emod_api.channelreports.channels
emod_api.config
emod_api.config.default_from_schema
emod_api.config.default_from_schema_no_validation
emod_api.config.dtk_post_process_adhocevents
emod_api.config.dtk_pre_process_adhocevents
emod_api.config.dtk_pre_process_w5ml
emod_api.config.from_overrides
emod_api.config.from_poi_and_binary
emod_api.config.from_schema
emod_api.config.schema_to_config
emod_api.demographics
emod_api.demographics.BaseInputFile
emod_api.demographics.Demographics
emod_api.demographics.demographics_utils
emod_api.demographics.DemographicsGenerator
emod_api.demographics.DemographicsInputDataParsers
emod_api.demographics.DemographicsTemplates
emod_api.demographics.grid_construction
emod_api.demographics.Node
emod_api.interventions
emod_api.interventions.common
emod_api.interventions.import_pressure
emod_api.interventions.outbreak
emod_api.interventions.simple_vaccine
emod_api.interventions.utils
emod_api.migration
emod_api.migration.inspect
emod_api.migration.Migration
emod_api.schema
emod_api.schema.dtk_post_process_schema
emod_api.schema.get_schema
emod_api.schema_to_class
emod_api.serialization
emod_api.serialization.CensusAndModPop
emod_api.serialization.dtkFileSupport
emod_api.serialization.dtkFileTools
emod_api.serialization.dtkFileUtility
emod_api.serialization.SerializedPopulation
emod_api.spatialreports
emod_api.spatialreports.spatial
emod_api.tabularoutput
emod_api.weather
emod_api.weather.weather
MortalityRateByAge() (in module emod_api.demographics.DemographicsTemplates)
MortalityStructureNigeriaDHS() (in module emod_api.demographics.DemographicsTemplates)
MultiInterventionDistributor() (in module emod_api.interventions.common)
N
new_intervention() (in module emod_api.interventions.import_pressure)
(in module emod_api.interventions.outbreak)
(in module emod_api.interventions.simple_vaccine)
new_intervention2() (in module emod_api.interventions.simple_vaccine)
new_intervention_as_file() (in module emod_api.interventions.import_pressure)
(in module emod_api.interventions.outbreak)
(in module emod_api.interventions.simple_vaccine)
NLHTI() (in module emod_api.interventions.common)
Node (class in emod_api.demographics.Node)
node_count() (emod_api.demographics.Demographics.Demographics property)
(emod_api.spatialreports.spatial.SpatialReport property)
(emod_api.weather.weather.Metadata property)
(emod_api.weather.weather.Weather property)
node_ID_from_lat_long() (in module emod_api.demographics.DemographicsInputDataParsers)
node_ids() (emod_api.demographics.Demographics.Demographics property)
(emod_api.spatialreports.spatial.SpatialReport property)
(emod_api.weather.weather.Metadata property)
(emod_api.weather.weather.Weather property)
NodeCount() (emod_api.migration.Migration.Layer property)
(emod_api.migration.Migration.Migration property)
nodeid_from_lat_lon() (in module emod_api.demographics.Node)
NodeOffsets() (emod_api.migration.Migration.Migration property)
Nodes() (emod_api.migration.Migration.Migration property)
nodes() (emod_api.serialization.dtkFileTools.DtkFile property)
(emod_api.serialization.SerializedPopulation.SerializedPopulation property)
(emod_api.spatialreports.spatial.SpatialReport property)
(emod_api.weather.weather.Metadata property)
(emod_api.weather.weather.Weather property)
nodes_for_DTK() (in module emod_api.demographics.Node)
NoInitialPrevalence() (in module emod_api.demographics.DemographicsTemplates)
NoMigrationHeterogeneity() (in module emod_api.demographics.DemographicsTemplates)
NoRisk() (in module emod_api.demographics.DemographicsTemplates)
num_channels() (emod_api.channelreports.channels.ChannelReport property)
(emod_api.channelreports.channels.Header property)
num_time_steps() (emod_api.channelreports.channels.ChannelReport property)
(emod_api.channelreports.channels.Header property)
O
ONE_FOR_EACH_GENDER (emod_api.migration.Migration.Migration attribute)
P
PIECEWISE_CONSTANT (emod_api.migration.Migration.Migration attribute)
point_2_grid_cell_id_lookup() (in module emod_api.demographics.grid_construction)
PropertyValueChanger() (in module emod_api.interventions.common)
provenance() (emod_api.weather.weather.Metadata property)
(emod_api.weather.weather.Weather property)
R
read() (in module emod_api.serialization.dtkFileTools)
ReadOnlyDict (class in emod_api.schema_to_class)
recurser() (in module emod_api.schema.dtk_post_process_schema)
REGIONAL (emod_api.migration.Migration.Migration attribute)
report_type() (emod_api.channelreports.channels.ChannelReport property)
(emod_api.channelreports.channels.Header property)
report_version() (emod_api.channelreports.channels.ChannelReport property)
(emod_api.channelreports.channels.Header property)
res_in_degrees (emod_api.demographics.Node.Node attribute)
S
SAME_FOR_BOTH_GENDERS (emod_api.migration.Migration.Migration attribute)
save() (in module emod_api.campaign)
ScheduledCampaignEvent() (in module emod_api.interventions.common)
schema_to_config() (in module emod_api.config.from_poi_and_binary)
schema_to_config_subnode() (in module emod_api.config.default_from_schema_no_validation)
SchemaConfigBuilder (class in emod_api.config.from_schema)
(class in emod_api.config.schema_to_config)
SEA (emod_api.migration.Migration.Migration attribute)
seed_by_coverage() (in module emod_api.interventions.outbreak)
SerializedPopulation (class in emod_api.serialization.SerializedPopulation)
SerialObject (class in emod_api.serialization.dtkFileSupport)
set_age_complex() (in module emod_api.demographics.DemographicsTemplates)
set_age_simple() (in module emod_api.demographics.DemographicsTemplates)
set_boxcar_seasonal() (in module emod_api.demographics.DemographicsTemplates)
set_demog_distributions() (in module emod_api.demographics.demographics_utils)
set_growing_demographics() (in module emod_api.demographics.demographics_utils)
set_immune_mod() (in module emod_api.demographics.demographics_utils)
set_init_prev() (in module emod_api.demographics.DemographicsTemplates)
set_resolution() (emod_api.demographics.DemographicsGenerator.DemographicsGenerator method)
set_risk_mod() (in module emod_api.demographics.demographics_utils)
set_schema() (emod_api.schema_to_class.ReadOnlyDict method)
(in module emod_api.config.from_poi_and_binary)
set_static_demographics() (in module emod_api.demographics.demographics_utils)
set_suscept_complex() (in module emod_api.demographics.DemographicsTemplates)
set_suscept_simple() (in module emod_api.demographics.DemographicsTemplates)
SetConstantSusceptibility() (emod_api.demographics.Demographics.Demographics method)
SetDefaultFromTemplate() (emod_api.demographics.Demographics.Demographics method)
SetDefaultIndividualAttributes() (emod_api.demographics.Demographics.Demographics method)
SetDefaultIndividualProperties() (emod_api.demographics.Demographics.Demographics method)
SetDefaultNodeAttributes() (emod_api.demographics.Demographics.Demographics method)
SetDefaultProperties() (emod_api.demographics.Demographics.Demographics method)
SetDefaultPropertiesFertMort() (emod_api.demographics.Demographics.Demographics method)
SetIndividualAttributtsWithFertMort() (emod_api.demographics.Demographics.Demographics method)
SetMinimalNodeAttributes() (emod_api.demographics.Demographics.Demographics method)
SetNodeDefaultFromTemplate() (emod_api.demographics.Demographics.Demographics method)
SetOverdispersion() (emod_api.demographics.Demographics.Demographics method)
SimpleSusceptibilityDistribution() (in module emod_api.demographics.DemographicsTemplates)
simulation() (emod_api.serialization.dtkFileTools.DtkFileV1 property)
(emod_api.serialization.dtkFileTools.DtkFileV2 property)
(emod_api.serialization.dtkFileTools.DtkFileV3 property)
Snappy (class in emod_api.serialization.dtkFileSupport)
SpatialNode (class in emod_api.spatialreports.spatial)
SpatialReport (class in emod_api.spatialreports.spatial)
StandardDiagnostic() (in module emod_api.interventions.common)
start() (emod_api.spatialreports.spatial.SpatialReport property)
start_time() (emod_api.channelreports.channels.ChannelReport property)
(emod_api.channelreports.channels.Header property)
STATIC (emod_api.demographics.DemographicsGenerator.DemographicsType attribute)
step_size() (emod_api.channelreports.channels.ChannelReport property)
(emod_api.channelreports.channels.Header property)
StepFunctionSusceptibility() (in module emod_api.demographics.DemographicsTemplates)
T
task
template
time_stamp() (emod_api.channelreports.channels.ChannelReport property)
(emod_api.channelreports.channels.Header property)
time_steps() (emod_api.spatialreports.spatial.SpatialReport property)
title() (emod_api.channelreports.channels.Channel property)
to_dict() (emod_api.demographics.Node.Node method)
to_file() (emod_api.migration.Migration.Migration method)
(emod_api.schema_to_class.ReadOnlyDict method)
to_tuple() (emod_api.demographics.Node.Node method)
Tool() (emod_api.migration.Migration.Migration property)
tool() (emod_api.serialization.dtkFileTools.DtkFile property)
TriggeredCampaignEvent() (in module emod_api.interventions.common)
U
uncompress() (emod_api.serialization.dtkFileSupport.EllZeeFour class method)
(emod_api.serialization.dtkFileSupport.Snappy class method)
(emod_api.serialization.dtkFileSupport.Uncompressed class method)
(in module emod_api.serialization.dtkFileTools)
Uncompressed (class in emod_api.serialization.dtkFileSupport)
units() (emod_api.channelreports.channels.Channel property)
update_resolution() (emod_api.weather.weather.Metadata property)
(emod_api.weather.weather.Weather property)
V
validate_res_in_arcsec() (in module emod_api.demographics.DemographicsGenerator)
version() (emod_api.serialization.dtkFileTools.DtkFile property)
W
Weather (class in emod_api.weather.weather)
WeatherNode (class in emod_api.weather.weather)
write() (emod_api.serialization.SerializedPopulation.SerializedPopulation method)
(in module emod_api.serialization.dtkFileTools)
write_config_from_default_and_params() (in module emod_api.config.default_from_schema_no_validation)
write_default_from_schema() (in module emod_api.config.default_from_schema)
(in module emod_api.config.default_from_schema_no_validation)
write_file() (emod_api.channelreports.channels.ChannelReport method)
(emod_api.spatialreports.spatial.SpatialReport method)
(emod_api.weather.weather.Metadata method)
(emod_api.weather.weather.Weather method)
X
xpix_ypix_from_lat_lon() (in module emod_api.demographics.Node)
Read the Docs
v: v1.8.6
Versions
latest
v1.8.6
v1.8.2
v1.7.5
v1.7.4
v1.7.1
v1.6.3
v1.5.1
v1.5.0
Downloads
On Read the Docs
Project Home
Builds