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

Make user configuration file more user friendly #64

Closed
bouweandela opened this issue Jun 19, 2018 · 6 comments
Closed

Make user configuration file more user friendly #64

bouweandela opened this issue Jun 19, 2018 · 6 comments
Assignees
Labels
enhancement New feature or request

Comments

@bouweandela
Copy link
Member

bouweandela commented Jun 19, 2018

  • Do not use the template as a default because it never works
  • If no config file is suppllied, look if a file ~/.esmvaltool/config-user.yml exists and use that
  • If it doesn't exist, create it and tell the user to customize it (at least the paths section). If the user is on a known cluster, e.g. Jasmin, Mistral, etc, automatically use the right path
@ledm
Copy link
Contributor

ledm commented Jun 13, 2019

At our tutorial, @rjp23 has brought up the issues with the config-user.yml.

It's frustrating that users need to edit this file, but the documentation is not explicit. There should be a big red banner somewhere about it.

It should be easier for users to get started. Would it be possible to include the correct rootpath variables, but commented out in the standard user-config.yml?

Alternatively, perhaps there is an even better solution where the rootpaths are instead defined in config-developpers.yml so that user's don't have to define standardised paths in their config-user.yml (if they're working on a standard machine like jasmin) file?

@bouweandela
Copy link
Member Author

bouweandela commented Sep 4, 2019

@bouweandela
Copy link
Member Author

It's frustrating that users need to edit this file, but the documentation is not explicit. There should be a big red banner somewhere about it.

@ledm Note that pretty extensive documentation is now available here: https://esmvaltool.readthedocs.io/projects/esmvalcore/en/latest/quickstart/find_data.html
However, this really should be linked from https://esmvaltool.readthedocs.io/en/latest/quickstart/configuration.html

@schlunma
Copy link
Contributor

Can this be closed? I think most of the issues listed are solved.

@bouweandela
Copy link
Member Author

Yes, except for automatically finding out which cluster we're on, but let's close this.

@bouweandela
Copy link
Member Author

Unless you would like to keep it open @ledm?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

6 participants