FMS1 Framework integration by marshallward · Pull Request #1342 · mom-ocean/MOM6

marshallward · 2021-02-26T22:26:24Z

This pull request introduces the new config_src layout, which includes dedicated directories for the framework infrastructure, couplers, drivers, and memory preprocessing.

Reviewers requested:

✔️ EMC (@jiandewang)
✔️ ESMG (@kshedstrom)
✔️ FSU / HYCOM3 (@abozec / @awallcraft)
✔️ NASA / GMAO (@sanAkel)
✔️ NCAR (@alperaltuntas / @gustavo-marques)

Existing build scripts with explicit paths to config_src are unlikely to work after this merge. This includes calls to mkmf or any compiler flags containing directories. Please carefully confirm that you are still able to build and run your models with this PR.

The FMS1 implementation is now moved into config_src/infra/FMS1, and src should no longer contain any explicit calls to FMS.

Couplers and drivers have been renamed and moved into the drivers directory. Many are now denoted with the _cap suffix, e.g.

coupled_driver -> FMS_cap
mct_driver -> mct_cap
nuopc_driver -> nuopc_cap

MOM_memory.h headers are now moved into the config_src/memory directory.

The documentation, build system, and verification tests paths have also been updated to reflect this change.

Also, the target build in the testing will now use its own configure.ac rather than the current repository. In particular, the current regression tests can now use the legacy layout, and future directory tree changes will not break the regression tests.

Commits:

Hallberg noaa gfdl fms2 #1341: Hallberg noaa gfdl fms2 (@adcroft)
+New config_src directory structure #1339: +New config_src directory structure (@Hallberg-NOAA)

Contributors:

@adcroft: 1
@Hallberg-NOAA: 1

Merge main to dev/gfdl

Created the new config_src directory tree structure, as agreed upon at https://github.com/NOAA-GFDL/MOM6/discussions/1286, to eventually accomodate the selection of different infrastructures. No .F90 files are changed but there are small changes to ac/configure.ac to accomodate the new structure while also allowing for the old target to use the old structure. All answers are bitwise identical, and all MOM6-examples and TC tests are passing.

Updated the MOM6/docs files and .gitlab-ci.yml to reflect the new config_src directory structure.

- Use a new branch of MRS in the gitlab pipelines

- The job within the gitlab pipeline gnu:ice-ocean-nolibs had a modified search path but a "," instead of a "/" led to al caps being compiled and thus failure.

This patch removes the AC_CHECK_FILE autoconf macro which assigns a default path to the MOM_memory.h file path. This path was defaulting back to the old directory, and was added to support the regression verification testing, but this is a regression problem with should be handled by the regression, not the autoconf configuration. This will produce a regression test fail, but it not a cause for concern.

Remove AC_CHECK_FILE for legacy MOM_memory.h

This patch removes two lines where the target build (used for regression testing) were using the active branch's configure.ac, which caused path mismatches. We now use our local autoconf configuration files. This patch also fixes a typo in the source code dependencies of the target repository. The AC_CHECK_FILE for the solo driver has also beed removed, for the same reason as the MOM_memory.h check. Some comments were also added or reformatted to undocumented flags.

Testing: Target uses local autoconf

Hallberg noaa gfdl fms2

codecov · 2021-02-26T22:31:33Z

Codecov Report

Merging #1342 (0ead900) into main (00c2819) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1342   +/-   ##
=======================================
  Coverage   45.75%   45.75%           
=======================================
  Files         234      234           
  Lines       72542    72542           
=======================================
  Hits        33189    33189           
  Misses      39353    39353

Impacted Files	Coverage Δ
...g_src/drivers/solo_driver/MESO_surface_forcing.F90	`0.00% <ø> (ø)`
config_src/drivers/solo_driver/MOM_driver.F90	`68.69% <ø> (ø)`
...ig_src/drivers/solo_driver/MOM_surface_forcing.F90	`26.54% <ø> (ø)`
...fig_src/drivers/solo_driver/atmos_ocean_fluxes.F90	`0.00% <ø> (ø)`
...g_src/drivers/solo_driver/user_surface_forcing.F90	`0.00% <ø> (ø)`
config_src/infra/FMS1/MOM_coms_infra.F90	`59.42% <ø> (ø)`
config_src/infra/FMS1/MOM_couplertype_infra.F90	`6.81% <ø> (ø)`
config_src/infra/FMS1/MOM_cpu_clock_infra.F90	`90.90% <ø> (ø)`
config_src/infra/FMS1/MOM_data_override_infra.F90	`0.00% <ø> (ø)`
config_src/infra/FMS1/MOM_diag_manager_infra.F90	`48.64% <ø> (ø)`
... and 6 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 00c2819...e0bda29. Read the comment docs.

kshedstrom · 2021-03-02T23:05:05Z

I approve this PR. If this is for the whole consortium to evaluate, you should probably add other mentions.

marshallward · 2021-03-03T00:16:05Z

Thanks for the reminder, @kshedstrom.

Could the others please review?

jiandewang · 2021-03-03T01:56:40Z

@marshallward There are some directories naming changings, but there are no files adding/deleting or renaming, is that right ?

marshallward · 2021-03-03T02:03:32Z

@jiandewang Yes, that's correct. The new files were added in the previous PR to main.

alperaltuntas · 2021-03-04T02:46:51Z

I approve this PR.

abozec

COAPS approves this PR.

jiandewang · 2021-03-04T17:13:14Z

@marshallward in EMC we are in final stage to merge your previous PR, so please bear me a bit delay on this PR.

marshallward · 2021-03-04T17:18:35Z

@jiandewang No hurry, please take as long as you need.

jiandewang · 2021-03-04T17:25:57Z

@jiandewang No hurry, please take as long as you need.

@thanks for your understanding

…NOAA-GFDL/MOM6/pull/1342

sanAkel

This PR can be merged. (No change in answers w.r.t. present version of GEOS coupled model with MOM6.)

If not already in place, I would also suggest/request an edit to the compile instructions at MOM6-examples: ocean-only, ice-ocean reflecting the reorganized directory structure.

adcroft · 2021-03-07T19:51:25Z

@sanAkel Thanks. Updated instructions have been written but not posted. Preview is at https://github.com/NOAA-GFDL/MOM6-examples/wiki/Temp---new-Getting-Started

jiandewang · 2021-03-08T04:36:23Z

@marshallward: works fine in UFS.

marshallward · 2021-03-08T14:41:12Z

OK, I will go ahead and merge this PR now.

Modes which need to use the legacy FMS library should be able to continue doing so, and ought not need any other major changes to their build process.

For those who need to upgrade to FMS2, we will start consolidating existing work into the FMS2 adapters and will update main as soon as possible.

marshallward and others added 10 commits February 24, 2021 15:43

Merge pull request #1337 from NOAA-GFDL/main

d8733fe

Merge main to dev/gfdl

+MOM6/docs reflects the new directory structure

0d22f32

Updated the MOM6/docs files and .gitlab-ci.yml to reflect the new config_src directory structure.

Update build scripts for new dir structure

c0ddee0

- Use a new branch of MRS in the gitlab pipelines

Correct path to FMS_cap in gnu:ice-ocean-nolibs job

95ed51f

- The job within the gitlab pipeline gnu:ice-ocean-nolibs had a modified search path but a "," instead of a "/" led to al caps being compiled and thus failure.

Merge pull request #9 from marshallward/hallberg-fms2-acfix

8f0748c

Remove AC_CHECK_FILE for legacy MOM_memory.h

Merge pull request #10 from marshallward/hallberg-fms2-acfix

d2ec275

Testing: Target uses local autoconf

Merge pull request #1341 from adcroft/Hallberg-NOAA-gfdl-fms2

e0bda29

Hallberg noaa gfdl fms2

abozec approved these changes Mar 4, 2021

View reviewed changes

sanAkel referenced this pull request in GEOS-ESM/FMS Mar 6, 2021

for testing and eventual adoptation of changes in https://github.com/…

80a51f9

…NOAA-GFDL/MOM6/pull/1342

sanAkel referenced this pull request in GEOS-ESM/GEOSgcm_GridComp Mar 6, 2021

for testing and eventual adoptation of changes in https://github.com/…

d0ce5dc

…NOAA-GFDL/MOM6/pull/1342

sanAkel approved these changes Mar 6, 2021

View reviewed changes

marshallward merged commit 4e05839 into main Mar 8, 2021

This was referenced Mar 8, 2021

Sync with main to bring in new infrastructure file structure NCAR/MOM6#180

Closed

Sync with main to bring in new file layout NCAR/MOM6#181

Merged

jiandewang mentioned this pull request Mar 10, 2021

update MOM6 to GFDL 20210308 main branch commit ufs-community/ufs-weather-model#458

Merged

9 tasks

jiandewang mentioned this pull request Mar 10, 2021

Feature/update to gfdl 20210308 NOAA-EMC/MOM6#61

Merged

adcroft deleted the gfdl-fms2 branch June 23, 2021 16:14

Conversation

marshallward commented Feb 26, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Feb 26, 2021

Codecov Report

Uh oh!

kshedstrom commented Mar 2, 2021

Uh oh!

marshallward commented Mar 3, 2021

Uh oh!

jiandewang commented Mar 3, 2021

Uh oh!

marshallward commented Mar 3, 2021

Uh oh!

alperaltuntas commented Mar 4, 2021

Uh oh!

abozec left a comment

Choose a reason for hiding this comment

Uh oh!

jiandewang commented Mar 4, 2021

Uh oh!

marshallward commented Mar 4, 2021

Uh oh!

jiandewang commented Mar 4, 2021

Uh oh!

sanAkel left a comment

Choose a reason for hiding this comment

Uh oh!

adcroft commented Mar 7, 2021

Uh oh!

jiandewang commented Mar 8, 2021

Uh oh!

marshallward commented Mar 8, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

marshallward commented Feb 26, 2021 •

edited

Loading