LASER Cholera (LASIK)¶
LASIK — LASER-based SImulation of Kolera — is the Python-based simulation
engine for the R-based MOSAIC
cholera metapopulation model.
Where do I start?¶
Pick the entry point that matches what you want to do.
"I just want to run the defaults"¶
Install LASIK, run metapop --seed 20240930, look at the output. The
Usage page has the one-line CLI invocation and the equivalent
Python call; the first-run tutorial walks through
the same thing more slowly and tells you what to expect in each output.
"I want to swap in my own data"¶
You have admin polygons + populations (or you can pull them with
laser-init) and want to drive
laser.cholera directly without going through MOSAIC. Start with the
Mozambique admin-2 configuration — it shows
how to assemble per-patch vectors, per-tick matrices, and the calendar window
from a real-world input. The
parameter reference is the authoritative
source for every field's shape, dtype, range, and off-value; the
single-location tutorial builds the smallest
possible configuration from scratch via get_parameters(mods=…).
"I want to understand the model"¶
The explanation pages cover the compartment structure (S / E / I_sym / I_asym / R / V1 / V2), the two transmission pathways (human-to-human + environmental reservoir), the seasonal harmonic, the gravity-model mobility coupling, and the reporting + likelihood machinery — without the parameter-list noise of the Reference quadrant.
Quick links¶
- API reference: autogenerated Python API documentation.
- Source on GitHub
- Issue tracker
- Changelog
This site is built with properdocs (a maintained
continuation of MkDocs 1.x) + Material for MkDocs
+ mkdocstrings, and published to GitHub
Pages from the repo's main branch on every push.