pip install --upgrade pip
pip install "pymmunomics @ git+https://github.com/ArnaoutLab/pymmunomics"for developers:
pip install --upgrade pip
git clone https://github.com/ArnaoutLab/pymmunomics
cd pymmunomics
pip install -e ".[dev]"Do not make changes to main branch or docs branch without reading this:
-
Make changes in separate branch and when tests pass, merge into
main. -
Every time
mainis updated, do the following:- merge
mainintodocs - run sphinx (
cd docsand./build.sh) - push changes in
docsbranch to github - Make sure to update the version in
pyproject.tomlaccordingly
- merge
-
Do not merge
docsintomain -
Do not make changes in
docsbranch outside docs directory
This set-up is the best way I know at the time of this writing to keep
the docs branch on a separate branch and not have it be part of the
user installation.