Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add regionNames coordinate to NetCDF output with "standard" region names #1066

Merged
merged 5 commits into from
Feb 24, 2025

Conversation

xylar
Copy link
Collaborator

@xylar xylar commented Feb 22, 2025

Two MPAS-Ocean analysis members use ocean regions that are hard-coded and for which no coordinate array or other metadata is provided. This merge adds both regionNames and regionShortNames coordinates to datasets that use these standard regions. Here, we also rename nOceanRegionsTmp to nOceanRegions because the Tmp suffix is confusing and needless.

All analysis using the hard-coded ocean regions has been updated. The config option regions has been renamed to regionShortNames for clarity, and plotTitle has been renamed to regionNames, since these long names are more rightly the names of the regions.

This should help folks that wish to use the NetCDF output from MPAS-Analysis for their own plots.

Checklist

  • User's Guide has been updated
  • API documentation in the Developer's Guide (api.rst) has any new or modified class, method and/or functions listed
  • Documentation has been built locally and changes look as expected
  • Testing comment in the PR documents testing used to verify the changes

Fixes #1065

@xylar xylar added the bug label Feb 22, 2025
@xylar xylar self-assigned this Feb 22, 2025
@xylar
Copy link
Collaborator Author

xylar commented Feb 22, 2025

@golaz, just a heads up that the confusing output you found for the OHC anomaly should be fixed in the new Unified, assuming I can get this reviewed and added very soon.

@xylar xylar force-pushed the add-ocean-region-names-coord branch from fc6cdb9 to 82b6a96 Compare February 22, 2025 09:51
@xylar
Copy link
Collaborator Author

xylar commented Feb 22, 2025

Testing

I rand the test suite and all tests seem to have run successfully:
https://web.lcrc.anl.gov/public/e3sm/diagnostic_output/ac.xasay-davis/analysis_testing/chrysalis/add-ocean-region-names-coord/

However, the web portal is basically unusable today so I can't see if the output looks right.

@xylar
Copy link
Collaborator Author

xylar commented Feb 22, 2025

@milenaveneziani, would you have time to look this over in the coming week? I mostly want to make sure you're conceptually okay with the changes but if you want to look through the code changes and/or the output from the test suite, feel free. Output is in:

/lcrc/group/e3sm/ac.xylar/analysis_testing/chrysalis/add-ocean-region-names-coord

@milenaveneziani
Copy link
Collaborator

Looks great @xylar: thanks for pinging me. I just noticed a couple of typos in the comments (look for 'shrot').

Copy link
Collaborator

@milenaveneziani milenaveneziani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved based on code inspection.

@xylar
Copy link
Collaborator Author

xylar commented Feb 24, 2025

Thanks @milenaveneziani, I'll fix those typos.

@xylar xylar force-pushed the add-ocean-region-names-coord branch from 82b6a96 to caddb2d Compare February 24, 2025 20:52
@xylar xylar merged commit 79bf413 into MPAS-Dev:develop Feb 24, 2025
5 checks passed
@xylar xylar deleted the add-ocean-region-names-coord branch February 24, 2025 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add metadata to anything with nOceanRegions(Tmp)
2 participants