HPVsim: Human Papillomavirus Simulator
Project description
This repository contains the code for IDM’s human papillomavirus simulator, HPVsim.
HPVsim is currently under development.
The structure is as follows:
HPVsim, in the folder hpvsim, is a standalone Python library for performing HPV analyses.
Data is in the data folder.
Docs are in the docs folder.
Tests are in the tests folder.
Installation
Run pip install -e . to install hpvsim and its dependencies. This will make hpvsim available on the Python path.
Run get_birth_data.py and get_death_data.py to update the data folder, if desired.
Usage
See the tests folder for usage examples.
Documentation
Documentation is available at https://docs.idmod.org/projects/hpvsim/en/latest/.
Contributing
Style guide
Please follow the starsim style guide at: https://github.com/amath-idm/styleguide
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. See the contributing and code of conduct READMEs for more information.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file hpvsim-0.3.2.tar.gz.
File metadata
- Download URL: hpvsim-0.3.2.tar.gz
- Upload date:
- Size: 169.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.11.3 pkginfo/1.8.2 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.64.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9100d76b4218dd6a0032f151b22215d6c2741fca8a4b98f05fbf66c07ee8d2a5 |
|
| MD5 | 855f86c2e276ddac535d04cf628f2c4b |
|
| BLAKE2b-256 | a039cd90e0fcad9f8fa012040f8421c085b841d22daef8fc6d583fdb9fef4b93 |
File details
Details for the file hpvsim-0.3.2-py3-none-any.whl.
File metadata
- Download URL: hpvsim-0.3.2-py3-none-any.whl
- Upload date:
- Size: 178.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.11.3 pkginfo/1.8.2 requests/2.28.1 requests-toolbelt/0.9.1 tqdm/4.64.1 CPython/3.9.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e87fef904e7f41c6e5a051ebae718ee15fea0245b212613ab73e140c284b5498 |
|
| MD5 | 32fd68ae83033d5d6d3e9a90384d6e4d |
|
| BLAKE2b-256 | 54032a940ff1868fe9ecac80e557649213db8ad055d4eaa74ee3434d0f039bea |
