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 support for scheme w/o run phase #548

Merged
merged 6 commits into from
Mar 18, 2024
Merged

Conversation

dustinswales
Copy link
Collaborator

Here we include a small fix to allow for schemes without run phases.

Capgen assumes that all schemes have a run phase, which is not true in practice. During the "scheme analyze" section, if a scheme doesn't contain a run phase we set a flag to true (no_run_phase). Then this flag is queried later in the "scheme write" section.

There are no interface changes.

Addresses #543

Testing has been expanded to contain a scheme w/o a run phase.

Copy link
Collaborator

@gold2718 gold2718 left a comment

Choose a reason for hiding this comment

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

Hmm, that is a lot less invasive than I expected, good work!

scripts/suite_objects.py Outdated Show resolved Hide resolved
@@ -1143,6 +1144,9 @@ def analyze(self, phase, group, scheme_library, suite_vars, level):
if phase in func:
my_header = func[phase]
Copy link
Collaborator

Choose a reason for hiding this comment

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

This just says phase, is phase always run?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is to catch instances when "func" doesn't contain a run.
But yeah, phase can be init, run, or final, but we don't care if init and final are not present.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I still don't understand the logic. Somewhere, the code calls analyze for a certain phase (which can be anything you said: init, final, ...). Then in line 1144, you check if that phase is in the func dictionary. If it is not, you set has_run_phase to False. That makes sense if phase is run, but not if the argument phase is init?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The way I understand it is, this may be wrong:

Capgen creates group caps for each CCPP phase except for the run phase, and caps for each group's run phase. For example, in the SCM GFS_v16 SDF, we have the following caps created (4 ccpp phase caps, and 3 group caps):
public :: SCM_GFS_v16_initialize
public :: SCM_GFS_v16_timestep_initial
public :: SCM_GFS_v16_time_vary
public :: SCM_GFS_v16_radiation
public :: SCM_GFS_v16_physics

public :: SCM_GFS_v16_timestep_final
public :: SCM_GFS_v16_finalize

So when analyzing/writing the group caps you can only have phase=run.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh, that is fundamentally different from prebuild. In prebuild, there is a cap for each phase and each group. I think right now that limitation in capgen isn't a problem, but I would prefer that check in the code just in case the capgen implementation changes in the future and analyze at the group level can get called for other phases, too.

For example:

            if phase in func:
                my_header = func[phase]
            #else:
            elif phase == 'run':
                self._has_run_phase = False
                return set()

Copy link
Collaborator

Choose a reason for hiding this comment

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

There's another option though. We could try to treat the FV3 dycore with the fast physics as its own "host model" for CCPP framework purposes. I thought about this in the past, when I heard discussions about moving more physics into the FV3 dycore ("inline physics"). I think that should be possible with relatively little engineering on the build system side.

Copy link
Collaborator

Choose a reason for hiding this comment

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

We have discussed one way to handle this but I can't find the reference right now. The idea would be that we have two ways to combine sub-suites. Do you recall where that took place or should I add what I recall to #275 ?

Copy link
Collaborator

Choose a reason for hiding this comment

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

If you could, yes please. I don't remember. Thanks very much!

Copy link
Collaborator

Choose a reason for hiding this comment

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

I have added what I recall to the description section of #275 .

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks! Yes, I think this would give us the desired capability.

@climbfuji
Copy link
Collaborator

@dustinswales Let's wait until my pr to merge feature/capgen into main is merged. We should then target main instead of feature/capgen.

@dustinswales dustinswales changed the base branch from feature/capgen to main March 18, 2024 14:34
@mkavulich mkavulich merged commit 8dafc94 into NCAR:main Mar 18, 2024
6 checks passed
@climbfuji
Copy link
Collaborator

This was not tested with the UFS. We unfortunately can't merge code into the main branch without going through the proper regression testing procedure.

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

Successfully merging this pull request may close these issues.

4 participants