Skip to main content

Starsim

Project description

Warning! Starsim 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.

Starsim is an agent-based disease modeling framework in which users can design and configure simulations of pathogens that progress over time within each agent and pass from one agent to the next along dynamic transmission networks. The framework explicitly supports co-transmission of multiple pathogens, allowing users to concurrently simulate several diseases while capturing behavioral and biological interactions. Non-communicable diseases can easily be included as well, either as a co-factor for transmissible pathogens or as an independent exploration. Detailed modeling of mother-child relationships can be simulated from the timepoint of conception, enabling study of congenital diseases and associated birth outcomes. Finally, Starsim facilitates the comparison of one or more intervention scenarios to a baseline scenario in evaluating the impact of various products like vaccines, therapeutics, and novel diagnostics delivered via flexible routes including mass campaigns, screen and treat, and targeted outreach.

The framework is appropriate for simulating one or more sexually transmitted infections (including syphilis, gonorrhea, chlamydia, HPV, and HIV), respiratory infections (like RSV and tuberculosis), and other diseases and underlying determinants (such as Ebola, diabetes, and malnutrition).

Installation

To install, clone this repository, then run pip install -e . (don’t forget the dot!) in this folder to install starsim and its dependencies. This will make starsim available on the Python path.

Usage and documentation

Documentation is available at https://docs.starsim.org.

Usage examples are available in the tests folder.

Contributing

If you wish to contribute, please see the code of conduct and contributing documents.

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

starsim-0.3.3.tar.gz (103.0 kB view details)

Uploaded Source

Built Distribution

starsim-0.3.3-py3-none-any.whl (103.0 kB view details)

Uploaded Python 3

File details

Details for the file starsim-0.3.3.tar.gz.

File metadata

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

File hashes

Hashes for starsim-0.3.3.tar.gz
Algorithm Hash digest
SHA256 548cad6281271904fff884d8f787d42bcd1eeee6c125545cc16d7a95118fcd7d
MD5 00124a9b961bcce8515e4792cf55dbdb
BLAKE2b-256 cb1e9fc38d6d1ca4d707436f9af8f12a43ea6d9039c69c557ae96e29234d20bd

See more details on using hashes here.

Provenance

File details

Details for the file starsim-0.3.3-py3-none-any.whl.

File metadata

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

File hashes

Hashes for starsim-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9ab41a8e552661ecdbd1b79e4d36714001a14c861347f2070fe8d502e1abcc1f
MD5 37df216203f5ec3f7bb2ef8e85ab0a57
BLAKE2b-256 bd4d80c1ad1a4836966b66e4f36e57bfbaf4f2e0abb4140682f60dd8668f4215

See more details on using hashes here.

Provenance

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