Here you'll find a variety of useful information about working on vivarium
research projects.
The hosted documentation can be found at https://vivarium-research.readthedocs.io/en/latest/.
Information on how to contribute to vivarium research docs can be found at https://vivarium-research.readthedocs.io/en/latest/onboarding_resources/contributing/index.html.
Use the following steps to get set up to build the docs locally:
$> conda create -y --name=vivarium_research python=3.13 graphviz pandoc $> conda activate vivarium_research (vivarium_research) $> git clone https://github.com/ihmeuw/vivarium_research.git (vivarium_research) $> cd vivarium_research (vivarium_research) $> pip install -r requirements.txt
Test that you've got it with:
.. _build:
$> conda activate vivarium_research # This line is only needed if vivarium_research has not been activated yet (vivarium_research) $> sphinx-autobuild docs/source docs/build/