O5.1.4 (coupler) Software Revamp for ClimaCoupler v0.1.0 Release

[LenkaNovak]

The Climate Modeling Alliance

Software Design Issue 📜

Purpose

We're currently preparing for our first release of the coupler. As part of this release, we want to make sure that the code is readable, documented, well tested, straightforward for new users, and generally high quality. This SDI involves improvements and refactoring of the codebase that will achieve these goals.

Cost/Benefits/Risks

b: streamlining AMIP delivery, higher code quality
c: developer time

People and Personnel

• Lead: @juliasloan25
• Collaborators: @LenkaNovak @valeriabarra
• Reviewers:

Components

• streamline and generalize coupler interface
• make sure documentation is thorough
• make sure testing is thorough

Inputs

This SDI builds off of #276 and #359.

Results and Deliverables

• able to run full AMIP simulation
• clean interface, which will be used to couple additional component models in the future
• high quality code (documentation, testing, readability, etc)

QA

• no behavioural change (except a small change after change SIC_init to SIC in the driver #334)

SDI Revision Log

31 July 2023 - updated by @juliasloan25 for accuracy
25 Sept 2023 - @juliasloan25 moved task breakdown to tasklists
20 Nov 2023 - some tasks moved to #516 to reduce content in this SDI and streamline v0.1.0 release (by @juliasloan25)
29 Feb 2024 - @juliasloan25 updated timelines

Proposed Delivery Date

1 April 2024

clean up coupler interface [March 2024]

Preview Give feedback

1. move SurfaceStub to its own file #669
   🍃 leaf 💰 Grab Bag +2
   
2. clean up and document coupler fields #339
   🍃 leaf +1
   
3. remove outdated src/ folders #458
   🍃 leaf +1
   
4. change SIC_init to SIC in the driver #334
   🍃 leaf bug +2
   
5. Move CoupledSimulation to Interfacer #333
   🍃 leaf +1
   
6. Split Coupler and ClimaAtmos ArgParse #350
   💰 Grab Bag +1
   
7. remove dependencies on component model data strucutres #332
   +0
   
8. Reformulate ConservationChecker #419
   🍃 leaf +1
   

improve code quality for release [April 2024]

Preview Give feedback

1. remap only the necessary dates #450
   🍃 leaf +1
   
2. more systematic import of packages #670
   🍃 leaf 💰 Grab Bag +2
   
3. Enhance longrun output plot summary #721
   🍃 leaf +1
   
4. Incorporate ClimaAtmos.Diagnostics plots into our CI #654
   🍃 leaf +1
   
5. add checklist of AMIP requirements to docs #652
   🍃 leaf 💰 Grab Bag +2
   
6. Add missing docstrings #676
   🍃 leaf +1
   
7. clean up tutorial/driver #651
   🍃 leaf 💰 Grab Bag +2
   
8. remove output, plotting directories #587
   💰 Grab Bag +1
   
9. check water conservation (incl. snow) #404
   🍃 leaf +1
   

miscellaneous [April 2024]

Preview Give feedback

1. Improve slack report #693
   GPU enhancement +2
   
2. overwrite atmos albedo #653
   🍃 leaf +1
   
3. Update test bash script #667
   🔥 Urgent +1
   
4. add seabreeze artifacts to buildkite #533
   🍃 leaf 💰 Grab Bag +2
   
5. remove exp/ClimaCore/atm-ocn-lnd #537
   🍃 leaf +1
   
6. use depot #553
   🍃 leaf +1
   
7. rename AMIP/modular/ -> AMIP/ #525
   🍃 leaf 💰 Grab Bag +2
   
8. enable Float32 compatibility #449
   🍃 leaf bug +2
   
9. Replace OrdinaryDiffEq dep with SciMLBase #427
   🍃 leaf +1
   
10. clean up ClimaCore test cases #524
    🍃 leaf +1
    
11. Enable prescribing 3d fields from files #507
    🔥 Urgent +1
    

    
12. Reduce env variables in buildkite pipelines #441
    🍃 leaf +1
    
13. Add up_deps.jl script to automate/streamline updating dependencies #409
    🍃 leaf Dependencies 🔗 +2
    

[LenkaNovak]

@juliasloan25 would it be possible to add #486 and #479 to this, since this is mainly interface work with no expected behavioral changes? Feel free to assign me to them for Q4.

[juliasloan25]

@LenkaNovak I added #486 under "prepare for release", and added #479 to #516