ESCOMP / ESCOMP/MOM_interface

Improve handling of module parameters in MOM_input

Open
#301 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Jupyter Notebook
Stars
6
Forks
23
Avg merge
5d 10h
Merged PRs (30d)
5

Description

Currently, in MOM_input.yaml, we place parameters that don't belong to any modules under the `Global` block, and module parameters under respoective module blocks. For instance:

```
Global:
INPUTDIR:
...
TRIPOLAR_N:
...

KPP:
N_SMOOTH:
...
STOKES_MOST
...

MLE:
USE_BODNER23:
...
CR:
...
```

Given the size of this file, it's easy to make mistakes, where a parameter may inadvertently be placed under a module it doesn't belong to.

I have two improvement suggestions.

1. Rather than having module blocks, explicitlyspecify module names in parameter names. So the above entries would look like:

```
INPUTDIR:
...
TRIPOLAR_N:
...

KPP%N_SMOOTH:
...
KPP%STOKES_MOST
...

MLE%USE_BODNER23:
...
MLE%CR:
...
```

2. Turn relevant warnings into failures.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.