From 98a80ed29043d7771751fe7367ab44ef31ce3e25 Mon Sep 17 00:00:00 2001 From: Charles Kawczynski Date: Fri, 6 Sep 2024 16:05:46 -0400 Subject: [PATCH] Reviewer comments --- README.md | 10 ++++++++++ docs/src/index.md | 3 ++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3a5bdbaf..c3d45179 100644 --- a/README.md +++ b/README.md @@ -22,3 +22,13 @@ Thermodynamics.jl provides flexible and performant functions for computing vario [codecov-url]: https://codecov.io/gh/CliMA/Thermodynamics.jl See our documentation [here](https://clima.github.io/Thermodynamics.jl/dev/index). + +Thermodynamics is used by several CliMA components, including: + + - [ClimaAtmos](https://github.com/CliMA/ClimaAtmos.jl) + - [ClimaLand](https://github.com/CliMA/ClimaLand.jl) + - [ClimaOcean](https://github.com/CliMA/ClimaOcean.jl) + - [ClimaCoupler](https://github.com/CliMA/ClimaCoupler.jl) + - [CloudMicrophyiscs](https://github.com/CliMA/CloudMicrophysics.jl) + - [SurfaceFluxes](https://github.com/CliMA/SurfaceFluxes.jl) + - [KinematicDriver](https://github.com/CliMA/KinematicDriver.jl) diff --git a/docs/src/index.md b/docs/src/index.md index 4f587772..e4f31033 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -82,8 +82,9 @@ using the functions, e.g., for the energies in the module, and computing the temperature `T` and the liquid and ice specific humidities (`q.liq` and `q.ice`) from the internal energy `e_int` by saturation adjustment. -## Usage +## Dycore pseudo code +Here, we outline how users might use Thermodynamics inside a circulation model. Users are encouraged to first establish a thermodynamic state with one of our [Thermodynamic State Constructors](@ref). For example, we would construct a moist thermodynamic state using