-
Notifications
You must be signed in to change notification settings - Fork 4
flepimop.org documentation updates for information pertaining to new users #460
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
flepimop.org documentation updates for information pertaining to new users #460
Conversation
Changing documentation to reflect upcoming changes in user local installation processes and moving towards eliminating `flepimop_sample` as a step in running for new users.
My question to reviewers is: should I go ahead and search for all references to |
My vote would be to do it all in one pass as to minimize confusion. |
places where HOW TO RUN
GEMPYOR: MODELING INFECTIOUS DISEASE DYNAMICS
MODEL INFERENCE
|
I'm going to hold off on reviewing until this, unless you want me to review now @emprzy? |
A question for @pearsonca (or anyone else that cares to chime in). We are very close to purging ![]() ![]() |
This does not change `--data_path`, the CL option, just the envvar `DATA_PATH`.
Sorry for the mid-way expansion of what this PR covers, but it's ready for review now! |
Co-authored-by: Timothy Willard <[email protected]>
Co-authored-by: Timothy Willard <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
progress, but seems like several open items.
documentation/gitbook/how-to-run/advanced-run-guides/quick-start-guide-conda.md
Show resolved
Hide resolved
documentation/gitbook/how-to-run/advanced-run-guides/quick-start-guide-conda.md
Show resolved
Hide resolved
<summary>Help! I have errors in installation</summary> | ||
|
||
If you get an error because no cran mirror is selected, just create in your home directory a `.Rprofile` file: | ||
You can check that the variables have been set by either typing `env` to see all defined environmental variables, or typing `echo $FLEPI_PATH` to see the value of `FLEPI_PATH`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
probably shouldn't suggest people env
- going to spam them confusingly.
documentation/gitbook/how-to-run/advanced-run-guides/quick-start-guide-conda.md
Show resolved
Hide resolved
|
||
Other environmental variables can be set at any point in process of setting up your model run. These options are listed in ... ADD ENVAR PAGE | ||
Other environmental variables can be set at any point in process of setting up your model run. These options are listed in ... **ADD ENVAR PAGE** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't mind a live TODO, but it should be in a comment, rather than actively displayed. Probably a better version is to convert this to an item on an explicit issue, e.g. the new environmental variables one. Basically an explicit note "in file XYZ, section ABC, ..."
documentation/gitbook/how-to-run/advanced-run-guides/quick-start-guide-conda.md
Show resolved
Hide resolved
documentation/gitbook/how-to-run/advanced-run-guides/quick-start-guide-conda.md
Show resolved
Hide resolved
documentation/gitbook/how-to-run/advanced-run-guides/running-on-a-hpc-with-slurm.md
Show resolved
Hide resolved
documentation/gitbook/how-to-run/advanced-run-guides/running-with-docker-locally.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Carl A. B. Pearson <[email protected]>
...al/us-specific-how-to-run/running-with-docker-on-aws/aws-submission-instructions-covid-19.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
needs the one fix, then fine to merge
…ing-with-docker-on-aws/aws-submission-instructions-covid-19.md Co-authored-by: Carl A. B. Pearson <[email protected]>
Describe your changes.
This pull request...
flepimop_sample
from code and documentation; replacing it with theflepiMoP/examples/tutorials
directory,DATA_PATH
withPROJECT_PATH
. It does not attempt to adjust the command line option--data_path
, as I believe @TimothyWillard said he was working on editing the CLI options.Does this pull request make any user interface changes? If so please describe.
New users will be able to install flepiMoP (all packages and dependencies along with initialization of a
conda
environment) with a single script that they can run from CL.What does your pull request address? Tag relevant issues.
This pull request addresses necessary documentation changes resulting from issue GH #401 and pull request GH #418.
Because of eradication of
flepimop_sample
, it also serves GH #368.