Skip to content

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

Merged
merged 11 commits into from
Feb 7, 2025

Conversation

emprzy
Copy link
Collaborator

@emprzy emprzy commented Jan 9, 2025

Describe your changes.

This pull request...

  • Changes documentation to reflect imminent changes in user local installation processes (affecting 'before any run' and 'quick start guide' sections of the flepimop.org documentation),
  • Fully eradicates flepimop_sample from code and documentation; replacing it with the flepiMoP/examples/tutorials directory,
  • Replaces all environmental variable instances of DATA_PATH with PROJECT_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.

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.
@TimothyWillard TimothyWillard added documentation Relating to ReadMEs / gitbook / vignettes / etc. medium priority Medium priority. labels Jan 10, 2025
@emprzy emprzy marked this pull request as ready for review January 10, 2025 20:09
@emprzy
Copy link
Collaborator Author

emprzy commented Jan 10, 2025

My question to reviewers is: should I go ahead and search for all references to flepimop_sample in other places in the documentation and replace them with flepiMoP/examples/tutorials, or should I do that in another PR?

@TimothyWillard
Copy link
Contributor

My question to reviewers is: should I go ahead and search for all references to flepimop_sample in other places in the documentation and replace them with flepiMoP/examples/tutorials, or should I do that in another PR?

My vote would be to do it all in one pass as to minimize confusion.

@emprzy
Copy link
Collaborator Author

emprzy commented Jan 17, 2025

places where flepimop_sample is referenced (need to be resolved):

HOW TO RUN

  • before any run
  • quick start guide
  • advanced run guides ->
  • running with a docker locally
  • running locally in a conda environment
  • running on a HPC with slurm

GEMPYOR: MODELING INFECTIOUS DISEASE DYNAMICS

  • model output

MODEL INFERENCE

  • inference model output

@TimothyWillard
Copy link
Contributor

places where flepimop_sample is referenced (need to be resolved):

I'm going to hold off on reviewing until this, unless you want me to review now @emprzy?

@emprzy
Copy link
Collaborator Author

emprzy commented Jan 27, 2025

A question for @pearsonca (or anyone else that cares to chime in). We are very close to purging data_path as a config key from the flepiMoP codebase, but DATA_PATH as an environmental variable referring to a place where data exists is still present in the documentation and code. How would we feel about universally moving towards using PROJECT_PATH to refer to these instances (unless there is a distinction between PROJECT_PATH and DATA_PATH that I am not familiar with)? I've included an example each of where PROJECT_PATH exists in the documentation, and where DATA_PATH does, and you can let me know what you think:

Screenshot 2025-01-27 at 1 39 50 PM from how-to-run quick start guide Screenshot 2025-01-27 at 1 44 47 PM from how-to-run useful commands

This does not change `--data_path`, the CL option, just the envvar `DATA_PATH`.
@emprzy
Copy link
Collaborator Author

emprzy commented Jan 31, 2025

Sorry for the mid-way expansion of what this PR covers, but it's ready for review now!

@TimothyWillard TimothyWillard added the next release Marks a PR as a target to include in the next release. label Feb 3, 2025
Copy link
Contributor

@pearsonca pearsonca left a 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.

<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`.
Copy link
Contributor

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.


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**
Copy link
Contributor

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, ..."

Copy link
Contributor

@pearsonca pearsonca left a 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]>
@emprzy emprzy merged commit 6961e3d into HopkinsIDD:dev Feb 7, 2025
4 checks passed
@emprzy emprzy deleted the installation-documentation-updates branch February 7, 2025 21:16
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. medium priority Medium priority. next release Marks a PR as a target to include in the next release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants