Skip to content

Commit

Permalink
Reviewer comments
Browse files Browse the repository at this point in the history
  • Loading branch information
charleskawczynski committed Sep 6, 2024
1 parent 85b4f6c commit 98a80ed
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
3 changes: 2 additions & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 98a80ed

Please sign in to comment.