ESCOMP / ESCOMP/CMEPS

Prefer the "shr_" prefix naming convention for the cesm/nuopc_cap_share directory

Open
#400 5 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Fortran
Stars
35
Forks
106
Avg merge
6d 5h
Merged PRs (30d)
4

Description

In discussion we decided that the "shr_" prefix should be the main default for files in the cesm/nuopc_cap_share directory.

The question was:
The files in the cesm/nuopc_cap_share directory have different prefixes used that doesn't make it obvious where these files are coming from. It would be good to name them consistently such that it's obvious where they are coming from. The "shr_" prefix used by many in the directory comes from when these files were part of csm_share, and when I look at the prefix that's where I think they come from.

Prefixes currently being used include:

driver_
glc_
seq_
shr_
esm_
nuopc_shr

seq_ comes from when the sequential driver was separate from the concurrent one. But, now they are combined so that's not good. glc_ lets us know this is for the Glacier model -- but then it's unclear as to why it's here and not under CISM? driver_ and esm_ are perhaps OK, but still not clear that these are part of CMEPS.

Definition of done:
- [x] Change files with seq_ prefix to shr_
- [x] Change files with nuopc_shr_ to shr
- [ ] Leave esm_ and driver_ files in place
- [ ] Move nuopc_cap_share directory (including glc_*) to cesm_share repository

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.