Skip to main content

STI modelling toolbox built on the Starsim platform

Project description

tests pypi

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 is available at https://docs.idmod.org/projects/stisim.

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

Uploaded Source

Built Distribution

STIsim-0.1.0-py3-none-any.whl (64.2 kB view details)

Uploaded Python 3

File details

Details for the file stisim-0.1.0.tar.gz.

File metadata

  • Download URL: stisim-0.1.0.tar.gz
  • Upload date:
  • Size: 56.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for stisim-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e23e59e29715a90d2f3c814e678cf9e811f9ad3aeb2d7a186df9d56421ef216f
MD5 0bc1f1ef43f50ab3e02b7ab30134284a
BLAKE2b-256 25cf41a8de44340add6ff03270605bfde45ac48233e7f567eeb9ba12b6d74973

See more details on using hashes here.

File details

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

File metadata

  • Download URL: STIsim-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 64.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for STIsim-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 668ed52334c76a8d2e13fc86aedabde7d4ca590ff6487188e3e6437529bcb6bb
MD5 e2e3e192735930ab1f1c85cef9a07449
BLAKE2b-256 37883fb777bf1e48c7bc1d33971c8bb7ebcd253e8ba59b2250dbb95c2789004b

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