Skip to content

Commit

Permalink
Add documentation for ITime
Browse files Browse the repository at this point in the history
  • Loading branch information
ph-kev committed Feb 20, 2025
1 parent 3db5d5b commit 15a1513
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ main
PR[#973](https://github.com/CliMA/ClimaLand.jl/pull/973)
- Revert PR993 changes to runoff
PR[#1021](https://github.com/CliMA/ClimaLand.jl/pull/1021)
- Add ITime (see [ClimaUtilities documentation](https://clima.github.io/ClimaUtilities.jl/dev/timemanager/) for more information)
PR[#1030](https://github.com/CliMA/ClimaLand.jl/pull/1030)

v0.15.9
-------
Expand Down
1 change: 1 addition & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ pages = Any[
"Diagnostics" => diagnostics,
"Leaderboard" => "leaderboard/leaderboard.md",
"Restarts" => "restarts.md",
"Time type" => "timemanager.md",
"Misc. utilities" => "shared_utilities.md",
"APIs" => apis,
"Contribution guide" => "Contributing.md",
Expand Down
23 changes: 23 additions & 0 deletions docs/src/timemanager.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
## ITime

`ITime`, or _integer time_, is a time type used by CliMA simulations to keep
track of simulation time. For more information, refer to the
[TimeManager section](https://clima.github.io/ClimaUtilities.jl/dev/timemanager/)
in ClimaUtilities and the
[ITime section](https://clima.github.io/ClimaAtmos.jl/dev/itime/) in ClimaAtmos.

### How do I use ITime?

We do not support the functionality of running simulations using either `ITime` or
floating point. See the simulations below that automatically use `ITime`.

1. Snowy land long run
2. Soil-Canopy long run
3. California regional simulation long run
4. Soil model long run
5. Global bucket simulation long run
6. Bucket ERA5 model experiment
7. Richards runoff standalone experiment

If there is a particular simulation that is not compatible with `ITime` and you
would like to use `ITime` with it, then please open an issue for it!

0 comments on commit 15a1513

Please sign in to comment.