Metadata-Version: 2.4
Name: emodpy
Version: 3.3.1
Summary: Core tools for modeling using EMOD
Author-email: Sharon Chen <sharon.chen@gatesfoundation.org>, Zhaowei Du <zhaowei.du@gatesfoundation.org>, Clark Kirkman IV <clark.kirkmand@gatesfoundation.org>, Daniel Bridenbecker <daniel.bridenbecker@gatesfoundation.org>, Svetlana Titova <svetlana.titova@gatesfoundation.org>, Ye Chen <ye.chen@gatesfoundation.org>
License-Expression: MIT
Project-URL: Repository, https://github.com/EMOD-Hub/emodpy
Project-URL: Documentation, https://emod.idmod.org/emodpy/
Project-URL: Issues, https://github.com/EMOD-Hub/issues-and-discussions/issues
Keywords: modeling,IDM
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: idmtools[full]~=3.0
Requires-Dist: emod-api~=3.2
Requires-Dist: geographiclib
Provides-Extra: docs
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocs-include-markdown-plugin; extra == "docs"
Requires-Dist: mkdocstrings-python; extra == "docs"
Requires-Dist: mkdocs-autoapi; extra == "docs"
Requires-Dist: mkdocs-glightbox; extra == "docs"
Requires-Dist: mkdocs-table-reader-plugin; extra == "docs"
Provides-Extra: lint
Requires-Dist: flake8; extra == "lint"
Provides-Extra: test
Requires-Dist: emod-common~=2.34; extra == "test"
Requires-Dist: emod-generic~=2.34; extra == "test"
Requires-Dist: emod-hiv~=2.34; extra == "test"
Requires-Dist: emod-malaria~=2.34; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-xdist; extra == "test"
Dynamic: license-file

# emodpy

**emodpy** is a shared Python workflow infrastructure used by disease-specific EMOD packages.

[![Build docs and deploy to GH Pages](https://github.com/EMOD-Hub/emodpy/actions/workflows/mkdocs_deploy.yml/badge.svg)](https://github.com/EMOD-Hub/emodpy/actions/workflows/mkdocs_deploy.yml)
[![Lint](https://github.com/EMOD-Hub/emodpy/actions/workflows/lint.yml/badge.svg)](https://github.com/EMOD-Hub/emodpy/actions/workflows/lint.yml)
[![Test and update version](https://github.com/EMOD-Hub/emodpy/actions/workflows/test_and_bump_version.yml/badge.svg)](https://github.com/EMOD-Hub/emodpy/actions/workflows/test_and_bump_version.yml)

## Project status

EMOD-Hub projects are provided as open source software under the MIT License for
community use, research, and development.

**Unless otherwise noted, these projects are no longer actively maintained or supported
by IDM or the Gates Foundation.**

Community contributions are welcome, and trusted collaborators may review and
merge pull requests, but no guarantees are made regarding support, pull request
review, security response, maintenance, or release timelines.

## Python Version

Python 3.13 is the recommended and supported version.

## Documentation

Documentation available at https://emod.idmod.org/emodpy/

To build the documentation locally, do the following:

1. Create and activate a venv.
2. Navigate to the root directory of the repo.
    ```
    python -m pip install .[docs]
    mkdocs serve
    ```

## Running tests

Please see the documentation for [testing](/tests/README.md).

## Community

Have a question or a comment? Check out our
[Discussions](https://github.com/orgs/EMOD-Hub/discussions) space.

## Contributing

If you have feature requests, issues, or new code, please see our
[CONTRIBUTING](https://github.com/EMOD-Hub/.github/blob/main/CONTRIBUTING.md)
page for how to provide your feedback.
