emod-api documentation

emod-api is the interface for Epidemiological MODeling software (EMOD) that users of idmtools interact with to create and modify EMOD simulations. Additional functionality for interacting with EMOD is provided in the emodpy package and idmtools.

See Welcome to idmtools for a diagram showing how idmtools and each of the related packages are used in an end-to-end workflow using EMOD as the disease transmission model.

Contents

• Install
• FAQ
• API reference
  • emod_api package
    • emod_api.channelreports package
    • emod_api.config package
    • emod_api.demographics package
    • emod_api.legacy package
    • emod_api.migration package
    • emod_api.serialization package
    • emod_api.spatialreports package
    • emod_api.tabularoutput package
    • emod_api.weather package
    • emod_api.campaign module
    • emod_api.multidim_plotter module
    • emod_api.schema_to_class module
    • emod_api.utils module
• Glossary
• Plotters
• Plot mean & spread of aggregate output (InsetChart.json) for an experiment
• Plot mean spatial reports for an experiment
• Plot property report for a simulation
• Visualize multidimensional sweep outputs

Related documentation

• EMOD generic
• emodpy
• idmtools