ESCOMP / ESCOMP/CTSM

Add CUPiD to the CTSM checkout and start hooking it up to enable using it in cases

Open
#3,396 25 comments 1 reaction 4 assignees Claimed by @ekluzek View on GitHub
b4b enhancement science usability
Dominant language
Fortran
Stars
352
Forks
361
Avg merge
2d 21h
Merged PRs (30d)
7

Description

CUPiD has advanced far enough that we now need to start planning on bringing it into the CTSM checkout and enable it to be able to be used in I compset cases that people create with CTSM.

Definition of Done:
- [x] Create CUPiD branch on ESCOMP and branch rules
- [x] Add to .gitmodule and tools/CUPiD directory
- [x] Add a user-mod for it
- [ ] Add the CUPiD Tutorial from LMWG to the UG (#3721)
- [ ] See if we can set default values for some CUPID variables in config_component.xml for CLM
- [ ] Add a simple smoke test to run it in aux_clm
- [ ] Add a testmod that does anything we can't do otherwise
- [ ] Both Sam's test out the branch
- [ ] Both Sam's review the PR and approve it
- [ ] Merge CUPiD to master as a new tag, remove the CUPiD branch

This is handled seperately:
- [x] Add to the github actions for conda env to build the CUPiD envs -- CUPiD should test this
- [x] Crop notebook

This started as a discussion that is referenced below. And there is a list of requirements from @TeaganKing before we should do this listed there.

I asked @TeaganKing an update on this and she sees just a few things that should happen before we do this. Here's the list of suggestions she had as requirements before this comes in:

_We should bring CUPiD into CTSM as a submodule once the following PRs are included in CUPiD:_

- [x] _[Include ILAMB in key_metrics and CESM workflow](https://github.com/NCAR/CUPiD/pull/210/files) (needs a bit more work but getting close)_
- [x] _[Enable LDF in CUPiD](https://github.com/NCAR/CUPiD/pull/226) (under final review)_
- [x] _[Allow users to specify what CUPiD install to use in CESM Workflow](https://github.com/NCAR/CUPiD/issues/257) (is on Mike's high priority list)_
- [x] _[Create a lnd-specific example](https://github.com/NCAR/CUPiD/issues/262) (This will be super quick & easy to do but hasn't been started)

_I'd guess this may take a month-ish before everything is ready..._

_Teagan_

_Originally posted by @ekluzek in https://github.com/ESCOMP/CTSM/discussions/2864#discussioncomment-14038391_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.