Installing vivarium-engine

Overview

vivarium-engine is written in Python and supports Python 3.10-3.13.

Installation from PyPI

vivarium-engine is published on the Python Package Index. The preferred tool for installing packages from PyPI is pip, which ships with all modern versions of Python.

Note

If you had the legacy vivarium package installed (pre-monorepo), uninstall it before installing vivarium-engine to avoid file conflicts on the shared vivarium namespace:

$ pip uninstall vivarium

On Linux or MacOS, run:

$ pip install -U vivarium-engine

On Windows, open Command Prompt and run the same command.

C:\> pip install -U vivarium-engine

After installation, run simulate test. This will run a test simulation packaged with the framework and validate that everything is installed correctly.

Installation from source

vivarium-engine lives in the vivarium-suite monorepo. Clone the monorepo and install from this package directory:

$ git clone https://github.com/ihmeuw/vivarium-suite.git
$ cd vivarium-suite
$ pip install libs/engine

For broader monorepo development setup, see the monorepo README.