Skip to content

About

An algebraic approach to defining mechanistic epidemiological models, along with state-spaces approaches to fitting and forecasting

Resources

Stars

4 stars

Watchers

0 watching

Forks

Repository files navigation

AlgebraicEpiModels

Julia packages for building compartmental epidemic models by algebraic composition (Libkind et al. 2023) and fitting them to surveillance data.

Package What it does
AlgebraicEpiMech Builds models as typed Petri nets and composes them: stratification and strain structure by pullback, observation delay chains by pushout. Any composed net is an ODE vector field.
ConfigurableEpi Turns a net into a stochastic state-space model with latent drivers and an observation model, fits it to a count series with filtering methods, and forecasts.

Documentation: https://cdcgov.github.io/AlgebraicEpiModels

Getting started

The packages need Julia 1.11 or later and are not yet registered. Add them from GitHub, AlgebraicEpiMech first:

using Pkg
Pkg.add(url = "https://github.com/CDCgov/AlgebraicEpiModels", subdir = "AlgebraicEpiMech")
Pkg.add(url = "https://github.com/CDCgov/AlgebraicEpiModels", subdir = "ConfigurableEpi")

See Getting started for a first model and fit, and the examples for more.

Contributing

Common tasks are recipes in the justfile, e.g. just test AlgebraicEpiMech and just docs-build. The documentation site is built from docs/; see Maintaining the docs for how the API and example pages are generated.

Admins

  • Sam Brand (USI1)

Disclaimers

General Disclaimer

This repository was created for use by CDC programs to collaborate on public health related projects in support of the CDC mission. GitHub is not hosted by the CDC, but is a third party website used by CDC and its partners to share information and collaborate on software. CDC use of GitHub does not imply an endorsement of any one particular service, product, or enterprise.

Public Domain Standard Notice

This repository constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105. This repository is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication. All contributions to this repository will be released under the CC0 dedication. By submitting a pull request you are agreeing to comply with this waiver of copyright interest.

License Standard Notice

This repository is licensed under Apache-2.0 or later.

This source code in this repository is free: you can redistribute it and/or modify it under the terms of the Apache License, Version 2.0, or (at your option) any later version.

This source code in this repository is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache Software License for more details.

You should have received a copy of the Apache Software License along with this program. If not, see http://www.apache.org/licenses/LICENSE-2.0.html

The source code forked from other open source projects will inherit its license.

Privacy Standard Notice

This repository contains only non-sensitive, publicly available data and information. All material and community participation is covered by the Disclaimer and Code of Conduct. For more information about CDC's privacy policy, please visit https://www.cdc.gov/other/privacy.html.

Contributing Standard Notice

Anyone is encouraged to contribute to the repository by forking and submitting a pull request. (If you are new to GitHub, you might start with a basic tutorial.) By contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the terms of the Apache Software License v2 or later.

All comments, messages, pull requests, and other submissions received through CDC including this GitHub page may be subject to applicable federal law, including but not limited to the Federal Records Act, and may be archived. Learn more at http://www.cdc.gov/other/privacy.html.

Records Management Standard Notice

This repository is not a source of government records but is a copy to increase collaboration and collaborative potential. All government records will be published through the CDC web site.

About

An algebraic approach to defining mechanistic epidemiological models, along with state-spaces approaches to fitting and forecasting

Resources

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages