User guide

These user guides provide a more in-depth look at each topic compared to the corresponding tutorials.

Note

You can download these user guides as Jupyter notebooks to run them locally. Look for the download button at the top of each page.

TipRunning user guides locally

To run these user guides locally:

1. Clone the Starsim repository
2. Install Starsim and its dependencies
3. Navigate to the docs/user_guide folder
4. Launch Jupyter: jupyter lab

Introduction

• Introduction to Starsim
• Starsim models

Basics

• Understanding the model
• The Sim object
• Parameter configuration

Modules

• Diseases
• Networks
• Demographics
• Interventions
• Analyzers
• Connectors

Workflows

• Running simulations
• SIR Calibration
• Calibration
• Deployment
• Working with samples

Advanced topics

• Time handling
• Indexing and arrays
• Probability distributions
• Random number generation
• Profiling and optimization
• Nonstandard usage