E3SM-Project / E3SM-Project/zppy

Create alias parameter for `reference_data_path`

Open
#405 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

priority: low semver: small improvement
Dominant language
Python
Stars
8
Forks
16
Avg merge
3d 21h
Merged PRs (30d)
3

Description

It may be useful to have an alias for reference_data_path that is more descriptive for the model-vs-model case. e3sm_diags.py would just convert it to the existing parameter.

See discussion on #404.

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 with the discussion on #404, then inspect e3sm_diags.py and the existing reference_data_path handling. Define the more descriptive model-vs-model alias and ensure e3sm_diags.py converts it to the existing parameter; the work is done when the alias is accepted without changing current reference_data_path behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.