Tethering

[djk2120]

Description of changes

Adding a new tool to tether CTSM simulations automatically.

Specific notes

Contributors other than yourself, if any:
Advice and guinea pig feedback from @linniahawkins @samsrabin @adrifoster

CTSM Issues Fixed:

• Resolves update infrastructure to support tethered simulations #3450
• Resolves translate spinup stability script to python #3486

Are answers expected to change (and if so in what way)? No.

Any User Interface Changes (namelist or namelist defaults changes)? This would create a new tool for automating submission of tethered CTSM simulations, but otherwise doesn't actually change the basic CTSM user interface.

Does this create a need to change or add documentation? Did you do so? Yes, this will need documentation. I've started drafting documentation in tools/tether/README.md. It's likely that we'll want to have generic "tether" documentation, as well as specific documentation for any supported sequences, e.g. SASU spinup, TRENDY S3, etc.

Testing performed, if any: None

[samsrabin]

Great to see this, Dan, thanks! I'm going to unsubscribe for now to reduce my notification load, but please ping me with any questions or if you want me to have a look.

[ekluzek]

Cool, thanks for making this a PR @djk2120. It's helpful to start to look through the code. I can tell that I'll need you to do a run-through of the code with us at some point.

We should probably rebase this to b4b-dev, to come in sooner. But, we'll wait for you to feel it's closer to ready.

[djk2120]

OK, I have a first draft in place. The tether utility and a spinup stability script are in place. And then two main examples ("example1" and "sasu_spinup") for how they could be deployed. What are the next steps @samsrabin @ekluzek ? Should I present the code at an upcoming software engineering meeting (or a smaller meeting)? Does it make sense for somebody else to beta-test one or both of the examples?

[samsrabin]

Excellent, thanks! Before one of us starts testing, could you merge in the ctsm5.3.073 tag and make sure it still works for you?

git remote add escomp git@github.com:ESCOMP/CTSM.git
git fetch escomp
git merge --no-ff ctsm5.3.073

[samsrabin]

(Or alternatively, rebase onto that tag if that's something you're comfortable doing.)

[djk2120]

OK, @samsrabin. I was able to merge in the new tag uneventfully.

[samsrabin]

Nice, thanks! I've marked this as "next" so we should discuss it in our next SE meeting.

[djk2120]

I'm also realizing that maybe this is actually two tools: a spinup stability python tool and a tethering utility, which I should probably split into two folders in tools/ (and potentially split into two PRs?)

[samsrabin]

@wwieder will test this in some upcoming spinup runs. @adrifoster will also test. @djk2120 let's keep this as one PR, but it'd be good if you could go ahead and split out the code for the spinup stability script.