Skip to main content

PyPI distribution of EMOD for the running Malaria and Vector simulations

Reason this release was yanked:

Versioning consistency

Project description

emod-malaria — This package is a disease-specific distribution of the EMOD binary for the Malaria simulation type.

EMOD - V2.22

Epidemiological MODeling software (EMOD), is an agent-based model (ABM) that simulates the simultaneous interactions of agents in an effort to recreate complex phenomena. Each agent (such as a human or vector) can be assigned a variety of “properties” (for example, age, gender, etc.), and their behavior and interactions with one another are determined by using decision rules. These models have strong predictive power and are able to leverage spatial and temporal dynamics.

EMOD is also stochastic, meaning that there is randomness built into the model. Infection and recovery processes are represented as probabilistic Bernoulli random draws. In other words, when a susceptible person comes into contact with a pathogen, they are not guaranteed to become infected. Instead, you can imagine flipping a coin that has a λ chance of coming up tails S(t) times, and for every person who gets a “head” you say they are infected. This randomness better approximates what happens in reality. It also means that you must run many simulations to determine the probability of particular outcomes.

As of V2.22, EMOD will only support malaria and HIV and will no longer support diseases such as TB and Typhoid.

History & Publication Samples

EMOD development was started by Philip Welkoff in 2010 to model malaria. Since that time, EMOD has been used in numerous studies and policy decisions. Below is short sample of papers about EMOD and that used EMOD:

A malaria transmission-directed model of mosquito life cycle and ecology

Description of the EMOD-HIV Model v0.7

Effectiveness of reactive case detection for malaria elimination in three archetypical transmission settings: a modelling study

Implementation and applications of EMOD, an individual-based multi-disease modeling platform

  • Anna Bershteyn, Jaline Gerardin, Daniel Bridenbecker, Christopher W Lorton, Jonathan Bloedow, Robert S Baker, Guillaume Chabot-Couture, Ye Chen, Thomas Fischle, Kurt Frey, Jillian S Gauld, Hao Hu, Amanda S Izzo, Daniel J Klein, Dejan Lukacevic, Kevin A McCarthy, Joel C Miller, Andre Lin Ouedraogo, T Alex Perkins, Jeffrey Steinkraus, Tony Ting, Quirine A ten Bosch, Hung-Fu Ting, Svetlana Titova, Bradley G Wagner, Philip A Welkhoff, Edward A Wenger, Christian N Wiswell
  • Pathogens and Disease, 2018
  • https://academic.oup.com/femspd/article/76/5/fty059/5050059?login=false

Vector genetics, insecticide resistance and gene drives: an agent-based modeling approach to evaluate malaria transmission and elimination

The effect of 90-90-90 on HIV-1 incidence and mortality in eSwatini: a mathematical modelling study

Running EMOD

Since EMOD is a stochastic model, you must run numerous realizations of each scenario in order to collect proper statistics. You will likely need a high performance computing (HPC) platform to run these simulations. As of July 2024, we only support a SLURM-based HPC.

To make running EMOD easier, we have created some python packages that simplify configuring, running, and plotting the results. As of July 2024, we are working to make these packages more user friendly and will have updates coming in Q4 of 2024.

Directory Structure

  • baseReportLib - A library of commonly used report components and base classes.
  • cajun - A C++ API for JSON
  • campaign - A library of commonly used intervention components and base classes.
  • componentTests - A collection of unit tests that verify that the EMOD pieces do the right thing.
  • Dependencies - Microsoft Cluster Pack
  • docs - Source files for documentation about how to modify the EMOD source code.
  • Eradication - The core components of EMOD including human intra-host, relationship, and vector models.
  • interventions - A collection of interventions that can be used with EMOD.
  • libsqlite - The SQLite source code for reading and creating SQLite databases.
  • lz4 - A fast compression engine used to read and write serialized populations.
  • rapidjson - A fast JSON parser/generator for C++ with box SAX/DOM style API
  • Regression - A collection of scripts, input data, and output data used to verify that EMOD models things correctly.
  • reporters - A collection of data extraction, or report, classes used to collect data during a simulation.
  • Scripts - A collection of support scripts
  • snappy - A fast compression engine used to read and write serialized populations.
  • UnitTest++ - A C++ unit test framework used by the componentTests
  • untils - A collection of utility classes to do things like help with configuring and generating pseudo random numbers.

If wanting to navigate through the code, the place to start is Eradication\Eradication.cpp.

More information on the EMOD Architecture can be found at:

https://docs.idmod.org/projects/emod-malaria/en/latest/dev-architecture-overview.html

Source Code Installation for Development

The following link provides instructions for installing the prerequisites required to build and run EMOD. This intended for code development and not doing research.

https://docs.idmod.org/projects/emod-malaria/en/latest/dev-install-overview.html

Contributing and Community

Disclaimer

The code in this repository was developed by IDM and other collaborators to support our joint research on flexible agent-based modeling. We've made it publicly available under the MIT License to provide others with a better understanding of our research and an opportunity to build upon it for their own work. We make no representations that the code works as intended or that we will provide support, address issues that are found, or accept pull requests. You are welcome to create your own fork and modify the code to suit your own modeling needs as permitted under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

emod_malaria-2.33.0.dev3.tar.gz (4.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

emod_malaria-2.33.0.dev3-py3-none-any.whl (4.3 MB view details)

Uploaded Python 3

File details

Details for the file emod_malaria-2.33.0.dev3.tar.gz.

File metadata

  • Download URL: emod_malaria-2.33.0.dev3.tar.gz
  • Upload date:
  • Size: 4.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for emod_malaria-2.33.0.dev3.tar.gz
Algorithm Hash digest
SHA256 7428829012467124ee9b10ef9b866110a1277323c2426431f330e2766a5a53ad
MD5 1e4c46bad6237068ddc7e646a47038e8
BLAKE2b-256 4e5e0259eb754efdc6a1585885ff64b8643855d9c391e94c8045cb97665d2f91

See more details on using hashes here.

Provenance

The following attestation bundles were made for emod_malaria-2.33.0.dev3.tar.gz:

Publisher: build_publish.yml on EMOD-Hub/EMOD

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file emod_malaria-2.33.0.dev3-py3-none-any.whl.

File metadata

File hashes

Hashes for emod_malaria-2.33.0.dev3-py3-none-any.whl
Algorithm Hash digest
SHA256 70f66156d7ef10fd184bb3fc3edebbcb6077fa6fc55e1461394445ff60f1fef3
MD5 29e4d6768e180b3a330efe2afb9b9ee1
BLAKE2b-256 1a61a77bd965432b695b243b1ec2d7ce35ddb4a3fe4ac84cb3ca1fd1010b47ce

See more details on using hashes here.

Provenance

The following attestation bundles were made for emod_malaria-2.33.0.dev3-py3-none-any.whl:

Publisher: build_publish.yml on EMOD-Hub/EMOD

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page