Skip to main content

HPVsim: Human Papillomavirus Simulator

Project description

pipeline status pipeline status

This repository contains the code for the Starsim suite’s human papillomavirus simulator, HPVsim. HPVsim is a flexible agent-based model that 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. Useful complexity was not sacrificed: the platform is flexible, allowing bespoke scenario modeling.

HPVsim is currently under active development.

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.0.0.tar.gz (202.4 kB view details)

Uploaded Source

Built Distribution

hpvsim-2.0.0-py3-none-any.whl (193.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hpvsim-2.0.0.tar.gz
  • Upload date:
  • Size: 202.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for hpvsim-2.0.0.tar.gz
Algorithm Hash digest
SHA256 a066959e23851906a9f9d6ad1305efca04e741e55547823d52b5bccaf5619b1f
MD5 3409850caba30aa3ab18c132cb80d632
BLAKE2b-256 5d9c73604350773781b4d8c527c9858ab4f50054973105029e45d0c8faaa981c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: hpvsim-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 193.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for hpvsim-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a5b45a07c450a072cf2e704018d61b107903ab15fa4b55d8547b73959d8f81db
MD5 c7771e65c1cc03be3c903c82de526323
BLAKE2b-256 713c5fcc6f1ec90332a74dab6ab592192f414a3fbda753bc9da8d855e7da3436

See more details on using hashes here.

Supported by

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