Extend getting started instructions to obtain config-user.yml #1642
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
First time users that use conda to install esmvaltool might have trouble getting to the config-user file. The docs point to the config-user-example.yml on github, but for those new users it may not be clear how to download a single file from there. This should make it a little bit more accessible.
Tasks
[ ] Create an issue to discuss what you are going to do, if you haven't done so already (and add the link at the bottom)I figured a PR was the easiest way to explain what I wanted to do.[ ] Make sure your code is composed of functions of no more than 50 lines and uses meaningful names for variables[ ] Please useyamllint
to check that your YAML files do not contain mistakes[ ] (Only if really necessary) Add any additional dependencies needed for the diagnostic script to setup.py, esmvaltool/install/R/r_requirements.txt or esmvaltool/install/Julia/julia_requirements.txt (depending on the language of your script) and also to package/meta.yaml for conda dependencies (includes Python and others, but not R/Julia)[ ] If new dependencies are introduced, check that the license is compatible with Apache2.0