What does the noresm2.2 branch contain? And what should be documented and how to document it?

[adagj]

@DirkOlivie @TomasTorsvik @MichaelSchulzMETNO

Hi,
we need to document the differences between noresm2 (cmip6) and noresm2.2. Can you make a list of the updates @DirkOlivie ? Or if you have a document (I remember some CLUBB changes at least), can you please share? I will try to start document it...

@TomasTorsvik should we only update the new stuff? It is not so different. And I guess this will also be the case for the KeyCLIM version.

Ada

[TomasTorsvik]

Hi,

I suggest that we only update/document the differences between noresm2.2 relative to noresm2.

This will be easier to maintain (hopefully), since we don't want to have duplicates of the documentation in different branches. At lest I think this makes sense for the experimental development versions of NorESM, and probably also for the KeyCLIM version, although for KeyCLIM we probably want a more extensive description of technical updates.

[oyvindseland]

Should we continue working on NorESM2.2 or recommend for any users? It is still useful to follow the history but may not receive any support.

[adagj]

I think that as long as noresm2.2 exists, we need to document it somehow. We can include a warming

[oyvindseland]

A warning is fine but should be worded in quite strong terms. It is even a chance that NorESM2.2 will be removed out of noresmhub altogether.

[TomasTorsvik]

I agree that a strongly worded, clearly marked warning is needed. However, I don't see why noresm2.2 should be removed from noresmhub. After all, the github repository should reflect the development history of the NorESM system, but it does not need to be streamlined. There may be reasons to remove a branch if

• the branch is merged into another project (in which case we probably want to build on the documentation)
• the upstream components are removed (i.e. the noresm2.2 can no longer build due to missing dependencies)

Other than that, I don't see any reasons to remove model versions, even if they are no longer in active development.

[oyvindseland]

Yes, I see your point about not removing. We have to be aware of that there may potentially be a number of new versions coming in soon, depending on how we organize the repository. NorESM-KeyClim a..d ; NorESM-Interrim aka NorESM2.5;NorESM-Forces; NorESM-ESM2025; NorESM-Makingwaves. These are just the versions I know about. There are likely a number of other versions as well.
You are right that these should be all documented but how.

[gold2718]

Where is this description going? On the NorESM README.md? Somewhere else?

[adagj]

Right now the noresm documentation only contains the cmip6 version (https://noresm-docs.readthedocs.io/en/noresm2/)
We also want to include documentation on other versions, like noresm2.2 and the keyclim version, which are quite similar to the cmip6 version but not identical. For the noresm2.2 version there exists som documentation on nudging that we want to include:
https://noresm22-nudging-regional.readthedocs.io/en/latest/Nudging.html

Since these versions are similar to the cmip6 version, we don't want to copy the entire documnetation but just include updates and differences.

We plan to include a short description about the versions and the documentation which follows a specific version in README, but we haven't really settled anything. The aim is to document, but to avoid too much maintenance.