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

modify cpld_gridgen as required by new ocnice_prep utility #945

Closed

Conversation

DeniseWorthen
Copy link
Contributor

@DeniseWorthen DeniseWorthen commented May 13, 2024

DESCRIPTION OF CHANGES:

Adds two required weights to map fields from center grid points (Ct) back to their native stagger locations for MOM6. Also deprecates two weights currently being generated for previous NCL based creation of ICs for CICE and removes the associated regression test dependency.

TESTS CONDUCTED:

If there are changes to the build or source code, the tests below must be conducted. Contact a repository manager if you need assistance.

  • Compile branch on all Tier 1 machines using Intel (Orion, Jet, Hera, Hercules and WCOSS2).
  • Compile branch on Hera using GNU.
  • Compile branch in 'Debug' mode on WCOSS2.
  • Run unit tests locally on any Tier 1 machine.
  • Run relevant consistency tests locally on all Tier 1 machines.

Optional test.

  • Run full set of chgres_cube consistency tests on Hera.

Describe any additional tests performed.

Baselines are expected to fail because of the following missing files. All failures are expected.

  • the Ct.mx025_SCRIP files are missing because the dependency has been removed.
  • the Ct->Bu file for mx025 is removed because that mapping is never required.
  • the tripole:tripole files are removed because NCL method using those weights is deprecated.
28:Comparing tripole.mx025.Ct.to.Bu.bilinear.nc........MISSING file
53:Comparing Ct.mx025_SCRIP.nc........MISSING file
65:Comparing tripole.mx025.Ct.to.mx050.Ct.bilinear.nc........MISSING file
66:Comparing tripole.mx025.Ct.to.mx050.Ct.neareststod.nc........MISSING file
91:Comparing Ct.mx025_SCRIP.nc........MISSING file
102:Comparing tripole.mx025.Ct.to.mx100.Ct.bilinear.nc........MISSING file
103:Comparing tripole.mx025.Ct.to.mx100.Ct.neareststod.nc........MISSING file
127:Comparing Ct.mx025_SCRIP.nc........MISSING file
137:Comparing tripole.mx025.Ct.to.mx500.Ct.bilinear.nc........MISSING file
138:Comparing tripole.mx025.Ct.to.mx500.Ct.neareststod.nc........MISSING file

DOCUMENTATION:

The documentation requires minor changes to remove references to the deprecated NCL method.

ISSUE:

DeniseWorthen and others added 6 commits May 6, 2024 08:05
baselines fail with the following missing files. All are expected
The Ct.mx025_SCRIP files are missing because the dependency has
been removed. The Ct->Bu file for mx025 is removed because that
mapping is never required. The tripole:tripole files are removed
because NCL method is deprecated.

28:Comparing tripole.mx025.Ct.to.Bu.bilinear.nc........MISSING file
53:Comparing Ct.mx025_SCRIP.nc........MISSING file
65:Comparing tripole.mx025.Ct.to.mx050.Ct.bilinear.nc........MISSING file
66:Comparing tripole.mx025.Ct.to.mx050.Ct.neareststod.nc........MISSING file
91:Comparing Ct.mx025_SCRIP.nc........MISSING file
102:Comparing tripole.mx025.Ct.to.mx100.Ct.bilinear.nc........MISSING file
103:Comparing tripole.mx025.Ct.to.mx100.Ct.neareststod.nc........MISSING file
127:Comparing Ct.mx025_SCRIP.nc........MISSING file
137:Comparing tripole.mx025.Ct.to.mx500.Ct.bilinear.nc........MISSING file
138:Comparing tripole.mx025.Ct.to.mx500.Ct.neareststod.nc........MISSING file
@DeniseWorthen
Copy link
Contributor Author

@GeorgeGayno-NOAA I've spent way too much time today trying to figure out how to add a figure to the documentation for cpld_gridgen. I have the figure as a png file in docs/_static and I'm trying to reference in docs/cpld_gridgen.md using

.. _figure_reference:

.. figure:: _static/murray.png

The documentation builds, but I don't see the figure when I look at the documentation in my gh-pages branch.

@GeorgeGayno-NOAA
Copy link
Collaborator

@GeorgeGayno-NOAA I've spent way too much time today trying to figure out how to add a figure to the documentation for cpld_gridgen. I have the figure as a png file in docs/_static and I'm trying to reference in docs/cpld_gridgen.md using

.. _figure_reference:

.. figure:: _static/murray.png

The documentation builds, but I don't see the figure when I look at the documentation in my gh-pages branch.

I will take a look.

@GeorgeGayno-NOAA
Copy link
Collaborator

GeorgeGayno-NOAA commented May 14, 2024

@GeorgeGayno-NOAA I've spent way too much time today trying to figure out how to add a figure to the documentation for cpld_gridgen. I have the figure as a png file in docs/_static and I'm trying to reference in docs/cpld_gridgen.md using

.. _figure_reference:

.. figure:: _static/murray.png

The documentation builds, but I don't see the figure when I look at the documentation in my gh-pages branch.

That looks like 'readthedocs' syntax. I don't know if this is what we want:
https://github.github.com/gfm/#images
https://www.seancdavis.com/posts/three-ways-to-add-image-to-github-readme/

@GeorgeGayno-NOAA
Copy link
Collaborator

@GeorgeGayno-NOAA I've spent way too much time today trying to figure out how to add a figure to the documentation for cpld_gridgen. I have the figure as a png file in docs/_static and I'm trying to reference in docs/cpld_gridgen.md using

.. _figure_reference:

.. figure:: _static/murray.png

The documentation builds, but I don't see the figure when I look at the documentation in my gh-pages branch.

After a lot of trial and error, I think it is working. I modified two files:

--- a/sorc/cpld_gridgen.fd/docs/Doxyfile.in
+++ b/sorc/cpld_gridgen.fd/docs/Doxyfile.in
@@ -960,7 +960,8 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).

-IMAGE_PATH             =
+IMAGE_PATH             =@abs_top_srcdir@/sorc/cpld_gridgen.fd/docs/_static
--- a/sorc/cpld_gridgen.fd/docs/cpld_gridgen.md
+++ b/sorc/cpld_gridgen.fd/docs/cpld_gridgen.md
@@ -191,9 +191,7 @@ domain of the ocean and ice for the global models is always the
 tripole grid, which is characterized by three "poles", one in the
 southern hemisphere and two in the north, both over land.

-.. _figure_reference:
-
-.. figure:: _static/murray.png
+\image html murray.png

@DeniseWorthen
Copy link
Contributor Author

@GeorgeGayno-NOAA Thanks a lot for figuring it out. Let me add those changes and see if I can reproduce your method.

@DeniseWorthen
Copy link
Contributor Author

DeniseWorthen commented Jun 3, 2024

This PR has been merged into #942. Closing.

Note: The current cpld_gridgen baselines will contain additional files which will no longer be produced after #942 is merged. This should be kept in mind for the next PR which would update the cpld_gridgen baseline.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants