mkexp.py does not generate a complete ocnconf.yaml

Open
#145 0 comments 0 reactions 2 assignees View on GitHub

@sshakoor1 is already working on this.

Since Jul 2, 2025.

Assessment

This issue has not been assessed yet.

Description

When trying to generate coupled diagnostics with mkplots.py, we first need to generate a ocnconf.yaml from mkexp.py. However the yaml file created from mkexp.py is incredibly barebones, and you will need to manually add your griddir and plotset entries (e.i. sst, sss, ssh)

Running a command like python mkexp.py myexperiment --datadir path/to/myexperiment will generate a yaml file that looks like this:

# Auto generated by mkexp.py
expid:     myexperiment

# You can list experimants to compare following the pattern below
#cmpexp:
#    - path_to_config_file1
#    - path_to_config_file2

data_path: path/to/myexperiment
plot_path: /home/sshakoor/geos5/plots_ocn

# You can specify dates interval to be used for analysis
# following the pattern below
#dates: ['yyyy-mm-dd','yyyy-mm-dd']

When really it seems like it would make more sense to auto-generate plotsets and the griddir unless otherwise specified. For example something like this from that same command would be ideal:

# Auto generated by mkexp.py
expid:     myexperiment

# You can list experimants to compare following the pattern below
#cmpexp:
#    - path_to_config_file1
#    - path_to_config_file2

data_path: path/to/myexperiment
plot_path: /home/sshakoor/geos5/plots_ocn
griddir: /discover/nobackup/projects/gmao/ssd/aogcm/ocean_bcs/MOM5/1440x1080

# You can specify dates interval to be used for analysis
# following the pattern below
#dates: ['yyyy-mm-dd','yyyy-mm-dd']
plots:
  plotsets: [sst, sss, ssh]

  SST:
    colname: geosgcm_ocn2dT
    name: TS
    coltype: GEOSTripolar
    template: '{data_path}/geosgcm_ocn2dT/{expid}.{colname}.monthly.??????.nc4'

  SSS:
    colname: geosgcm_ocn2dT
    name: SSS
    coltype: GEOSTripolar
    template: '{data_path}/geosgcm_ocn2dT/{expid}.{colname}.monthly.??????.nc4'

  SSH:
    colname: geosgcm_ocn2dT
    name: ETAN
    coltype: GEOSTripolar
    template: '{data_path}/geosgcm_ocn2dT/{expid}.{colname}.monthly.??????.nc4'

Not a pressing issue but it would be a nice feature to include, as the current way of manually adding these entries is very unintuitive if you're not already familiar with the structure of these scripts.

Dominant language
Fortran
Stars
2
Forks
1
Avg merge
1d 2h
Merged PRs (30d)
10

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from GEOS-ESM/GEOS_Util

All issues in GEOS-ESM/GEOS_Util

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.