# CFA Model Run Protocol (CFA-MRP)

## Overview

MRP is a layered protocol for running computational
disease models. It defines a standard interface between
tooling and model code: **a model is a function that
accepts JSON and produces output.**

The SDK handles config parsing, file staging, and runtime
dispatch — so models stay simple.

## General Disclaimer

**General disclaimer** This repository was created for use by CDC programs to
collaborate on public health related projects in support of the
[CDC mission](https://www.cdc.gov/about/cdc/#cdc_about_cio_mission-our-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.

See also the longer [Disclaimer](DISCLAIMER.md) and the [Notices](#Notices)
section below.

## Developing the MRP library

### Tasks

Common workflows are defined as
[poe](https://poethepoet.naez.io/) tasks
in `pyproject.toml`:

| Task | Command | Description |
|---|---|---|
| `poe test` | `pytest` | Run tests |
| `poe lint` | `ruff check .` | Lint Python |
| `poe typecheck` | `ty check src` | Type check |
| `poe renewal` | `mrp run ...` | Run renewal example |

## Notices

### 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](https://creativecommons.org/publicdomain/zero/1.0/).
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

The repository utilizes code licensed under the terms of the Apache Software
License and therefore is licensed under ASL v2 or later.

This source code in this repository is free: you can redistribute it and/or modify it under
the terms of the Apache Software License version 2, 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](DISCLAIMER.md)
and [Code of Conduct](https://github.com/CDCgov/template/blob/main/code-of-conduct.md).
For more information about CDC's privacy policy, please visit [http://www.cdc.gov/other/privacy.html](https://www.cdc.gov/other/privacy.html).

### Contributing Standard Notice

Anyone is encouraged to contribute to the repository by [forking](https://help.github.com/articles/fork-a-repo)
and submitting a pull request. (If you are new to GitHub, you might start with a
[basic tutorial](https://help.github.com/articles/set-up-git).) 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](http://www.apache.org/licenses/LICENSE-2.0.html) 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](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](http://www.cdc.gov).
