======== Vivarium

.. image:: https://badge.fury.io/py/vivarium.svg :target: https://badge.fury.io/py/vivarium

.. image:: https://github.com/ihmeuw/vivarium/actions/workflows/build.yml/badge.svg?branch=main :target: https://github.com/ihmeuw/vivarium :alt: Latest Version

.. image:: https://readthedocs.org/projects/vivarium/badge/?version=latest :target: https://vivarium.readthedocs.io/en/latest/?badge=latest :alt: Latest Docs

.. image:: https://zenodo.org/badge/96817805.svg :target: https://zenodo.org/badge/latestdoi/96817805

Vivarium is a simulation framework written using standard scientific Python tools.

Vivarium requires Python 3.8-3.11 to run

You can install vivarium from PyPI with pip:

> pip install vivarium

or build it from source with

> git clone https://github.com/ihmeuw/vivarium.git

> cd vivarium

> conda create -n ENVIRONMENT_NAME python=3.11

> pip install -e .[dev]

This will make the vivarium library available to python and install a command-line executable called simulate that you can use to verify your installation with

> simulate test

Check out the docs! <https://vivarium.readthedocs.io/en/latest/>_