emod_api package

To generate a config.json from a param_overrides.json (or params-of-interest.json):

python -m emod_api.config.from_overrides </path/to/po.json>

To generate a default config.json based on the schema for a given Eradication binary:

python -m emod_api.config.from_schema -e </path/to/Eradication.[exe]> …

To generate a schema.json:

python -m emod_api.schema.get_schema </path/to/Eradication[.exe]>

For rest of emod-api documentation, please go to InstituteforDiseaseModeling/emod-api

Subpackages

• emod_api.channelreports package
  • Submodules
    • emod_api.channelreports.channels module
      • Header
      • Channel
      • ChannelReport
    • emod_api.channelreports.icj_to_csv module
      • inset_chart_json_to_csv_dataframe_pd()
    • emod_api.channelreports.plot_icj_means module
      • collect()
      • display()
    • emod_api.channelreports.plot_prop_report module
      • main()
      • list_channels_and_ips()
      • call_plot_traces()
      • prop_report_json_to_csv()
      • process_cmd_line()
    • emod_api.channelreports.utils module
      • property_report_to_csv()
      • read_json_file()
      • get_report_channels()
      • accumulate_channel_data()
      • save_to_csv()
      • plot_traces()
• emod_api.config package
  • Submodules
    • emod_api.config.default_from_schema module
      • write_default_from_schema()
    • emod_api.config.default_from_schema_no_validation module
      • schema_to_config_subnode()
      • get_default_config_from_schema()
      • write_default_from_schema()
      • load_default_config_as_rod()
      • get_config_from_default_and_params()
      • write_config_from_default_and_params()
    • emod_api.config.dtk_post_process_adhocevents module
      • application()
    • emod_api.config.dtk_pre_process_adhocevents module
      • do_mapping_from_events()
      • application()
    • emod_api.config.dtk_pre_process_w5ml module
      • application()
    • emod_api.config.from_overrides module
      • flattenConfig()
    • emod_api.config.from_poi_and_binary module
      • schema_to_config()
      • set_schema()
      • make_config_from_poi_and_config_dict()
      • make_config_from_poi_and_config_file()
      • make_config_from_poi_and_schema()
      • make_config_from_poi()
    • emod_api.config.from_schema module
      • SchemaConfigBuilder
    • emod_api.config.schema_to_config module
      • SchemaConfigBuilder
• emod_api.demographics package
  • Subpackages
    • emod_api.demographics.service package
      • Submodules
  • Submodules
    • emod_api.demographics.BaseInputFile module
      • BaseInputFile
    • emod_api.demographics.Demographics module
      • from_template_node()
      • from_file()
      • get_node_ids_from_file()
      • get_node_pops_from_params()
      • from_params()
      • from_csv()
      • from_pop_raster_csv()
      • from_pop_csv()
      • DemographicsBase
      • DemographicsOverlay
      • Demographics
    • emod_api.demographics.DemographicsGenerator module
      • InvalidResolution
      • DemographicsType
      • arcsec_to_deg()
      • validate_res_in_arcsec()
      • DemographicsGenerator
      • from_dataframe()
      • from_file()
    • emod_api.demographics.DemographicsInputDataParsers module
      • node_ID_from_lat_long()
      • duplicate_nodeID_check()
      • fill_nodes_legacy()
      • ConstructNodesFromDataFrame()
    • emod_api.demographics.DemographicsTemplates module
      • DemographicsTemplatesConstants
      • CrudeRate
      • YearlyRate
      • DtkRate
      • NoRisk()
      • FullRisk()
      • InitRiskUniform()
      • InitRiskLogNormal()
      • InitRiskExponential()
      • NoInitialPrevalence()
      • InitPrevUniform()
      • InitSusceptConstant()
      • EveryoneInitiallySusceptible()
      • StepFunctionSusceptibility()
      • SimpleSusceptibilityDistribution()
      • DefaultSusceptibilityDistribution()
      • MortalityRateByAge()
      • MortalityStructureNigeriaDHS()
      • get_fert_dist_from_rates()
      • get_fert_dist()
      • InitAgeUniform()
      • AgeStructureUNWPP()
      • birthrate_multiplier()
      • demographicsBuilder()
    • emod_api.demographics.Node module
      • Node
      • OverlayNode
      • get_xpix_ypix()
      • lat_lon_from_nodeid()
      • xpix_ypix_from_lat_lon()
      • nodeid_from_lat_lon()
      • nodes_for_DTK()
      • basicNode()
    • emod_api.demographics.PreDefinedDistributions module
      • ConstantDistribution
    • emod_api.demographics.PropertiesAndAttributes module
      • IndividualProperty
      • IndividualProperties
      • IndividualAttributes
      • NodeAttributes
    • emod_api.demographics.Updateable module
      • Updateable
    • emod_api.demographics.demographics_utils module
      • set_risk_mod()
      • set_immune_mod()
      • apply_to_defaults_or_nodes()
      • set_demog_distributions()
      • set_static_demographics()
      • set_growing_demographics()
• emod_api.interventions package
  • Submodules
    • emod_api.interventions.ccdl module
    • emod_api.interventions.ccdl_viz module
      • get_nickname_from_event()
      • get_colour_from_event()
      • get_shape_from_event()
      • set_beautifiers()
      • viz()
    • emod_api.interventions.common module
      • TargetGender
      • BroadcastEvent()
      • broadcast_node_event()
      • BroadcastEventToOtherNodes()
      • add_broadcast_coordinator_event()
      • MultiInterventionDistributor()
      • DelayedIntervention()
      • HSB()
      • NLHTI()
      • PropertyValueChanger()
      • ScheduledCampaignEvent()
      • TriggeredCampaignEvent()
      • add_triggered_coordinator_event()
      • StandardDiagnostic()
      • triggered_campaign_delay_event()
      • triggered_campaign_event_with_optional_delay()
      • change_individual_property_at_age()
      • change_individual_property_triggered()
      • change_individual_property_scheduled()
      • change_individual_property()
    • emod_api.interventions.import_pressure module
      • new_intervention()
      • new_intervention_as_file()
    • emod_api.interventions.migration module
      • add_migration_event()
    • emod_api.interventions.node_multiplier module
      • new_intervention()
      • new_scheduled_event()
      • new_intervention_as_file()
    • emod_api.interventions.outbreak module
      • seed()
      • seed_by_coverage()
      • new_intervention()
      • new_intervention_as_file()
    • emod_api.interventions.simple_vaccine module
      • new_intervention()
      • new_intervention2()
      • new_intervention_as_file()
    • emod_api.interventions.utils module
      • do_nodes()
      • get_waning_from_params()
      • get_waning_from_points()
      • get_waning_from_parameters()
• emod_api.legacy package
  • Submodules
    • emod_api.legacy.plotAllCharts module
      • plotOneFromDisk()
      • plotCompareFromDisk()
      • plotBunch()
      • main()
• emod_api.migration package
  • Subpackages
    • emod_api.migration.client package
      • Submodules
  • Submodules
    • emod_api.migration.migration module
      • Layer
      • Migration
      • from_file()
      • examine_file()
      • from_params()
      • from_demog_and_param_gravity_webservice()
      • from_demog_and_param_gravity()
      • to_csv()
      • from_csv()
• emod_api.schema package
  • Submodules
    • emod_api.schema.dtk_post_process_schema module
      • recurser()
      • application()
    • emod_api.schema.get_schema module
      • dtk_to_schema()
• emod_api.serialization package
  • Submodules
    • emod_api.serialization.CensusAndModPop module
      • change_ser_pop()
    • emod_api.serialization.SerializedPopulation module
      • SerializedPopulation
      • find()
      • get_parameters()
    • emod_api.serialization.dtkFileSupport module
      • Uncompressed
      • EllZeeFour
      • Snappy
      • SerialObject
      • NullPtr
    • emod_api.serialization.dtkFileTools module
      • uncompress()
      • compress()
      • DtkHeader
      • DtkFile
      • DtkFileV1
      • DtkFileV2
      • DtkFileV3
      • DtkFileV4
      • DtkFileV5
      • read()
      • write()
    • emod_api.serialization.dtkFileUtility module
• emod_api.spatialreports package
  • Submodules
    • emod_api.spatialreports.plot_spat_means module
      • collect()
      • plot()
    • emod_api.spatialreports.spatial module
      • SpatialNode
      • SpatialReport
• emod_api.tabularoutput package
• emod_api.weather package
  • Submodules
    • emod_api.weather.weather module
      • WeatherNode
      • Metadata
      • Weather

Submodules

• emod_api.campaign module
  • reset()
  • set_schema()
  • get_schema()
  • add()
  • get_trigger_list()
  • save()
  • get_adhocs()
  • get_custom_coordinator_events()
  • get_custom_node_events()
  • get_recv_trigger()
  • get_send_trigger()
  • get_event()
• emod_api.multidim_plotter module
  • plot_from_sql()
• emod_api.peek_camp module
  • decorate_actual_iv()
  • decorate_actual_iv_impl()
  • handle_di()
  • get_ip()
  • get_ages()
  • decode()
  • params_to_dict()
  • encode()
• emod_api.schema_to_class module
  • disable_warnings()
  • ReadOnlyDict
    • ReadOnlyDict.set_schema()
    • ReadOnlyDict.to_file()
    • ReadOnlyDict.finalize()
  • uses_old_waning()
  • get_schema()
  • get_class_with_defaults()
• emod_api.utils module
  • Distributions
    • Distributions.constant()
    • Distributions.uniform()
    • Distributions.gaussian()
    • Distributions.exponential()
    • Distributions.log_normal()
    • Distributions.poisson()
    • Distributions.dual_constant()
    • Distributions.weibull()
    • Distributions.dual_exponential()
    • Distributions.set_distribution_parameters()