Skip to content

Split setup_and_run in multiple steps #1251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 3, 2025
Merged

Split setup_and_run in multiple steps #1251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,21 @@ ClimaCoupler.jl Release Notes

### ClimaCoupler features

### Split `setup_and_run` in multiple functions. PR[#1251](https://github.com/CliMA/ClimaCoupler.jl/pull/1251)

`setup_and_run` was split into three functions:
- `CoupledSimulation`, which takes a dictionary of a file path and constructs a coupled simulation
- `run!`, which evolves the model
- `postprocess`, which makes plots

In addition to this, `step!` was introduced to take a single step forward with
the coupled simulation.

The function `setup_and_run` is still available.

This change also renames `calendar_dt` to `diagnostics_dt` to make it clearer
that it refers to diagnostics.

### Some misc. cleanup PR[#1244](https://github.com/CliMA/ClimaCoupler.jl/pull/1244)
Changes include
- Land simulation constructors no longer take in `domain_type`, which was unused.
Expand Down
8 changes: 7 additions & 1 deletion experiments/ClimaEarth/run_amip.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,10 @@ include("setup_run.jl")
config_file = parse_commandline(argparse_settings())["config_file"]

# Set up and run the coupled simulation
cs = setup_and_run(config_file)
cs = CoupledSimulation(config_file)
run!(cs)

# Postprocessing
# TODO: Remove this option?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove it, but let's do it in a separate PR so we can get this one in today. conservation_softfail is used for 3 regular CI runs, and some longruns. The longruns are mostly soft fails anyway, and if any regular CI slabplanets fail conservation we can make them soft fail in the pipeline, which will increase visibility of which ones fail conservation rather than hiding it away with this argument.

conservation_softfail = get_coupler_config_dict(config_file)["conservation_softfail"]
postprocess(cs, conservation_softfail)
Loading
Loading