High level of complexity - we need a first pass quick user guide about esmvaltool_tutorial HOT 7 OPEN

@ehogan , @SarahAlidoost - Does the quick start episode address the issues for a simple start to the tutorial? Ifso, we can close this issue.

from esmvaltool_tutorial.

So what do you think about the esmvaltool --demo idea. Where maybe even files/codes pop up, you are requested to hit y to go on, etc?

Not sure if this is done "easily", but I can imagine that it can be done.

from esmvaltool_tutorial.

@BenMGeo can we make this idea a bit more specific? What should it do. I suppose something like:

• Some small example data should be shipped with ESMValTool for a test/demo application
• You type esmvaltool run demo (new CLI) and then:
• The command line asks permission to make a new data directory in your CWD and copy the toy data there; you have to confirm with y
• The command line prints something like: "All set-up for a demo. To run your first recipe, type: esmvaltool run examples/recipe_demo.yml" and exits.
• You then copy the command and the demo runs.

Is that what you have in mind?

from esmvaltool_tutorial.

Is that what you have in mind?

Pretty much, yes.

• Some small example data should be shipped with ESMValTool for a test/demo application
• You type esmvaltool run demo (new CLI) and then:

(Maybe to make sure it is not confused with finding a file called demo, make it esmvaltool demo)

• The command line asks your definition of the working directory (declaring how much space it needs) and use the toy data directory as the data directory and setup the demo config accordingly; report all files that changed
• The command line prints something like: "All set-up for a demo, do you want to run?" and (confirmed with y) runs your first recipe esmvaltool run examples/recipe_demo.yml
• report all files that where set up and where to find the output
• report how to run your first recipe again by typing: esmvaltool run examples/recipe_demo.yml and exits.

slight changes, but even easier for a first time user.

Actually, I'd also suggest to have a seperate repository for demo data at some point, or maybe using iris demo data, if this is possible. So you can install some small data that can be used for examples.

from esmvaltool_tutorial.

@rswamina the quick start guide addresses some of the items mentioned in this issue, but not everything (there are some nice suggestions here!) 😊 Would it be worth discussing and taking forward some of these suggestions?

from esmvaltool_tutorial.

@LisaBock has this been addressed or was it an accidental close? 🍺

from esmvaltool_tutorial.

@LisaBock has this been addressed or was it an accidental close? 🍺

@valeriupredoi I tried to close some outdated issues. I missed that parts of these discussions not yet implemented. Sorry! I reopened the issue.

from esmvaltool_tutorial.