WCRP-CMIP / CMIP6_CVs

Controlled Vocabularies (CVs) for use in CMIP6
Creative Commons Attribution 4.0 International
155 stars 79 forks source link

source_id registration of E3SM-2-0 #1127

Closed mccoy20 closed 1 year ago

mccoy20 commented 2 years ago

label = E3SM 2.0 label_extended = E3SM 2.0 (Energy Exascale Earth System Model) source_id = E3SM-2-0 institution_id = E3SM-Project release_year = 2022 activity_participation = [CMIP RFMIP DAMIP]

aerosol: description = MAM4 with new features in resuspension, marine organics, secondary organics, and dust (same grid as atmos physics) nominal_resolution = 168 km

atmos: description =EAM (v2.0, cubed sphere spectral-element grid; 5400 elements, 30x30 per cube face. Dynamics: degree 3 (p=3) polynomials within each spectral element, 112 km average resolution. Physics: 2x2 finite volume cells within each spectral element, 1.5 degree (168 km) average grid spacing). nominal_resolution = 112 km

atmosChem: description = Troposphere specified oxidants (except passive ozone with the lower boundary sink) for aerosols. Stratosphere linearized interactive ozone (LINOZ v2) (same grid as atmos physics) nominal_resolution = 168 km

land: description = ELM (v1.0, same grid as atmos physics, satellite phenology mode), MOSART (v1.0, 0.5 degree latitude/longitude grid) nominal_resolution = 168 km

landIce: description = none nominal_resolution = none

ocean: description = MPAS-Ocean (E3SMv2.0, EC30to60E2r2 unstructured SVTs mesh with 236853 cells and 719506 edges, variable resolution 60 km to 30 km; 60 levels; top grid cell 0-10 m) nominal_resolution = 30-60 km

ocnBgchem: description = none nominal_resolution = none

seaIce: description = MPAS-Seaice (E3SMv2.0, EC30to60E2r2 unstructured SVTs mesh with 236853 cells and 719506 edges, variable resolution 60 km to 30 km; 5 ice categories, 7 ice layers, 5 snow layers) nominal_resolution = 30-60 km

durack1 commented 2 years ago

Thanks @mccoy20 we had not planned to register any additional CMIP6 contributors, however as you are planning on publishing simulations imminently it is suitable to include E3SM-2-0 as a CMIP6 experiment contributor. Note, the nominal resolution entries are defined in CMIP6_nominal_resolution.json, and so I believe 50 km and 100 km would be the most appropriate matches.

I presume a CC BY 4.0 license is suitable for this model, along with the same contact info as E3SM-1-0?

mccoy20 commented 2 years ago

@durack1 - Yes, same license and contact info that the recently updated once. If I understand you correctly we need to change nominarl_resolution. Below is the full text again with those changes, also added CFMIP and ScenarioMIP that we will want to publish the data to as well.

activity_participation = [CMIP RFMIP DAMIP CFMIP ScenarioMIP]

aerosol: description = MAM4 with new features in resuspension, marine organics, secondary organics, and dust (same grid as atmos physics) nominal_resolution = 100 km

atmos: description =EAM (v2.0, cubed sphere spectral-element grid; 5400 elements, 30x30 per cube face. Dynamics: degree 3 (p=3) polynomials within each spectral element, 112 km average resolution. Physics: 2x2 finite volume cells within each spectral element, 1.5 degree (168 km) average grid spacing). nominal_resolution = 100 km

atmosChem: description = Troposphere specified oxidants (except passive ozone with the lower boundary sink) for aerosols. Stratosphere linearized interactive ozone (LINOZ v2) (same grid as atmos physics) nominal_resolution = 100 km

land: description = ELM (v1.0, same grid as atmos physics, satellite phenology mode), MOSART (v1.0, 0.5 degree latitude/longitude grid) nominal_resolution = 100 km

landIce: description = none nominal_resolution = none

ocean: description = MPAS-Ocean (E3SMv2.0, EC30to60E2r2 unstructured SVTs mesh with 236853 cells and 719506 edges, variable resolution 60 km to 30 km; 60 levels; top grid cell 0-10 m) nominal_resolution = 50 km

ocnBgchem: description = none nominal_resolution = none

seaIce: description = MPAS-Seaice (E3SMv2.0, EC30to60E2r2 unstructured SVTs mesh with 236853 cells and 719506 edges, variable resolution 60 km to 30 km; 5 ice categories, 7 ice layers, 5 snow layers) nominal_resolution = 50 km

mccoy20 commented 2 years ago

@durack1 sorry for the formatting, I am not sure why it shows up this way. I do not see the way to change it

durack1 commented 2 years ago

@mccoy20 that registration is now in place, please take a peek at CMIP6_source_id.html and CMIP6_source_id_licenses.html to double check.

Note this issue will remain open until you have published your first E3SM-2-0 data, after which we can update the license blurb (to add the history attribute), update the cohort to "Published" and close this out

mccoy20 commented 2 years ago

@durack1 all looks good in CMIP6_source_id.html, but I do not see the license or contact info on the license page. I assume this is what you intended, and we will add these after first data is publishes, which is fine.

durack1 commented 2 years ago

@mccoy20 exactly, once we have data published, we will have the first E3SM-2-0 data version, which will allow the license, exceptions contact and history to be written (and the cohort updated to "Published")

durack1 commented 2 years ago

@mccoy20 just circling around, the registered content that you provided has exceeded the 1024 char limit that CMOR currently imposes (we have plans to update this software limitation, but have to work around it currently).

Can we make edits to the registered information such that the current 1128 chars are reduced to 1024?

The string can be found in https://github.com/PCMDI/cmip6-cmor-tables/commit/3f9e63acd05cf4eec6a81b4e79e9f7d8084020e7 - under the "source" heading (line 1126). This requires the description fields noted in the https://github.com/WCRP-CMIP/CMIP6_CVs/issues/1127#issuecomment-1184973859 above, to be reduced by the 105 chars over limit

Apologies, we haven't hit this limit before, and consequently hadn't implemented a test to catch it before the registration was processed - I will amend that in #1129

@mauzey1 ping

mccoy20 commented 2 years ago

@durack1 Below is the shortened version of components section, which is what I believe was causing the problem:


aerosol: description = MAM4 w/ new resuspension, marine organics, secondary organics, and dust (atmos physics grid) nominal_resolution = 100 km

atmos: description =EAM (v2.0, cubed sphere spectral-element grid; 5400 elem., 30x30 per cube face. Dynamics: degree 3 (p=3) polynomials within each spectral element, 112 km average resolution. Physics: 2x2 finite volume cells within each spectral element, 1.5 degree (168 km) average grid spacing; 72 vertical layers w/ top at 60 km). nominal_resolution = 112 km

atmosChem: description = Troposphere specified oxidants (except passive ozone with the lower boundary sink) for aerosols. Stratosphere linearized interactive ozone (LINOZ v2) (atmos physics grid) nominal_resolution = 100 km

land: description = ELM (v1.0, atmos physics grid, satellite phenology mode), MOSART (v1.0, 0.5 deg lat/lon grid) nominal_resolution = 100 km

landIce: description = none nominal_resolution = none

ocean: description = MPAS-Ocean (E3SMv2.0, EC30to60E2r2 unstructured SVTs mesh with 236853 cells and 719506 edges, variable resolution 60 km to 30 km; 60 levels; top grid cell 0-10 m) nominal_resolution = none

ocnBgchem: description = none nominal_resolution = none

seaIce: description = MPAS-Seaice (E3SMv2.0, MPAS-Ocean grid; 5 ice categories, 7 ice layers, 5 snow layers) nominal_resolution = none


Please note that we have also change the nominal_resolution in ocean and seaIce components to none. This is because this is a variable resolution mesh and we feel that prescribing a nominal resolution does not make sense in this case.

Let me know if this does not solve the character limit issue. Thanks!

durack1 commented 2 years ago

@mccoy20 that change is now in place. I managed to tweak the original submission in an attempt to keep as much info as possible, which led to a reduction to 1011 chars (under the 1024 limit). Please take a peek at CMIP6_source_id.html and let me know if any further tweaks are required. Note I kept the original nominal_resolution entries, as these are used in the ESGF CMIP6 project search facets for active model components, and they are "nominal" anyway, happy to tweak these if required.

Again, let me know when the first E3SM-2-0 data is published and I will update the license info to reflect the first data availability, you might also want to catch the CC BY-SA 4.0 -> CC BY 4.0 tweak within the file metadata if these data have not yet been written

mccoy20 commented 2 years ago

@durack1 This looks good assuming people would understand that "atmos grid" means "atmos physics grid" and not "atmos dynamics grid". Please add activities: DAMIP and CFMIP, I am not sure why they were dropped.

durack1 commented 2 years ago

@mccoy20 apologies I'll fix those missing activity_participation entries, and further tweak the description strings (and test) to ensure that release year is included (see https://github.com/PCMDI/cmip6-cmor-tables/issues/377)

durack1 commented 2 years ago

Ok that should now be done. @mccoy20 the activity_participation should be fixed, and @mauzey1 I believe the generated string (and test) now replicates the cmip6-cmor-table generator, with 1024 char string the result - can you please confirm?

@mccoy20 the updated info can be reviewed at CMIP6_source_id.html

mauzey1 commented 2 years ago

@durack1 I have just discovered that the strings should be 1023 characters long rather than the maximum C char array length of 1024. I think this is due to them needing to accommodate the null character for C array strings (null-terminated strings). Apologies for not finding this out sooner.

durack1 commented 2 years ago

@durack1 This looks good assuming people would understand that "atmos grid" means "atmos physics grid" and not "atmos dynamics grid". Please add activities: DAMIP and CFMIP, I am not sure why they were dropped.

@mccoy20 we only have granularity to the realm, so there is no atmosphere (or any other realm) "physics" vs "dynamics" subsections defined. In the case (such as E3SM-2-0) where these differ, the only option to document these in our template is through the descriptive identifiers, as you've done

mccoy20 commented 2 years ago

@mauzey1 @durack1 Is the string still too long? Can we abbreviate "elements" to "elems." in "atmos" description in string "5400 elements", it could become "5400 elem." or "5400 elems." (not sure which is more correct).

mccoy20 commented 2 years ago

We can also shorten "spectral elements" to "spectral elem." to cut more characters.

durack1 commented 2 years ago

And take 4, I removed the duplicate ", variable resolution 60 to 30 km" from the seaIce realm descriptor, as this already notes "ocean grid" which includes the same detail. The resulting string is now 991 chars long. @mauzey1 I hope this solves the remaining issue.

@mccoy20 the updated info can be reviewed at CMIP6_source_id.html

durack1 commented 2 years ago

@mccoy20 @chengzhuzhang just circling around, are we expecting E3SM-2-0 data to be published imminently? It seems it's not live, yet

chengzhuzhang commented 2 years ago

Hi Paul, thank you for checking. we are producing cmorized E3SM-2-0 data and once we have the doi of the paper that describes the data, we will add the reference to metadata and publish. I think that will happen fairly soon.

durack1 commented 2 years ago

@chengzhuzhang great, please ping this thread when data is live, and I'll close it out

durack1 commented 1 year ago

Hi @chengzhuzhang just circling around on this, any progress to report, it doesn't appear that E3SM-2-0 data is live, yet.

chengzhuzhang commented 1 year ago

There hasn't been a status change. But i will update here once we get authorization to launch the publication.

chengzhuzhang commented 1 year ago

Hi @durack1 We finally began publishing E3SM-2-0! It looks like there will be one version of E3SM-2-1 comming later this year, should we just go ahead and do a new registration?

durack1 commented 1 year ago

@chengzhuzhang thanks for the update - looks like we're live https://esgf-node.llnl.gov/search/cmip6/?source_id=E3SM-2-0 - earliest version v20220823

Regarding E3SM-2-1, there is no rush to register this, unless of course you want to write data imminently, so let's circle around when that process is close to beginning - and yes, another issue defining E3SM-2-1 would be required at that time

chengzhuzhang commented 1 year ago

Yeah, it is very exciting!

Alright, I will file a new issue when we get closer with 2-1. Thank you!