Add ismip6 forcing testgroup

[hollyhan]

This PR adds a test group to COMPASS that processes the ISMIP6 forcing data provided by the ISMIP6 experimental protocol that target the upcoming IPCC AR6 assessment (https://www.climate-cryosphere.org/wiki/index.php?title=ISMIP6-Projections-Antarctica). Processing includes remapping the original data onto MALI mesh and renaming variables so that the output data can be used to force MALI. In the test group, three test cases have been added: atmosphere, ocean_basal and ocean_thermal.

Original version of this PR is #377, which has been closed in favor of this most updated version, which adds a step to the atmosphere test case that processes the modern climatology (1995-2017) of the RACMO data (https://tc.copernicus.org/articles/12/1479/2018/) and data and applies a climatology correction to the ismip6 SMB anomaly data.

[pep8speaks]

Hello @hollyhan! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file compass/landice/tests/ismip6_forcing/atmosphere/process_smb.py:

Line 328:80: E501 line too long (94 > 79 characters)
Line 329:80: E501 line too long (90 > 79 characters)
Line 335:80: E501 line too long (103 > 79 characters)
Line 339:80: E501 line too long (114 > 79 characters)
Line 341:80: E501 line too long (113 > 79 characters)
Line 345:80: E501 line too long (126 > 79 characters)
Line 347:80: E501 line too long (125 > 79 characters)
Line 351:80: E501 line too long (127 > 79 characters)
Line 355:80: E501 line too long (124 > 79 characters)
Line 359:80: E501 line too long (118 > 79 characters)
Line 363:80: E501 line too long (123 > 79 characters)
Line 365:80: E501 line too long (122 > 79 characters)
Line 369:80: E501 line too long (121 > 79 characters)
Line 373:80: E501 line too long (117 > 79 characters)
Line 375:80: E501 line too long (110 > 79 characters)
Line 379:80: E501 line too long (115 > 79 characters)
Line 385:80: E501 line too long (104 > 79 characters)
Line 386:80: E501 line too long (104 > 79 characters)
Line 390:80: E501 line too long (123 > 79 characters)
Line 391:80: E501 line too long (124 > 79 characters)
Line 393:80: E501 line too long (130 > 79 characters)
Line 397:80: E501 line too long (119 > 79 characters)
Line 398:80: E501 line too long (120 > 79 characters)
Line 400:80: E501 line too long (126 > 79 characters)
Line 404:80: E501 line too long (125 > 79 characters)
Line 406:80: E501 line too long (114 > 79 characters)
Line 410:80: E501 line too long (122 > 79 characters)
Line 411:80: E501 line too long (124 > 79 characters)
Line 413:80: E501 line too long (124 > 79 characters)
Line 414:80: E501 line too long (125 > 79 characters)
Line 416:80: E501 line too long (131 > 79 characters)

• In the file compass/landice/tests/ismip6_forcing/ocean_basal/process_basal_melt.py:

Line 234:80: E501 line too long (128 > 79 characters)
Line 235:80: E501 line too long (112 > 79 characters)
Line 236:80: E501 line too long (129 > 79 characters)
Line 237:80: E501 line too long (113 > 79 characters)
Line 238:80: E501 line too long (127 > 79 characters)
Line 239:80: E501 line too long (104 > 79 characters)
Line 240:80: E501 line too long (132 > 79 characters)
Line 241:80: E501 line too long (116 > 79 characters)
Line 242:80: E501 line too long (133 > 79 characters)
Line 243:80: E501 line too long (117 > 79 characters)
Line 244:80: E501 line too long (131 > 79 characters)
Line 245:80: E501 line too long (108 > 79 characters)

• In the file compass/landice/tests/ismip6_forcing/ocean_thermal/process_thermal_forcing.py:

Line 255:80: E501 line too long (94 > 79 characters)
Line 256:80: E501 line too long (111 > 79 characters)
Line 260:80: E501 line too long (104 > 79 characters)
Line 264:80: E501 line too long (106 > 79 characters)
Line 266:80: E501 line too long (106 > 79 characters)
Line 270:80: E501 line too long (116 > 79 characters)
Line 272:80: E501 line too long (115 > 79 characters)
Line 276:80: E501 line too long (117 > 79 characters)
Line 280:80: E501 line too long (120 > 79 characters)
Line 284:80: E501 line too long (114 > 79 characters)
Line 288:80: E501 line too long (119 > 79 characters)
Line 290:80: E501 line too long (118 > 79 characters)
Line 294:80: E501 line too long (116 > 79 characters)
Line 298:80: E501 line too long (113 > 79 characters)
Line 300:80: E501 line too long (106 > 79 characters)
Line 304:80: E501 line too long (117 > 79 characters)
Line 310:80: E501 line too long (103 > 79 characters)
Line 314:80: E501 line too long (118 > 79 characters)
Line 316:80: E501 line too long (124 > 79 characters)
Line 320:80: E501 line too long (114 > 79 characters)
Line 322:80: E501 line too long (120 > 79 characters)
Line 326:80: E501 line too long (119 > 79 characters)
Line 328:80: E501 line too long (112 > 79 characters)
Line 332:80: E501 line too long (111 > 79 characters)
Line 334:80: E501 line too long (118 > 79 characters)
Line 336:80: E501 line too long (124 > 79 characters)

Comment last updated at 2022-09-12 20:42:00 UTC

[trhille]

@hollyhan, this is amazing work! I went through processing ocean thermal forcing, basal melt, and surface mass balance all using this branch, and noted a handful of sticking points in my review. I have not yet gone through all the files, just any that gave me issues while testing it out. This was incredibly useful, and I'm now running the newest Thwaites mesh and optimization with UKESM forcing!

Also, I know you didn't ask for a review from me, but I needed to use this so I figured I might as well review it while I figured it out. :)

Thanks for this amazing new tool!

[xylar]

I'm reviewing some changes here even though I think we should close this PR in favor of #377 because many of these changes aren't in #377 yet. I want to make sure they don't get lost.

[hollyhan]

@xylar

Thanks so much for testing the PR and for making really great suggestions for improving the testgroup!
I've incorporated all of your suggestions - adding a separate step for processing ocean thermal obs, adding metadata to the processed SMB field and downloading the RACMO data from the MALI database.

Thanks :)
Holly

[xylar]

@hollyhan, I tested today with HadGEM2-ES data and found a few things that still need to be fixed.

Please have a look and I'll test again once these changes are in.

[hollyhan]

Thanks for testing the PR so promptly, @xylar! I have turned in the changes. :)

[xylar]

Wonderful, @hollyhan! This has been a long process with a lot of back and forth. Thank you for bearing with it. I just reran my HadGEM2-ES tests and they all ran perfectly (in under 3 minutes total!).

I think this is ready for @matthewhoffman and @trhille to take a look at.

[matthewhoffman]

@hollyhan , this looks fantastic! I did a cursory review again and I don't see any additional things you haven't already addressed. This has been a lot of work, but it has been very useful to be able to generate these forcings for any any mesh quickly, and adjust to updates and changes in a reproducible way.

[trhille]

Great work, @hollyhan. I added a few minor comments, but I'm happy for this to be merged. I tested it end-to-end for all four tests and did a short forward run on the full AIS-4km mesh using the climatology forcings it produced.

[trhille]

Is it possible to make the 'Ocean_Forcing' part of this case-insensitive? It's a little awkward to have to have both an 'Ocean_Forcing' and an 'Ocean_forcing' directory when processing the obs and 2300 files, and it's not immediately apparent to the user why the ocean_thermal_obs case doesn't work when the ocean_thermal case does.

[hollyhan]

@trhille, this is a good point, and it would be ideal to have a case-insensitive directory for the ocean forcing files. The observational climatology file was originally only downloadable from the ISMIP6-2100 GHub endpoint, which is why I put the obs file in the same directory name Ocean_Forcing as that for the 2100 files. But the ISMIP6 committee has recently uploaded the obs data to the 2300 Ghub endpoint as well. I can see how to make the directory for the obs file case insensitive depending on which period_endyear is chosen in the config file in the following PRs I will create after merging this one.

[hollyhan]

Great work, @hollyhan. I added a few minor comments, but I'm happy for this to be merged. I tested it end-to-end for all four tests and did a short forward run on the full AIS-4km mesh using the climatology forcings it produced.

Thanks so much for catching the silly typos with careful inspection, @trhille! I fixed all of them and updated the PR!

[hollyhan]

Hi @xylar, @trhille, @matthewhoffman,

Thank you all so much for helping me through this PR, which involved multiple rounds of thorough reviews and giving constructive feedbacks! I've updated the PR with the last comments provided by Trevor above.

[xylar]

I created #462 to keep track of @trhille and @hollyhan's last unaddressed point.

[xylar]

Congratulation, @hollyhan!

[trhille]

Yes, awesome work @hollyhan! This is such a great tool!