Skip to main content

STI modelling toolbox built on the Starsim platform

Project description

Warning! STIsim is still in the early stages of development. It is being shared solely for transparency and to facilitate collaborative development. It is not ready to be used for real research or policy questions.

STIsim is an agent-based modeling framework in which users can design and configure simulations of sexually-transmitted diseases. STIsim uses the Starsim architecture, and belongs to the Starsim model suite which also includes Covasim, HPVsim, and FPsim.

Requirements

Python 3.9-3.12.

We recommend, but do not require, installing STIsim in a virtual environment, such as Anaconda.

Installation

STIsim is most easily installed via PyPI: pip install stisim.

STIsim can also be installed locally. To do this, clone first this repository, then run pip install -e . (don’t forget the dot at the end!).

Usage and documentation

Documentation has not yet been developed, please watch this space!

Contributing

Questions or comments can be directed to info@starsim.org , or on this project’s GitHub page.

Disclaimer

The code in this repository was developed by IDM, the Burnet Institute, 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

STIsim-0.0.2.tar.gz (43.8 kB view details)

Uploaded Source

Built Distribution

STIsim-0.0.2-py3-none-any.whl (48.7 kB view details)

Uploaded Python 3

File details

Details for the file STIsim-0.0.2.tar.gz.

File metadata

  • Download URL: STIsim-0.0.2.tar.gz
  • Upload date:
  • Size: 43.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for STIsim-0.0.2.tar.gz
Algorithm Hash digest
SHA256 9721485fc027180b54fb2dd067591ae066416297f4f71767d1299499c45bc7bf
MD5 b7827b37adf4efe3f57d44404424171a
BLAKE2b-256 f5878341a411c4cbfc61e9de8d914464edcc04ab88433ad2e7dec6112701cec2

See more details on using hashes here.

File details

Details for the file STIsim-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: STIsim-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 48.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for STIsim-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f9e83364e5acae84df4b3bd80de6943bd1d7afbd43d77e90587a9c90bda6165a
MD5 a8a9d91a17cd0dd88594d6e556cbbbe8
BLAKE2b-256 d6d095aec9270463afee06503e39e17161c00e1813f0b53dcea811fadfe7ad4b

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