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]: A Start To Finish Analysis Tutorial #452

Open
TimothyWillard opened this issue Jan 8, 2025 · 0 comments
Open

[Feature request]: A Start To Finish Analysis Tutorial #452

TimothyWillard opened this issue Jan 8, 2025 · 0 comments
Labels
documentation Relating to ReadMEs / gitbook / vignettes / etc. enhancement Request for improvement or addition of new feature(s). gempyor Concerns the Python core. high priority High priority.

Comments

@TimothyWillard
Copy link
Contributor

TimothyWillard commented Jan 8, 2025

Label

documentation, enhancement, gempyor

Priority Label

high priority

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

There is the "flepiMoP Homework" which walks users through:

  1. Installing flepiMoP,
  2. Doing a few runs, one local and one on an HPC, with existing configurations, and
  3. Making a minor modification to a configuration.

This homework, while helpful for a quick test of a user's installation and getting used to the common commands, is lacking to get a user prepared for handling an operation or doing research work. The homework uses existing configurations rather than asking users to write configurations, it uses configurations that work rather than showing users how to debug a configuration issue, and skips over post-processing steps that are critical to practical uses of flepiMoP.

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

No response

Describe the solution you'd like

A new tutorial added to the flepiMoP GitBook that:

  1. Pulls a data set to work with and auxiliary data files,
  2. Creates an initial configuration file for model,
  3. Runs the model and inspects the output with post-processing,
  4. Makes some improvement to the configuration in light of the post-processing,
  5. Runs the model and inspects the output with post-processing, and
  6. Creates a file output dataset that would be suitable to SMH.

Other elements that could be helpful to add to the tutorial include doing some of this work on HPC or intentionally creating an invalid configuration and working through debugging.

@TimothyWillard TimothyWillard added documentation Relating to ReadMEs / gitbook / vignettes / etc. enhancement Request for improvement or addition of new feature(s). gempyor Concerns the Python core. high priority High priority. labels Jan 8, 2025
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. enhancement Request for improvement or addition of new feature(s). gempyor Concerns the Python core. high priority High priority.
Projects
None yet
Development

No branches or pull requests

1 participant