-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Home and getting started documentation pages
ClimaLand.jl documentation had no landing page for a while, and then just a small line. In this commit, we add a better home page as well as a getting started page. The documentation navigation has been slightly refactored as well.
- Loading branch information
1 parent
1baeec9
commit 32d21ec
Showing
6 changed files
with
190 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| tutorials = [ | ||
| "Running simulations" => [ | ||
| "Bucket LSM" => [ | ||
| "standalone/Bucket/bucket_tutorial.jl", | ||
| "standalone/Bucket/coupled_bucket.jl", | ||
| ], | ||
| "Soil modeling" => [ | ||
| "Boundary conditions" => "standalone/Soil/boundary_conditions.jl", | ||
| "Richards Equation" => "standalone/Soil/richards_equation.jl", | ||
| "Energy and Hydrology" => "standalone/Soil/soil_energy_hydrology.jl", | ||
| "Phase Changes" => "standalone/Soil/freezing_front.jl", | ||
| "Layered Soil" => "standalone/Soil/layered_soil.jl", | ||
| "Coarse Sand Evaporation" => "standalone/Soil/evaporation.jl", | ||
| "Gilat Loess Evaporation" => "standalone/Soil/evaporation_gilat_loess.jl", | ||
| "Bare soil site" => "standalone/Soil/sublimation.jl", | ||
| ], | ||
| "Canopy modeling" => [ | ||
| "Standalone Canopy" => "standalone/Canopy/canopy_tutorial.jl", | ||
| ], | ||
| "Integrated soil+canopy modeling" => [ | ||
| "Coupled Canopy and Soil" => "integrated/soil_canopy_tutorial.jl", | ||
| ], | ||
| "Snow Modeling" => [ | ||
| "standalone/Snow/base_tutorial.jl", | ||
| "standalone/Snow/data_tutorial.jl", | ||
| ], | ||
| ], | ||
| "For model developers" => [ | ||
| "Intro to standalone models" => "standalone/Usage/model_tutorial.jl", | ||
| "Intro to multi-component models" => "standalone/Usage/LSM_single_column_tutorial.jl", | ||
| "Intro to ClimaLand Domains" => "standalone/Usage/domain_tutorial.jl", | ||
| "Intro to forced site-level runs" => "shared_utilities/driver_tutorial.jl", | ||
| ], | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| # Getting Started | ||
|
|
||
| ## For Users | ||
|
|
||
| ### Installation | ||
|
|
||
| First, download and install Julia by following the instructions at [https://julialang.org/downloads/](https://julialang.org/downloads/). | ||
| Then, you can install the ClimaLand package by doing: | ||
|
|
||
| ```julia | ||
| julia> ] # Enter Package REPL mode | ||
| Pkg> add ClimaLand # Install ClimaLand | ||
| Pkg> # Go back to Julia REPL mode | ||
| Julia> using ClimaLand | ||
| ``` | ||
|
|
||
| A typical land simulation employs several different parameterizations to model the various land-surface processes. Let's start our journet into ClimaLand by looking at one of those. | ||
|
|
||
| ### Parameterization | ||
|
|
||
| Let's start with a basic example: compute canopy gross photosynthesis (GPP). | ||
|
|
||
| ```@repl | ||
| using ClimaLand | ||
| @doc ClimaLand.Canopy.compute_GPP | ||
| ``` | ||
|
|
||
| As you can see, our parameterization for GPP is located in the [`Canopy`](@ref ClimaLand.Canopy) Module, and requires four arguments. | ||
| For example, with An = 5 µmol m⁻² s⁻¹, K = 0.5, LAI = 3 m² m⁻², Ω = 0.7, you can compute GPP like below: | ||
|
|
||
| ```@repl | ||
| import ClimaLand.Canopy as canopy | ||
| canopy.compute_GPP(5.0, 0.5, 3.0, 0.7) | ||
| ``` | ||
|
|
||
| Et voilà! | ||
|
|
||
| Note that our package [ParamViz](https://github.com/CliMA/ParamViz.jl) allows interactive visualisation of | ||
| our parameterizations. See examples in the standalone models pages. | ||
|
|
||
| ### ClimaLand structure | ||
|
|
||
| ClimaLand contains multiple modules. They are listed below: | ||
|
|
||
| ```@repl | ||
| using MethodAnalysis, ClimaLand | ||
| child_modules(ClimaLand) | ||
| ``` | ||
|
|
||
| To explore what modules, functions and types are exported in a particular module, you can use [About.jl](https://github.com/tecosaur/About.jl): | ||
|
|
||
| ```@repl | ||
| using ClimaLand | ||
| using About | ||
| about(ClimaLand.Soil.Biogeochemistry) | ||
| ``` | ||
|
|
||
| To see the documentation about a particular module, function or type, you can use ? to go in help mode | ||
| in the REPL, or `@doc` as in [Parameterization above](#Parameterization). | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,54 @@ | ||
| # ClimaLand.jl | ||
| ```@eval | ||
| using Pkg | ||
| io = IOBuffer() | ||
| v = Pkg.installed()["ClimaLand"] | ||
| print(io, """ | ||
| # ClimaLand.jl Documentation (v$(v)) | ||
| """) | ||
| import Markdown | ||
| Markdown.parse(String(take!(io))) | ||
| ``` | ||
|
|
||
| ## Introduction | ||
|
|
||
| ClimaLand is the Land model of the Climate Modeling Alliance (CliMA) Earth System Model, which | ||
| also contains other components ([atmosphere](https://github.com/CliMA/ClimaAtmos.jl), [ocean](https://github.com/CliMA/ClimaOcean.jl), [sea-ice](https://github.com/CliMA/ClimaSeaIce.jl)). | ||
|
|
||
| ClimaLand can be run coupled (or "online") with these other components via [ClimaCoupler](https://github.com/CliMA/ClimaCoupler.jl), | ||
| or it can be run as a standalone, via prescribed meteorological data ("offline"). | ||
|
|
||
| ClimaLand library, described in this documentation, is written in the Julia | ||
| programming language. It aims to be fast and have a clear syntax. ClimaLand | ||
| can run on CPU or GPU, it has a modular design, and is flexible in many ways. This documentation will expand on each of these elements. | ||
|
|
||
| ## Important Links | ||
|
|
||
| - [CliMA Homepage](https://clima.caltech.edu/) | ||
| - [CliMA GitHub Organisation](https://github.com/CliMA) | ||
| - [ClimaCoupler](https://github.com/CliMA/ClimaCoupler.jl) | ||
| - [ClimaAnalysis](https://github.com/CliMA/ClimaAnalysis.jl) | ||
| - [Julia Homepage](https://julialang.org) | ||
|
|
||
| ## Documentation for Users and Developers | ||
|
|
||
| ClimaLand has documentation for both users and developers. The documentation for users is aimed at scientists who wants | ||
| to run simulations using ClimaLand, whereas the documentation for developers is aimed at contributors of the ClimaLand | ||
| code library. As such, users can skip reading the docs for developers, and vice-versa. | ||
|
|
||
| ## Physical units | ||
|
|
||
| Note that CliMA, in all its repositories, uses Standard Units, reminded below | ||
|
|
||
| | Quantity | Unit Name | SI Symbol | SI Unit Equivalent | | ||
| |:----------------------|:----------|:----------|:--------------------| | ||
| | Length | Meter | m | 1 m | | ||
| | Mass | Kilogram | kg | 1 kg | | ||
| | Time | Second | s | 1 s | | ||
| | Temperature | Kelvin | K | 1 K | | ||
| | Amount of Substance | Mole | mol | 1 mol | | ||
| | Energy | Joule | J | 1 J = 1 N·m | | ||
| | Power | Watt | W | 1 W = 1 J/s | | ||
| | Pressure | Pascal | Pa | 1 Pa = 1 N/m² | | ||
| | Frequency | Hertz | Hz | 1 Hz = 1 s⁻¹ | | ||
|
|
||
| `ClimaLand.jl` is a [Julia](https://julialang.org/) toolkit for land surface | ||
| modeling. |