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

Starsim is most easily installed via PyPI: pip install starsim.

Starsim 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.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.4.tar.gz (101.2 kB view details)

Uploaded Source

Built Distribution

starsim-0.3.4-py3-none-any.whl (101.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: starsim-0.3.4.tar.gz
  • Upload date:
  • Size: 101.2 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.4.tar.gz
Algorithm Hash digest
SHA256 389d0975e14f02b67a4d77762c5b34098d8b29121011865eec3662353b7c60b8
MD5 c78f011823f91b8b632ea367cb00c85d
BLAKE2b-256 205aa33d28c7511901338379fd598cf94fa088ebc13d0136cc74e27678634a1e

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: starsim-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 101.1 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 68deaaa69d5f498bab96128f6af0b696f8306b5f59075c70a0048bcb817b7a6a
MD5 bd63120fe00f29864145b81866baa5ef
BLAKE2b-256 dfca4934f2393cf30f6bfdbe03bb7ca261c160826f9e305e41311635b3021e80

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