Metadata-Version: 2.4
Name: emodpy-hiv
Version: 3.3.1
Summary: IDM's HIV-specific EMOD-API binding code
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-hiv
Project-URL: Documentation, https://emod.idmod.org/emodpy-hiv/
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.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.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: emodpy~=3.3
Requires-Dist: pandas~=3.0
Requires-Dist: scikit-learn~=1.8
Requires-Dist: python-calamine~=0.6
Requires-Dist: emod-hiv~=2.35
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: pytest; extra == "test"
Requires-Dist: pytest-xdist; extra == "test"
Requires-Dist: pytest-runner; extra == "test"
Requires-Dist: pytest-timeout; extra == "test"
Requires-Dist: pytest-cache; extra == "test"
Requires-Dist: coverage; extra == "test"
Requires-Dist: py-make; extra == "test"
Requires-Dist: pillow; extra == "test"
Requires-Dist: snakemake; extra == "test"
Dynamic: license-file

# emodpy-hiv

The Python interface for running EMOD HIV simulations.

![license](https://img.shields.io/badge/License-MIT-brightgreen.svg)

## Description

emodpy-hiv is the primary way to work with EMOD for HIV research. Use it to set up
transmission settings, define populations, and evaluate the impact of interventions such as
antiretroviral therapy, voluntary medical male circumcision, prevention of mother-to-child
transmission, and PrEP — then run simulations and analyze the results.

## 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.

## Try it now

No installation required. Open the repository in
[GitHub Codespaces](https://github.com/codespaces/new?repo=EMOD-Hub/emodpy-hiv),
wait for the environment to build, then run:

```
cd tutorials
python tutorial_1_intro.py
```

See the [tutorial setup page](https://emod.idmod.org/emodpy-hiv/tutorials/setup/) for
Codespaces and local installation instructions, and
[Tutorial 1](https://emod.idmod.org/emodpy-hiv/tutorials/tutorial-1/) for a walkthrough
of what the script does.

## Installation

```shell
pip install emodpy-hiv
```

For complete installation instructions, including Codespaces, container-based workflows,
and local environment setup, see:

https://emod.idmod.org/emodpy-hiv/installation/

For developers, see the [developer installation](developer_installation.md) instructions.

## Documentation

Full documentation: https://emod.idmod.org/emodpy-hiv

**Releases and changelog:** https://github.com/EMOD-Hub/emodpy-hiv/releases

## 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.
