HopkinsIDD / flepiMoP

The Flexible Epidemic Modeling Pipeline
https://flepimop.org
GNU General Public License v3.0
9 stars 4 forks source link

[Feature request]: User Local Install Documentation #401

Open TimothyWillard opened 11 hours ago

TimothyWillard commented 11 hours ago

Label

documentation, installation

Priority Label

high priority

Is your feature request related to a problem? Please describe.

The process for installing flepiMoP locally can be greatly simplified to mimic that of the hpc_build_or_install.sh script. And for mac/linux users can also be simplified down to running a script that is very similar to that one. Might be possible for windows as well, but I'm not familiar with to know. This issue should supersede GH-168, GH-188, GH-189.

Is your feature request related to a new application, scenario round, pathogen? Please describe.

No response

Describe the solution you'd like

At the very least, the install portion of this documentation: https://iddynamics.gitbook.io/flepimop/how-to-run/quick-start-guide, should be split out into it's own page that covers:

  1. Cloning the flepiMoP repository,
  2. Creating a conda environment from the environment.yml file,
  3. Manually installing the covidcast R package, and
  4. Installing the custom R/python packages.

GH-329 should serve as a decent starting point.

pearsonca commented 9 hours ago

re windows, i think we need at minimum to support WSL install (which should be easy extension of the linux one).