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

[ekluzek]

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:

• Create CUPiD branch on ESCOMP and branch rules
• Add to .gitmodule and tools/CUPiD directory
• Add a user-mod for it
• Add the CUPiD Tutorial from LMWG to the UG (User's Guide: Add documentation on running CUPiD in a case #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:

• Add to the github actions for conda env to build the CUPiD envs -- CUPiD should test this
• 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:

• Include ILAMB in key_metrics and CESM workflow (needs a bit more work but getting close)
• Enable LDF in CUPiD (under final review)
• Allow users to specify what CUPiD install to use in CESM Workflow (is on Mike's high priority list)
• _Create a lnd-specific example (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 #2864 (comment)

[wwieder]

Thanks for renewing this topic, Erik. I'm supper supportive of having CUPiD available with CTSM and suggest we do this for the CLM6 release

[ekluzek]

The CUPiD things have been done in the list at the top, other than create a land example. It says that should be easy to do. Adding to next to discuss if we should have someone do that step and start having CUPiD available in CTSM checkouts.