COVID-19 agent-based simulator
Project description
Covasim
Covasim is a stochastic agent-based simulator designed to be used for COVID-19 (novel coronavirus, SARS-CoV-2) epidemic analyses. These include projections of indicators such as numbers of infections and peak hospital demand. Covasim can also be used to explore the potential impact of different interventions.
Requirements
Python >=3.6 (64-bit). (Note: Python 2 is not supported.)
We also recommend, but do not require, using Python virtual environments. For more information, see documentation for venv or Anaconda.
Quick start guide
Install with pip install covasim. If everything is working, the following Python commands should bring up a plot:
import covasim as cv
sim = cv.Sim()
sim.run()
sim.plot()
Detailed installation instructions
-
Clone a copy of the repository. If you intend to make changes to the code, we recommend that you fork it first.
-
(Optional) Create and activate a virtual environment.
-
Navigate to the root of the repository and install the Covasim Python package using one of the following options:
-
To install with webapp support (recommended):
python setup.py develop -
To install as a standalone Python model without webapp support:
python setup.py develop nowebapp -
To install Covasim and optional dependencies (be aware this may fail since it relies on private packages), enter:
python setup.py develop full
The module should then be importable via
import covasim. -
Detailed usage
There are several examples in the examples directory. These can be run as
follows:
-
python examples/simple.pyThis example creates a figure using default parameter values.
-
python examples/run_sim.pyThis shows a slighly more detailed example, including creating an intervention and saving to disk.
-
python examples/run_scenarios.pyThis shows a more complex example, including running an intervention scenario, plotting uncertainty, and performing a health systems analysis.
Structure
All core model code is located in the covasim subfolder; standard usage is
import covasim as cv. The other subfolders, cruise_ship and webapp, are
also described below.
The model consists of two core classes: the Person class (which contains
information on health state), and the Sim class (which contains methods for
running, calculating results, plotting, etc.).
covasim
The structure of the covasim folder is as follows:
base.py: TheParsObjclass, plus basic methods of theBaseSimclass, and associated functions.healthsystem.py: TheHealthSystemclass, for determining hospital capacity and treatment rates.interventions.py: TheInterventionclass, for adding interventions and dynamically modifying parameters.parameters.py: Functions for creating the parameters dictionary and loading the input data.people.py: ThePersonclass, and functions to create a population of people.requirements.py: A simple module to check that imports succeeded, and turn off features if they didn't.run.py: Functions for running simulations (e.g. parallel runs and scenarios).sim.py: TheSimclass, which performs most of the heavy lifting: initializing the model, running, and plotting.utils.py: Functions for choosing random numbers, many based on Numba, plus other helper functions.version.py: Version, date, and license information.
cruise_ship
A version of the Covasim model specifically adapted for modeling the Diamond
Princess cruise ship. It uses its own parameters file (parameters.py) and has
slight variations to the model (model.py).
webapp
For running the interactive web application: please see the README.md in that
folder for more information, including information on running locally and Docker
deployment.
Disclaimer
The code in this repository was developed by IDM to support our research in disease transmission and managing epidemics. We’ve made it publicly available under the Creative Commons Attribution-Noncommercial-ShareAlike 4.0 License to provide others with a better understanding of our research and an opportunity to build upon it for their own work. We make no representations that the code works as intended or that we will provide support, address issues that are found, or accept pull requests. You are welcome to create your own fork and modify the code to suit your own modeling needs as contemplated under the Creative Commons Attribution-Noncommercial-ShareAlike 4.0 License.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file covasim-0.23.5.tar.gz.
File metadata
- Download URL: covasim-0.23.5.tar.gz
- Upload date:
- Size: 492.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2.post20191203 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d9c32bb14278feb55622cb55f93e7647740fb172907ea7071cd4b0ea4d9ee986 |
|
| MD5 | 6a0cf45e3fa7e7affbc200d83000f1da |
|
| BLAKE2b-256 | e37eeb683e9bdc03d5398b3633c450a50e9511d4d54eec96ab36dc5f77582eba |
File details
Details for the file covasim-0.23.5-py3-none-any.whl.
File metadata
- Download URL: covasim-0.23.5-py3-none-any.whl
- Upload date:
- Size: 463.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2.post20191203 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.7.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1ef4e9ca381c1bbe2d1537e83c4c5ed58fd93bc8a498197fec7b8433634c405e |
|
| MD5 | ae1b32a412ed56f4f6694c6c4aa4fd96 |
|
| BLAKE2b-256 | 9a525e4c8ca4addd99aff676f7d4cd7e70cf187c0900c56de00486d105a56fa8 |
