Vivarium Research Template

Template for producing research repositories for use with vivarium and vivarium_public_health <https://github.com/ihmeuw/vivarium_public_health>_.

Contents

• Usage
• Development

Usage

A new github repository can be created using this template by running:

> cookiecutter git@githubcom:ihmeuw/vivarium_research_template.git

Complete instructions for setting up a new github model repository can be found on the hub.

Development

First, we recommend creating a conda environment or virtualenv to isolate your development environment. Then install the dependencies with pip install -r requirements.txt. To test out your changes, you can run cookiecutter <repo_dir> where repo_dir is the path to your clone of this repository. That command will create the instance of the template in the current directory.

Things for the Vivarium Developers to keep an eye on:

• model_specifications/{{cookiecutter.package_name}}.yaml

  Ensure the components and configuration keys supplied are kept up to date.