Typhoidsim

Typhoidsim implements an agent-based disease model of typhoid fever (caused by S. Typhi). This package is part of the Starsim family.

Installation

The easiest way to install Typhoidsim is via pip:

pip install git+https://github.com/starsimhub/typhoidsim

You can also clone the Typhoidsim repository and then install locally (don’t forget the dot at the end!):

pip install -e .

There are a few versions of Typhoidsim:

1. Legacy typhoidsim v0.11.7, which exclusively works with Starsim 1.0.3.
2. Legacy typhoidsim v0.26.9, which exclusively works with Starsim 2.2.0.
3. Legacy typhoidsim v0.30.6, which exclusively works with Starsim 2.3.0.
4. Typhoidsim from the main branch, which works with Starsim 3.0 or later.

To install the legacy version that runs with Starsim 1.0.3, first clone the specific branch:

git clone --single-branch --branch legacy/main-v0.11.7-starsim-1.0.3 origin

To install the legacy version that runs with Starsim 2.2.0, first clone the specific branch:

git clone --single-branch --branch legacy/main-v0.26.9-starsim-2.2.0 origin

More detailed instructions can be found here.

Usage and documentation

Documentation is available at https://starsim.org/typhoidsim. Tutorials (Jupyter notebooks) are also available.

Contributing

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

Learn more

Tutorials

An interactive tour of Typhoidsim’s key features.

API reference

Full details on all classes and functions.

What’s new

See what’s in the latest Typhoidsim releases.