Compatibility issues while building deployment docs

[wilsonduan10]

The Climate Modeling Alliance

Software Design Issue 📜

Purpose

The example file aerosol_activation.jl is only compatible with CloudMicrophysics v0.5, which constrains other CliMA packages to older versions. For example, CloudMicrophysics v0.5 is only compatible with the package SurfaceFluxes on versions up to 0.3. As a result, when adding an example file that depends on SurfaceFluxes v0.6, make.jl cannot build the docs for both aerosol_activation.jl and whatever file using SurfaceFluxes v0.6 due to compatibility mismatch. This poses a problem for branch wd/surface-flux-example, which intends to add the example kappa_calibration.jl, which relies on SurfaceFluxes v0.6.3.

Cost/Benefits/Risks

Although it takes time to update aerosol_activation.jl to match with more recent package releases, it makes the example file more relevant and easier to reproduce. In addition, by updating the file, it would allow developers such as myself to put out additional example files such as the one introduced above, kappa_calibration.jl, which depends on a newer version of SurfaceFluxes.

People and Personnel

• Lead: @odunbar
• Reviewers: @akshaysridhar, @LenkaNovak

Components

The solution would be updating aerosol_activation.jl to match current releases.

Inputs

Results and Deliverables

We would expect the updated example to have the same functionality but simply operate under the newer package releases.

Task Breakdown And Schedule

• Update aerosol_activation.jl to work with current release of packages such as CloudMicrophysics, CLIMAParameters, and Thermodynamics

SDI Revision Log

CC