Add a link to the instructions to use pre-installed versions on HPC clusters

[remi-kazeroni]

Description

We are about to move the instructions to use pre-installed version of the ESMValTool on HPC clusters to the ESMValTool documentation in #2197. To avoid duplicating the instructions, the ESMValCore documention on the topic is replaced by a link to the same instructions in the ESMValTool documentation. This would offer better visibility for the pre-installed version (see comment).

Closes #989

Link to documentation:

• https://esmvaltool--2197.org.readthedocs.build/en/2197/quickstart/installation.html#pre-installed-versions-on-hpc-clusters
• https://docs.esmvaltool.org/projects/esmvalcore/en/latest/quickstart/install.html#pre-installed-versions-on-hpc-clusters

---

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.

• 🧪 The new functionality is relevant and scientifically sound
• 🛠 This pull request has a descriptive title and labels
• 🛠 Code is written according to the code quality guidelines
• 🧪 and 🛠 Documentation is available
  - [ ] 🛠 Unit tests have been added
• 🛠 Changes are backward compatible
• 🛠 Any changed dependencies have been added or removed correctly
• 🛠 The list of authors is up to date
• 🛠 All checks below this pull request were successful

---

To help with the number pull requests:

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

[remi-kazeroni]

This would only work after #2197 is merged to the ESMValTool. Please do not merge before.

[valeriupredoi]

props from me 👍

[remi-kazeroni]

@valeriupredoi wrote:

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 😁

[remi-kazeroni]

@zklaus asked:

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

[remi-kazeroni]

@valeriupredoi replied:

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

[remi-kazeroni]

The HPC instructions for the tool were merged in #2197 in the documentation. But these instructions do not appear in the documentation so the link I added in this PR for the Core documentation does not work. @zklaus @valeriupredoi would you know why this part is not displaed in the latest doumentation? Shall I open a separate issue for that?

[zklaus]

You bring up a good point that kind of surfaced already in the preparation of the core release: I, and probably most core developers, don't seem to have access to the relevant readthedocs configuration. That makes it hard to debug this kind of issue. Maybe we should widen the circle there a bit? Let's discuss at the next technical lead team meeting.

[remi-kazeroni]

You bring up a good point that kind of surfaced already in the preparation of the core release: I, and probably most core developers, don't seem to have access to the relevant readthedocs configuration. That makes it hard to debug this kind of issue. Maybe we should widen the circle there a bit? Let's discuss at the next technical lead team meeting.

I don't know what has changed but this issue is now solved. Yes that is something we need to put on the agenda for the next technical lead team meeting.

[remi-kazeroni]

@ESMValGroup/esmvaltool-coreteam would you prefer:

1. Duplicating the instructions for the Core and the Tool as done currently
2. Having only the intructions for the Tool
3. Having a link to the Tool instructions as done in this PR.

(For 3. the link does not work properly as I would need another commit to retrigger readthedocs but it works when I build the documentation locally).

[bouweandela]

You bring up a good point that kind of surfaced already in the preparation of the core release: I, and probably most core developers, don't seem to have access to the relevant readthedocs configuration. That makes it hard to debug this kind of issue. Maybe we should widen the circle there a bit? Let's discuss at the next technical lead team meeting.

@zklaus Did you try logging in with your GitHub credentials?

[bouweandela]

I clicked the rebuild button on the readthedocs builds page and the link works correctly now.

[zklaus]

@zklaus Did you try logging in with your GitHub credentials?

Yes, I did. I can see other github projects, but the ESMValGroup ones are not listed. If I navigate manually to ESMValCore, the "Admin" button is missing.

[bouweandela]

@zklaus I added you as a maintainer for the ESMValCore and ESMValTool readthedocs projects, you should have the button now.

[zklaus]

Jepp, that worked. Thanks, @bouweandela!

[valeriupredoi]

OK by me, cheers @remi-kazeroni - does the link work well?

[remi-kazeroni]

OK by me, cheers @remi-kazeroni - does the link work well?

Yes the documentation works fine. Thanks for the approval @valeriupredoi 👍