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

Add examples of configs for use cases to the documentation #319

Open
ccarouge opened this issue Nov 8, 2024 · 0 comments
Open

Add examples of configs for use cases to the documentation #319

ccarouge opened this issue Nov 8, 2024 · 0 comments

Comments

@ccarouge
Copy link
Collaborator

ccarouge commented Nov 8, 2024

Currently, it can be hard to know exactly how to modify the bench_example config file for a new test run, especially the first time someone is using benchcab. It would be useful to have examples for different use cases:

  • basic
  • using a local path
  • with namelist patch
  • with names for realisation if using the same branch at different commits
  • more than 2 realisations
  • running fluxsites only
  • changing the PBS options
  • calling me.org API

It might be possible to illustrate all these use cases with only one example of a config file with annotations instead of several. Although having several might allow users to copy/paste the case they want to start off with.

@ccarouge ccarouge changed the title Add example full configs to the documentation Add examples of configs for use cases to the documentation Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant