+
+
Create and run land models in integrated (multi- @@ -23,6 +23,7 @@ component) or standalone (single component) modes. This is the repository of the CliMA land model code. Here are some notable features: - ClimaLand has a modular design, models can be run as standalone (e.g., soil moisture only) or integrated (e.g., soil moisture and energy AND canopy AND snow, etc.) +- ClimaLand can simulate single columns, regional boxes, and global runs - ClimaLand is CPU and GPU compatible - ClimaLand welcome contributions: please feel free to reach out to us with questions about how to get started, create a branch, and extend our code. For example, a modeler might want to test a new stomatal conductance model. - ClimaLand provides APIs and UIs at multiple levels. diff --git a/docs/make.jl b/docs/make.jl index 985750b47b..2a2e787778 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -34,10 +34,6 @@ tutorials = [ "Integrated soil+canopy modeling" => [ "Coupled Canopy and Soil" => "integrated/soil_canopy_tutorial.jl", ], - "Bucket LSM" => [ - "standalone/Bucket/bucket_tutorial.jl", - "standalone/Bucket/coupled_bucket.jl", - ], "Snow Modeling" => [ "standalone/Snow/base_tutorial.jl", "standalone/Snow/data_tutorial.jl", diff --git a/docs/src/folderstructure.md b/docs/src/folderstructure.md index d4dfd2de42..8a74c4856e 100644 --- a/docs/src/folderstructure.md +++ b/docs/src/folderstructure.md @@ -2,7 +2,7 @@ [ClimaLand](https://github.com/CliMA/ClimaLand.jl) home directory has 5 main folders: -- docs: contains files to generate [the documentation website](clima.github.io/ClimaLand.jl/). +- docs: contains files to generate [the documentation website](clima.github.io/ClimaLand.jl/). - experiments: contains simple runs of `ClimaLand` models. - parameters: contains a file to retrieve constants such as avogadro's number, the speed of light, etc. - src: contains the code of `ClimaLand` models. @@ -45,7 +45,7 @@ For example, `/experiments/LSM/ozark/` contains: The `/src` folder contains the source code of `ClimaLand` models. It contains 3 folders: - shared_utilities: This is a core folder that defines functions and data structures used across all modules and models types of `ClimaLand`. For example, `shared_utilities/models.jl` defines and export the function `make_update_aux` which will be used to create a function which updates the auxiliary parameters, stored in the vector `p`, `shared_utilities/boundary_conditions.jl` defines functions for setting boundary condition for PDE domains, etc. -- standalone: This folder contains standalone models, which are submodels that can be run independently of each other. This is an important aspect of `ClimaLand` code design: to maximise modularity, sub-models can be run alone, and many different methods of the same sub-model can be defined via Julia multiple-disptach. The standalone folder is independent from the integrated folder. +- standalone: This folder contains standalone models, which are submodels that can be run independently of each other. This is an important aspect of `ClimaLand` code design: to maximize modularity, sub-models can be run alone, and many different methods of the same sub-model can be defined via Julia multiple dispatch. The standalone folder is independent from the integrated folder. - integrated: This folder contains integrated models. It assembles standalone models together, as one would assemble pieces of a puzzle. Thanks to the modularity of `ClimaLand` design, many configuration of LSM can be assembled in integrated models. The same functions (`update_aux!`, `exp_tendency!`, etc.) can be used for standalone and integrated models, and an can be stepped in the same way. As well as one file: diff --git a/docs/src/index.md b/docs/src/index.md index a121ecfb86..33ef855cb4 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1 +1,4 @@ -# ClimaLand.jl \ No newline at end of file +# ClimaLand.jl + +`ClimaLand.jl` is a [Julia](https://julialang.org/) toolkit for land surface +modeling.