O5.3.1: Update ClimaCoupler driver to separate AMIP and slabplanet drivers and have organized subsections

[juliasloan25]

The Climate Modeling Alliance

Software Design Issue 📜

Purpose

The current AMIP driver is quite monolithic and inflexible. This OKR moves towards a more modular, developer- and user-friendly implementation.

Cost/Benefits/Risks

costs: developer time
benefits: this will make it easier to extend the driver for new use cases, and facilitate coupling with external models
risks: need to maintain functionality and simulation stability while making changes

People and Personnel

• Lead: @juliasloan25
• Collaborators/Reviewers: @imreddyTeja @Sbozzolo

Components

• First, modularize the existing driver into the following sections:
  • Argument parsing/configuration setup
  • Initialization of component models, coupling objects, and preallocated fields
  • Initial component model exchange
  • Solve function
  • Postprocessing/diagnostics
• Once this cleanup is satisfactory, we can separate the driver into two: one for AMIP and one for slabplanet

Inputs

Existing run_amip.jl driver and ClimaCoupler code

Results and Deliverables

• maintain simulation stability
• maintain or improve simulation performance (including time to first execution - TTFX)
• reduce amount of code in run_amip.jl driver

Scope of Work

Overall work

Beta Give feedback

1. Design what we want the driver to look like, and how we can get there from what we have
2. Isolate argument parsing/configuration setup
3. Isolate initialization of component models, coupling objects, and preallocated fields
4. clean up component model initialization #1011
   +0
5. Isolate initial component model exchange
6. Isolate solve function
7. Isolate postprocessing/diagnostics
8. Split driver into AMIP and slabplanet

Additional cleanup

Beta Give feedback

1. replace get_land_temp_from_state with get_field #1048
   💰 Grab Bag +1
   
2. remove unnecessary CoupledSimulation fields #1015
   💰 Grab Bag +1
   

SDI Revision Log

SDI opened 31 October 2024 by @juliasloan25

CC

@tapios @sriharshakandala @charleskawczynski @cmbengue