Skip to content

Latest commit

 

History

History
123 lines (75 loc) · 3.13 KB

README.rst

File metadata and controls

123 lines (75 loc) · 3.13 KB

Overview

docs Documentation Status
tests GitHub Actions Build Status Coverage Status
package PyPI Package latest release PyPI Wheel Supported versions Supported implementations Commits since latest release

PHASER - Polio Huge Agent Simulation for ERadication

  • Free software: MIT license

Installation

pip install laser-polio

You can also install the in-development version with:

pip install https://github.com/InstituteforDiseaseModeling/laser-polio/archive/main.zip

Documentation

https://docs.idmod.org/projects/laser-polio

Development

We strongly recommend using uv to create and manage virtual environments, including configuring tox to use uv for building test environments. To install uv run:

pip install uv

To create a new environment run:

uv venv --python=3.9 .venv

To activate the environment on Linux or MacOS run:

source .venv/bin/activate

To activate the environment on Windows run:

.venv\Scripts\activate.bat

To configure tox to use uv run:

uv tool install tox --with tox-uv

To run all the tests run:

tox

There are several tox environments that can be run individually. To see the full list of environments run:

tox -l

Note, to combine the coverage data from all the tox environments run:

Windows
set PYTEST_ADDOPTS=--cov-append
tox
Other
PYTEST_ADDOPTS=--cov-append tox