Instructions to use pre-installed versions on HPC clusters

[remi-kazeroni]

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.

• Closes Add documentation on how to source and run/use esmvaltool from HPC central installations #2196
• Link to documentation: https://docs.esmvaltool.org/en/latest/quickstart/installation.html

---

Before you get started

• ☝ Create an issue to discuss what you are going to do

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.

• 🛠 This pull request has a descriptive title
• 🛠 Code is written according to the code quality guidelines
• 🛠 Documentation is available
  - [ ] 🛠 Tests run successfully
  - [ ] 🛠 The list of authors is up to date
  - [ ] 🛠 Any changed dependencies have been added or removed correctly
• 🛠 All checks below this pull request were successful

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:

• 🙏 We kindly ask you to review two other open pull requests in this repository

[zklaus]

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]

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.

[valeriupredoi]

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]

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]

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

[remi-kazeroni]

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.