Skip to main content

HPVsim: Human Papillomavirus Simulator

Project description

pipeline status

About HPVsim

HPVsim is a flexible agent-based model for simulation HPV transmission and progression through cervical disease to cancer. The model can be parameterized with country-specific vital dynamics, structured sexual networks, co-transmitting HPV genotypes, B- and T-cell mediated immunity, and high-resolution disease natural history. HPVsim is designed with a user-first lens: it is implemented in pure Python, has built-in tools for simulating commonly-used interventions, has been extensively tested and documented, and runs in a matter of seconds to minutes on a laptop.

In mid-2025, version 3.0 of HPVsim will be released, built on the Starsim Starsim modeling architecture. Since this represents a significant shift, version 3.0 and above will live in a separate repository. The code in this repository will be frozen after version 2.2, aside from any critical bugfixes.

The scientific paper describing HPVsim is available at https://doi.org/10.1371/journal.pcbi.1012181. The recommended citation is:

HPVsim: An agent-based model of HPV transmission and cervical disease (2024). Stuart RM, Cohen JA, Kerr CC, Mathur P , NDMC India, Zimmermann M, Rao DW, Boudreau MC, Lee S, Yang L, Klein DJ. PLOS Computational Biology 20(7): e1012181. https://doi.org/10.1371/journal.pcbi.1012181

Background

HPVsim has been used for analyses in several countries. Academic papers that have been written using HPVsim include:

  1. Inferring the natural history of HPV from global cancer registries: insights from a multi-country calibration (2024). Stuart RM, Cohen JA, Abeysuriya RG, Sanz-Leon P, Kerr CC, Rao DW, Klein DJ. Sci Rep 14, 15875. https://doi.org/10.1038/s41598-024-65842-3

  2. HPV DNA Screening and Vaccination Strategies in Tunisia (2025). Lahdhiri A, Benzina B, Ennaifer E, Tounsi H, Gzara A, Rammeh-Rommani S, Laraj O, Arfaoui H, Stuart RM Kebir, A, BenMiled S (2025). Sci Rep, forthcoming.

  3. Can pruning improve agent-based models’ calibration? An application to HPVsim (2025). Sturman F, Swallow B, Kerr CC, Stuart RM, Panovska-Griffiths J. Journal of Theoretical Biology, forthcoming.

Installation

The easiest way to install is simply via pip: pip install hpvsim. Alternatively, you can clone this repository, then run pip install -e . (don’t forget the dot!) in this folder to install hpvsim and its dependencies. This will make hpvsim available on the Python path. The first time HPVsim is imported, it will automatically download the required data files (~30 MB).

Usage and documentation

Documentation is available at https://docs.hpvsim.org. Additional usage examples are available in the tests folder.

Contributing

If you wish to contribute, please follow the Starsim style guide at: https://github.com/amath-idm/styleguide. See the code of conduct readme for more information.

Disclaimer

The code in this repository was developed by IDM, the Burnet Institute, and other collaborators to support our joint research on HPV. 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. Note that HPVsim depends on a number of user-installed Python packages that can be installed automatically via pip install. 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 contemplated 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

hpvsim-2.2.1.tar.gz (772.5 kB view details)

Uploaded Source

Built Distribution

hpvsim-2.2.1-py3-none-any.whl (197.9 kB view details)

Uploaded Python 3

File details

Details for the file hpvsim-2.2.1.tar.gz.

File metadata

  • Download URL: hpvsim-2.2.1.tar.gz
  • Upload date:
  • Size: 772.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for hpvsim-2.2.1.tar.gz
Algorithm Hash digest
SHA256 50d7d36337e6c07ae59ff1780e19ca9415d0b993f42a93304038c382e0c6aec3
MD5 485c7301f1a1e607ab45ac2c64b64c6b
BLAKE2b-256 b1609312f27e12da7f305ebd661f2ca8e672cc88a289836cc530f5c5cc976dc9

See more details on using hashes here.

File details

Details for the file hpvsim-2.2.1-py3-none-any.whl.

File metadata

  • Download URL: hpvsim-2.2.1-py3-none-any.whl
  • Upload date:
  • Size: 197.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for hpvsim-2.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e852770adb32f5c150f52cb51cfb242a4ce2e8893fdaf0223e5c6ad7736aa1bd
MD5 0a954c5ef52d7598b20905d817877428
BLAKE2b-256 6035a99b435439740a4f44cbe91a05d43a90c02abfb32c6905cb0945e8964a40

See more details on using hashes here.

Supported by

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