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

Instructions to use pre-installed versions on HPC clusters #2197

Merged
merged 2 commits into from Jun 17, 2021

Conversation

remi-kazeroni
Copy link
Contributor

@remi-kazeroni remi-kazeroni commented Jun 15, 2021

Description

The information about how to use the pre-installed ESMValTool on HPC clusters (Mistral, Jasmin) is currently only available in the ESMValCore documentation. This PR adds the information to the list of possible ways to install/use the ESMValTool.


Before you get started

Checklist

It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the πŸ›  Technical or πŸ§ͺ Scientific review.

New or updated recipe/diagnostic

- [ ] πŸ§ͺ Recipe runs successfully
- [ ] πŸ§ͺ Recipe is well documented
- [ ] πŸ§ͺ Figure(s) and data look as expected from literature
- [ ] πŸ›  Provenance information has been added

New or updated data reformatting script

- [ ] πŸ›  Documentation is available
- [ ] πŸ›  The dataset has been added to the CMOR check recipe
- [ ] πŸ§ͺ Numbers and units of the data look physically meaningful


To help with the number of pull requests:

@remi-kazeroni remi-kazeroni marked this pull request as ready for review June 15, 2021 15:39
@zklaus
Copy link
Contributor

zklaus commented Jun 16, 2021

Might it actually make sense to move/remove the documentation from the ESMValCore, since this is really targeted to end-users? I think it is a bit unfortunate to have the same information in two places, so perhaps we can keep it here, with the tool and just put a link to this page into the ESMValCore documentation?

@remi-kazeroni
Copy link
Contributor Author

Might it actually make sense to move/remove the documentation from the ESMValCore, since this is really targeted to end-users? I think it is a bit unfortunate to have the same information in two places, so perhaps we can keep it here, with the tool and just put a link to this page into the ESMValCore documentation?

That is a good point. I have done that in the ESMValCore PR #1186. Note that #1186 will only work once this PR is merged.

Copy link
Contributor

@valeriupredoi valeriupredoi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice one @remi-kazeroni - I think we should probably leave the doc in ESMValCore too just so people that want to use only Core functionality can do that, but it's becoming a nuisance to make sure that the two sets of doc are in sync so if you decide to remove it from Core docs as @zklaus suggests, I won't make a fuss of it 😁 EDIT: just saw your last comment about the link in Core docs - good stuff! πŸ‘

@zklaus
Copy link
Contributor

zklaus commented Jun 17, 2021

nice one @remi-kazeroni - I think we should probably leave the doc in ESMValCore too just so people that want to use only Core functionality can do that, but it's becoming a nuisance to make sure that the two sets of doc are in sync so if you decide to remove it from Core docs as @zklaus suggests, I won't make a fuss of it grin

Is that even technically an option? Can you do module load esmvalcore?

@valeriupredoi
Copy link
Contributor

no, but you can import esmvalcore modules and use them in your work

@remi-kazeroni
Copy link
Contributor Author

Thanks for your input @valeriupredoi and @zklaus! I suggest to get this merged since approved and discuss the core documentation in the other PR. I'll transfer your comments there.

@zklaus zklaus merged commit c629a1b into main Jun 17, 2021
@zklaus zklaus deleted the add_hpc_module_load_documentation branch June 17, 2021 11:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation on how to source and run/use esmvaltool from HPC central installations
3 participants