Capture version deprecation information in CVs

[durack1]

We have had a single case of the SOLARIS-HEPPA-CMIP-4-2 retracted dataset which was promptly replaced with the replaced by SOLARIS-HEPPA-CMIP-4-3. In an associated issue, there is the note the problem was “encountered an issue with the proton ionization data in v4.2” 29 Jul 2024, but this is not prominently available.

It would be ideal to capture a meaningful description of the problem and how it is solved so that a modeling group can ascertain whether they need to pay attention to the data correction or proceed with their existing version. For this v4.2 -> v4.3 dataset update, presumably, most modeling groups would be concerned with wrong data (@vnaik60, do you use the proton ionization data for simulations?)., but in the case that there was a metadata inconsistency, then such a problem would be unlikely to require a data switchout.

ping @znichollscr @vnaik60

[znichollscr]

Hi both, I'd suggest capturing this in the following way:

1. we add a post-publication comment to the SOLARIS-HEPPA-4-2 data which explains why it was deprecated. That is added in Add post-publication comment for solaris-heppa-4-2 #91
2. we add a source ID level view to our docs, so it's easier for people to see what is going on at a higher level than what is provided by the files and dataset views (which have other benefits, so we should keep them, but no single view will serve all purposes). That is added in Add source ID level HTML view #92

The end result is a view like the following (note the search field in the top-right, which is why you only see solaris data in the screenshot), which I think looks pretty clear. If you want to play around with this view yourself, the preview is here

[vnaik60]

Excellent point @durack1! It would be important to keep track of the updates and reasons for deprecation of the previous version of the data just as was done manually in input4MIPs summary doc.
No, we dont use the proton ionization data for simulations.

@znichollscr this seems like a sensible approach to me, though, @durack1 would have more thoughts. By the way, did you lose the "latest" column in this version?

[durack1]

@znichollscr you are a wizard!

A couple of nits

• for the abandoned datasets, as the SOLARIS-HEPPA v4.1 was made available, but not through ESGF we need to be careful with details so how about "registered but never published to ESGF". This will also be the case with some of the alpha-prototype data that Tom has been handing about. As CR-CMIP-0-2-0 never saw the light of day (no external party ever got their hands on it, no?) this comment is accurate
• The the "latest" point of @vnaik60. This is buried in the "publication_status" key, with "published" = latest, "retracted" = not latest, "registered" = we know about it and it's imminent, and "abandoned" - I think this is perfect, @vnaik60 is that ok with you?

Otherwise this looks like just the ticket.

I was hoping we could add the "source_id view, datasets view, files view" links across the HTML header - much like we have with the links on the https://wcrp-cmip.github.io/CMIP6_CVs/docs/CMIP6_source_id.html page(s). If you have the bandwidth, then I think that is all, and solves all our discussed HTML ponderings

[durack1]

Resolved by #91