search

PCMDI / input4MIPs_CVs

Controlled Vocabularies (CVs) for use in input4MIPs
https://input4mips-controlled-vocabularies-cvs.readthedocs.io/en/latest/
Creative Commons Attribution 4.0 International
1 stars 1 forks source link

solar data tweak - targeting SOLARIS-HEPPA-CMIP-4-5 #139

Open durack1 opened 10 hours ago

durack1 commented 10 hours ago

Issues to solve:

Files have a valid license identifier but not the "license_id" attribute that is being lifted to populate webpages, e.g.,

$ ncdump -h ../input4MIPs/CMIP6Plus/CMIP/SOLARIS-HEPPA/SOLARIS-HEPPA-CMIP-4-4/atmos/mon/multiple/gn/
v20241018/multiple_input4MIPs_solar_CMIP_SOLARIS-HEPPA-CMIP-4-4_gn_185001-202312.nc | grep license
        :license = "Solar forcing data produced by SOLARIS-HEPPA is licensed under a Creative Commons
Attribution 4.0 International License (http://creativecommons.org/licenses/by/4.0/). The data producers and
data providers make no warranty, either expressed or implied, including but not limited to, warranties of
merchantability and fitness for a particular purpose. All liabilities arising from the supply of the information
(including any liability arising in negligence) are excluded to the fullest extent permitted by law." ;

@znichollscr @st-bender @berndfunke ping - just a note for a very trivial clean up in the next version

st-bender commented 10 hours ago

So, in what way would you prefer that field to be populated?

znichollscr commented 10 hours ago

We just add a global attribute, "license_id", with value "CC BY 4.0", to all files. The current "license" attribute is fine as it is.

st-bender commented 8 hours ago

We just add a global attribute, "license_id", with value "CC BY 4.0", to all files. The current "license" attribute is fine as it is.

We can do that of course. Btw. is there some official documentation for the global metadata? Such as required and optional attributes together with their format requirements and best practices? That would be good to have, instead of going back and forth with GH issue comments, you could point people there.

znichollscr commented 8 hours ago

We're trying, but it's a work in progress and lots of things to do. The tool that best captures it (in my opinion) is https://github.com/climate-resource/input4mips_validation. However, as you can see, there's still lots of things we're not capturing (specifically https://github.com/climate-resource/input4mips_validation/issues/73, https://github.com/climate-resource/input4mips_validation/issues/76).

Some more details are here: https://github.com/PCMDI/input4MIPs_CVs/issues/15. As you can tell, the rules are fuzzy and hard to trace so I would say that the tool linked above is really the most concrete (because it's written in code, not words).

durack1 commented 5 hours ago

And sorry @st-bender this is the list of licenses that we are recommending, pick and choose your flavour (of which we are only recommending 1, but could conceivably deal with a CC0 if someone absolutely wanted it)

https://github.com/PCMDI/input4MIPs_CVs/blob/a1e7be321b2d10676de18f1bed133cf6b2fd49f9/CVs/input4MIPs_license.json#L1-L7

As a backstory all modelling groups in CMIP6, aside from 1, went with the CC BY 4.0 license, with a single group going CC0 (see here)

durack1 commented 5 hours ago

Btw. is there some official documentation for the global metadata? Such as required and optional attributes together with their format requirements and best practices? That would be good to have, instead of going back and forth with GH issue comments, you could point people there.

This is a good suggestion, but not quite in place. The best reference is the CMIP6 guidance document, which can be viewed here - for e.g. license_id is not something that we had in CMIP6.. The rest is very similar, as is the DRS/directory structure and filenames