CliMA / ClimaCoupler.jl

# ClimaCoupler.jl
ClimaCoupler.jl provides coupled system time stepping control and support for mapping import and export
boundary information between components. It can handle atmosphere, ocean, land, and sea ice component models,
and the source code is agnostic to the internals of these component models.
ClimaCoupler.jl targets global, long-term climate simulations, specifically for the
Coupled Model Intercomparison Project (CMIP) and
Atmospheric Model Intercomparison Project (AMIP).
With these objectives in mind, this coupler is also designed to be flexible and modular,
so it supports simpler slabplanet-type setups as well.
| | | | |
|-------------------:|:-----------------------------------------------------------------------------------|-------------------:|:----------------------------------------|
| **Documentation** | [![stable][docs-stable-img]][docs-stable-url] [![dev][docs-dev-img]][docs-dev-url] | **License** | [![license][license-img]][license-url] |
| **Tests** | [![gha ci][gha-ci-img]][gha-ci-url] [![buildkite][bk-ci-img]][bk-ci-url] | **Code Coverage** | [![codecov][codecov-img]][codecov-url] |
| **Downloads** | [![Downloads][dlt-img]][dlt-url] | **Nightly AMIP** | [![buildkite][bk-amip-img]][bk-amip-url] |
[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-stable-url]: https://CliMA.github.io/ClimaCoupler.jl/stable/
[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
[docs-dev-url]: https://CliMA.github.io/ClimaCoupler.jl/dev/
[license-img]: https://img.shields.io/badge/license-Apache%202.0-blue.svg
[license-url]: https://github.com/CliMA/ClimaCoupler.jl/blob/main/LICENSE
[gha-ci-img]: https://github.com/CliMA/ClimaCoupler.jl/actions/workflows/ci.yml/badge.svg
[gha-ci-url]: https://github.com/CliMA/ClimaCoupler.jl/actions/workflows/ci.yml
[bk-ci-img]: https://badge.buildkite.com/1d6cfcc4219656239b9917210fa4c6e6f82b0516c2b0074fe1.svg?branch=main
[bk-ci-url]: https://buildkite.com/clima/climacoupler-ci
[bk-amip-img]: https://badge.buildkite.com/67ed8ae5c42ef2ea566fcf3a981e0165b39600dd24c5f9a37d.svg?branch=main
[bk-amip-url]: https://buildkite.com/clima/climacoupler-coarse-nightly-amip
[codecov-img]: https://codecov.io/gh/CliMA/ClimaCoupler.jl/branch/main/graph/badge.svg
[codecov-url]: https://codecov.io/gh/CliMA/ClimaCoupler.jl
[dlt-img]: https://img.shields.io/badge/dynamic/json?url=http%3A%2F%2Fjuliapkgstats.com%2Fapi%2Fv1%2Ftotal_downloads%2FClimaCoupler&query=total_requests&suffix=%2Ftotal&label=Downloads
[dlt-url]: https://juliapkgstats.com/pkg/ClimaCoupler
## Running AMIP
Here we will focus on the AMIP experiment, which uses the environment in the `experiments/AMIP/` subdirectory of ClimaCoupler.jl
The first step to do this is to install all required packages for the environment using the following Julia command:
 [code] 
Now you're ready to run the experiment, which uses the `run_simulation.jl` driver. To run interactively:
 [code] 
Or to run from the terminal:
 [code] 
When running from th