NCAR / NCAR/ccpp-framework

Add optional metadata fields for constituent implementation

Open
#461 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
25
Forks
67
Avg merge
3d 8h
Merged PRs (30d)
2

Description

Description

For the purposes of completing the constituent infrastructure in CAMDEN, @gold2718 and I propose two new optional metadata fields:

  • molar_mass (float)
  • input_names (list): list of aliases found on file for reading input data file

Additionally: a new interface will be generated (akin to ccpp_physics_suite_variables) that will return the input_names list for each variable.

Aside: a related optional metadata field is already in NCAR/ccpp-framework/main:

  • advected (boolean, default false): if true, this is an advected constituent

Alternatives (optional)

During discussion of this at the CCPP Framework meeting, there was some pushback on the input_names field because:

  1. "non-standard" fieldnames like "T" and "state_T" (for example) introduce unwanted ambiguity
  2. Since the framework should have nothing to do with I/O it seems iffy to include these names that are very much tied to I/O

One related suggestion was to change the name of the field from input_names to known_aliases or input_aliases for clarity. Though this does not resolve the ambiguity of the aliases themselves or the I/O ties.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by locating the constituent metadata handling and the existing ccpp_physics_suite_variables interface mentioned in the issue. Resolve whether input_names belongs in the framework and what its name and semantics should be, then define the generated interface and verify that molar_mass, input_names, and advected are represented consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.