Description

PopART-IBM is an individual-based model for simulating HIV epidemics in high-prevalence settings, as used in the HPTN 071 (PopART) trial. Using the default parameters, the model simulates approximately 50,000 individuals over several decades following demographic patterns from UN's Population Division.

Documentation

Model description: A full description of the model is described in Pickles et al., 2020.
Code documentation: Detailed documentation of the model's C code is online here and included with this source code.
Data dictionary of output files: A data dictionary describing all the output files from the model is here.
Data dictionary of input parameters: A data dictionary describing the parameters in the model is described here.

Compilation

For Mac and Unix-type systems, PopART-IBM requires a C compiler (such as gcc) and the GSL libraries installed:

cd POPART-IBM/src

make all

GSL can be downloaded from here.

For Windows systems, please see this walkthrough.

Usage

cd POPART-IBM/src

./popart-simul.exe <inputdir> <nruns>

where

inputdir: Directory where input parameter files ("param_processed*.csv") are located
nruns : number of simulation runs in parameter files (num. of lines in parameter files to read in)

A basic example illustrates how the parameter input files can be set up (steps 1 and 2) as is expected by the model.

Notes

Additional command-line arguments are described in main.c.
The model will write all output files to the directory inputdir/Output (additional command-line arguments can adjust this).
The output files written will depending upon which macros are set to 1 within the file constants.h (those beginning WRITE_*).

Folder structure

src/                 # Model C code
   popart_ibm/       # Helper Python code for handling input parameters
doc/                 # General documentation in Markdown files
docs/                # Auto-generated code documentation using doxygen
examples/            # Basic script for running the model
tests/               # Testing files
python/              # Help Python scripts for manipulating markdown documentation
doxygen-awesome-css/ # Git submodule of CSS file for styling doxygen

Testing

Tests are written pytest using Python version 3.6 or later, and run in the following manner:

python3 -m pytest

Some tests take a long time to run and so are not run by default, they can be invoked using the --runslow option in pytest:

python3 -m pytest --runslow

It is recommended that tests are run under a Python virtual environment. The following will set up a Python virtual environment, install required modules, and run the tests:

python3 -m venv venv
source venv/bin/activate
python3 -m pip install -r tests/requirements.txt
python3 -m pytest
deactivate

Publications

The model has been published in several journals and conferences:

Contributing

Contributions are most welcome. Please see the documentation on contributing for further information. The C code is documented using formatting for Doxygen. Please contact the core team or raise an issue before making a pull request.