Skip to content

Commit

Permalink
Merge pull request #234 from emprzy/emprzy-issue189-documentation
Browse files Browse the repository at this point in the history
Update quick-start-guide.md
  • Loading branch information
jcblemai committed Jul 11, 2024
2 parents 8686d4f + c3d8388 commit 7f18e30
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions documentation/gitbook/how-to-run/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,13 @@ _**A warning for Windows**_\
Once _gempyor_ is successfully installed locally, you will need to make sure the executable file `gempyor-seir.exe` is runnable via command line. To do this, you will need to add the directory where it was created to PATH. Follow the instructions [here](https://techpp.com/2021/08/26/set-path-variable-in-windows-guide/) to add the directory where this .exe file is located to PATH. This can be done via GUI or CLI.
{% endhint %}

If you would like to install _gempyor_ directly from GitHub, go to the flepiMoP directory and use the following command:

```bash
cd $FLEPI_PATH
pip install --no-deps "git+https://github.com/HopkinsIDD/flepiMoP.git@main#egg=gempyor&subdirectory=flepimop/gempyor_pkg"
```

If you just want to [run a forward simulation](quick-start-guide.md#non-inference-run), installing python's _gempyor_ is all you need.

To [run an inference run](quick-start-guide.md#inference-run) and to explore your model outputs using provided post-processing functionality, there are some packages you'll need to **install in R**. Open your **R terminal** (at the bottom of RStudio, or in the R IDE), and run the following command to install the necessary R packages:
Expand Down

0 comments on commit 7f18e30

Please sign in to comment.