Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature request]: User Local Install Documentation #401

Open
TimothyWillard opened this issue Nov 15, 2024 · 1 comment
Open

[Feature request]: User Local Install Documentation #401

TimothyWillard opened this issue Nov 15, 2024 · 1 comment
Assignees
Labels
documentation Relating to ReadMEs / gitbook / vignettes / etc. high priority High priority. installation Relating to installation / upgrade / migration.

Comments

@TimothyWillard
Copy link
Contributor

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.

@TimothyWillard TimothyWillard added documentation Relating to ReadMEs / gitbook / vignettes / etc. high priority High priority. installation Relating to installation / upgrade / migration. labels Nov 15, 2024
@TimothyWillard TimothyWillard added this to the Under 1Hr New Users! milestone Nov 15, 2024
@pearsonca
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relating to ReadMEs / gitbook / vignettes / etc. high priority High priority. installation Relating to installation / upgrade / migration.
Projects
None yet
Development

No branches or pull requests

3 participants