Skip to content

Commit ebada88

Browse files
authored
Update installation instructions with terminology section
Added common terminology section to installation instructions.
1 parent 560c329 commit ebada88

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/src/installation_instructions.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Installation instructions
1+
## Installation instructions
22

33
ClimaAtmos.jl is a [registered Julia package](https://julialang.org/packages/). To install
44

@@ -29,3 +29,12 @@ $ julia --project
2929
julia> ]
3030
(ClimaAtmos) pkg> instantiate
3131
```
32+
33+
## Some common terminology in ClimaAtmos
34+
The following terms are frequently used within the source code and between collaborators. Feel free to open a GitHub issue if you come across any other key terms that we've missed here.
35+
- `Yₜ`: The tendency state vector, where `Yₜ.sfc` components are modified.
36+
- `Y`: The current state vector.
37+
- `p`: Cache containing parameters, precomputed fields (radiation fluxes, surface
38+
conditions, precipitation fluxes), atmospheric model configurations, and
39+
slab model properties.
40+
- `t`: Current simulation time.

0 commit comments

Comments
 (0)