-
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.
- Loading branch information
1 parent
b737e66
commit 41db907
Showing
2 changed files
with
63 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
```@autodocs | ||
Modules=[ClimaLand] | ||
``` |
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). | ||
|