Skip to main content

No project description provided

Project description

PyPI Package latest release MIT License Documentation Status Coverage Status

laser-measles helps you build and analyze spatial models of measles implemented with the LASER framework.

pip install laser-measles

Getting Started

Recommended stable release: version 0.9

New users should install the v0.9 release, which is the current stable version:

pip install "laser-measles==0.9"

Version 0.9 is the recommended starting point for all new projects. Development continues on the main branch, but v0.9 is the version that has been validated and is supported for most use cases.

Our recommended first example is here: Quick Start Tutorial

AI-Powered On-Ramp: JENNER-MEASLES

The fastest way to get started with laser-measles is through JENNER-MEASLES, a chat-based AI assistant purpose-built for this framework.

JENNER-MEASLES can help you:

  • Understand the modeling framework and architecture

  • Walk through tutorials and examples interactively

  • Debug your model configurations and code

  • Explore epidemiological scenarios and parameter choices

Access requires a ChatGPT account and organization access. If you have access, this is the recommended on-ramp before diving into the documentation or source code.

MCP Server for Claude Code Users

If you use Claude Code (or any MCP-compatible AI assistant), you can connect it directly to laser-measles and laser-core documentation and source via a local MCP server.

See the laser-mcp README for full setup instructions (requires organization access).

This gives Claude Code (and similar tools) deep, up-to-date context about laser-measles and laser-core — making it an excellent alternative to JENNER-MEASLES for developers who prefer working in their local environment with their own AI tooling.

Building the documentation artifact for the MCP server

The MCP server indexes a single combined markdown file built from this repo’s documentation. To regenerate it after documentation changes:

make docs-jenner
# produces: dist/combined_mkdocs.md

This runs the full pipeline: converts tutorial .py files to notebooks (jupytext), executes them, builds the MkDocs HTML site, and concatenates everything into dist/combined_mkdocs.md. Hand that file to laser-mcp:

# In laser-mcp:
make ingest-measles COMBINED_MD=../laser-measles/dist/combined_mkdocs.md

Prerequisites for make docs-jenner: install the docs and examples extras (pip install -e ".[docs,examples]" or uv pip install -e ".[docs,examples]").

What to Expect: Performance and Compute

All tutorials and examples included in this repository are designed to run in under one minute on a standard laptop or desktop computer. No special compute resources, cloud instances, or GPU hardware are required to get started.

Special compute becomes relevant only when you move to:

  • Calibration workflows: Fitting model parameters to data using optimization or MCMC methods

  • Large-scale parameter sweeps: Exploring wide parameter spaces across many simulation runs

For day-to-day exploration, scenario building, and learning the framework, your local machine is all you need.

Documentation

Full documentation is available at laser-measles.readthedocs.io.

The documentation includes:

  • Getting started guides and installation instructions

  • API reference for all model types and components

  • Tutorials covering the ABM, biweekly compartmental, and daily compartmental model types

  • Examples demonstrating spatial transmission, importation, and vaccination scenarios

Model Types

laser-measles provides three modeling approaches:

  • ABM (Agent-Based Model): Individual-level simulation with stochastic agents. Best for detailed heterogeneity and contact structure.

  • Biweekly Compartmental Model: Population-level SEIR dynamics with 2-week timesteps. Recommended for scenario building and policy analysis.

  • Compartmental Model: Population-level SEIR dynamics with daily timesteps. Recommended for parameter estimation and outbreak modeling.

Contributing

Contributions are welcome. Please see the documentation for development guidelines, including how to write tests, follow code style conventions, and submit pull requests.

Bug reports and feature requests can be filed on the GitHub issue tracker.

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

laser_measles-0.10.0.tar.gz (97.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

laser_measles-0.10.0-py3-none-any.whl (143.2 kB view details)

Uploaded Python 3

File details

Details for the file laser_measles-0.10.0.tar.gz.

File metadata

  • Download URL: laser_measles-0.10.0.tar.gz
  • Upload date:
  • Size: 97.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for laser_measles-0.10.0.tar.gz
Algorithm Hash digest
SHA256 440909a88a454a58500758feb37ef96c375b3ecc4f266adb999e478542f32246
MD5 3804549fa5aa84ad672cd75b0a490518
BLAKE2b-256 923e14208a798810dec73c0d866994af40a6d8667345179b8dbd178e39df48c7

See more details on using hashes here.

Provenance

The following attestation bundles were made for laser_measles-0.10.0.tar.gz:

Publisher: publish-pypi.yml on InstituteforDiseaseModeling/laser-measles

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file laser_measles-0.10.0-py3-none-any.whl.

File metadata

  • Download URL: laser_measles-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 143.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for laser_measles-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5f39757fe94950041b66769db910e415f7c8dffa028635ff4014a261539f6a0b
MD5 29aa5da308f6615596815ed596d6ae42
BLAKE2b-256 08fdd60faf55ec5fcc0e0768c0e5d1e1ccfcbf71bfb281e79d6468d28d8da037

See more details on using hashes here.

Provenance

The following attestation bundles were made for laser_measles-0.10.0-py3-none-any.whl:

Publisher: publish-pypi.yml on InstituteforDiseaseModeling/laser-measles

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page