Skip to content

Commit 5f0b6b0

Browse files
authored
Prune unpolished and extra pages in online docs (#79)
Sitemap now looks like this: Introduction └─ Quick Start User's Guide ├─ Running example cases ├─ [Creating a custom case](https://hpscterrsys.github.io/eCLM_static-file-generator/INDEX.html) └─ Miscellaneous tutorials ├─ Atmospheric forcing noise └─ Soil hydraulic properties from surface file Developer's Guide ├─ Building eCLM from source └─ [eCLM Source Code Browser](https://hpscterrsys.github.io/eCLM/src) Reference ├─ History Fields └─ [CLM5 Technical Note](https://escomp.github.io/CTSM/release-clm5.0/tech_note/index.html)
1 parent 98054f5 commit 5f0b6b0

24 files changed

Lines changed: 159 additions & 737 deletions

docs/INDEX.md

100644100755
Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,48 @@
1-
# eCLM Documentation
1+
# Welcome to eCLM!
22

3-
```{important}
4-
**Welcome!** You are viewing the first version of the documentation for eCLM. This is a living document, which means it will be continuously updated and improved. Please check back regularly for the latest information and updates.
3+
eCLM is based on version 5.0 of the Community Land Model ([CLM5](https://www.cesm.ucar.edu/models/clm)) The Community Land Model is the land model for the Community Earth System Model (CESM). It focuses on modeling the land as the critical interface through which humanity affects, adapts to, and mitigates global environmental change. It includes a comprehensive representation of land biogeophysics, hydrology, plant physiology, biogeochemistry, anthropogenic land use, and ecosystem dynamics across a variety of spatial and temporal scales. The central theme is that terrestrial ecosystems, through their cycling of energy, water, chemical elements, and trace gases, are important determinants of climate.
4+
5+
## Difference with CLM5
6+
7+
eCLM has simplified infrastructure for build and namelist generation. The build system is handled entirely by CMake and namelists are generated through a small set of Python scripts. Similar to CLM5, eCLM is forced with meteorological data and uses numerous input streams on soil properties, land cover and land use, as well as complex parameter sets on crop phenology, and plant hydraulics for simulations.
8+
9+
## Biogeophysical and Biogeochemical Processes
10+
11+
eCLM, like [CLM5](https://escomp.github.io/CTSM/release-clm5.0/tech_note/Introduction/CLM50_Tech_Note_Introduction.html#biogeophysical-and-biogeochemical-processes), represents several aspects of the land surface including surface heterogeneity and consists of components or submodels related to land biogeophysics, the hydrologic cycle, biogeochemistry, human dimensions, and ecosystem dynamics. Specific processes that are represented include:
12+
13+
- Vegetation composition, structure, and phenology
14+
- Absorption, reflection, and transmittance of solar radiation
15+
- Absorption and emission of longwave radiation
16+
- Momentum, sensible heat (ground and canopy), and latent heat (ground evaporation, canopy evaporation, transpiration) fluxes
17+
- Heat transfer in soil and snow including phase change
18+
- Canopy hydrology (interception, throughfall, and drip)
19+
- Snow hydrology (snow accumulation and melt, compaction, water transfer between snow layers)
20+
- Soil hydrology (surface runoff, infiltration, redistribution of water within the column, sub-surface drainage, groundwater)
21+
- Plant hydrodynamics
22+
- Stomatal physiology and photosynthesis
23+
- Lake temperatures and fluxes
24+
- Dust deposition and fluxes
25+
- Routing of runoff from rivers to ocean
26+
- Volatile organic compounds emissions
27+
- Urban energy balance and climate
28+
- Carbon-nitrogen cycling
29+
- Dynamic landcover change
30+
- Land management including crops and crop management and wood harvest
31+
- Ecosystem Demography (FATES, optional)
32+
33+
```{figure} users_guide/images/CLM5_processes_Lawrence2019.png
34+
:height: 400px
35+
:name: fig1
36+
37+
Overview of land biogeophysical, biogeochemical and landscape processes simulated by eCLM, which is the same as CLM5. <a href="http://dx.doi.org/10.1029/2018MS001583" target="_blank">Lawrence et al. (2019)</a>.
538
```
639

7-
eCLM is based on version 5.0 of the Community Land Model ([CLM5](https://www.cesm.ucar.edu/models/clm)) with simplified infrastructure for build and namelist generation. The build system is handled entirely by Cmake and namelists are generated through a small set of Python scripts. Similar to CLM5, eCLM is forced with meteorological data and uses numerous input streams on soil properties, land cover and land use, as well as complex parameter sets on crop phenology, and plant hydraulics for simulations.
40+
Each time step the model solves the surface energy balance, water balance, and carbon exchange. Submodels of CLM include biophysics and biogeochemistry. It represents land surface heterogeneity through a subgrid tiling structure and different plant functional types that have unique parameters in terms of optical properties, morphology, photosynthesis. It can be run with prescribed vegetation states using satelllite phenology (SP mode) or prognostic vegetation states and biogeochemistry (BGC mode).
41+
42+
```{figure} users_guide/images/CLM5_subgrid_structure_v1.png
43+
:height: 400px
44+
:name: fig2
45+
46+
Configuration of the CLM subgrid hierarchy. Box in upper right shows hypothetical subgrid distribution for a single grid cell. Note that the Crop land unit is only used when the model is run with the crop model active. Abbreviations: TBD – Tall Building District; HD – High Density; MD – Medium Density, G – Glacier, L – Lake, U – Urban, C – Crop, V – Vegetated, PFT – Plant Functional Type, Irr – Irrigated, UIrr – Unirrigated. Red arrows indicate allowed land unit transitions. Purple arrows indicate allowed patch-level transitions. From <a href="https://escomp.github.io/ctsm-docs/versions/release-clm5.0/html/tech_note/Ecosystem/CLM50_Tech_Note_Ecosystem.html#id14" target="_blank">CLM5 Technical Note</a>.
47+
```
848

docs/_toc.yml

Lines changed: 10 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,39 +5,25 @@ root: INDEX
55
parts:
66
- caption: Introduction
77
chapters:
8-
- file: users_guide/installation/README
9-
title: Installing eCLM
10-
- file: users_guide/introduction/introduction
11-
title: Scientific Background
12-
- file: users_guide/introduction/perturbation
13-
title: Atmospheric forcing noise
14-
- file: users_guide/introduction/soil_hydraulic_parameters
15-
title: Soil hydraulic properties from surface file
16-
8+
- file: users_guide/introduction/quick_start
9+
title: Quick Start
1710
- caption: User's Guide
1811
chapters:
1912
- file: users_guide/case_examples/README
2013
title: Running example cases
2114
sections:
2215
- file: users_guide/case_examples/Wuestebach
23-
- file: users_guide/case_examples/NRW
24-
- file: users_guide/case_examples/EURO-CORDEX
25-
26-
- file: users_guide/running_cases/case_customization
27-
title: Customizing eCLM namelists
2816

29-
- file: users_guide/analyzing_model_output
30-
title: Analyzing model output
31-
32-
- file: users_guide/case_creation/README
17+
- url: https://hpscterrsys.github.io/eCLM_static-file-generator/INDEX.html
3318
title: Creating a custom case
19+
20+
- file: users_guide/misc_tutorials/README
21+
title: Miscellaneous tutorials
3422
sections:
35-
- file: users_guide/case_creation/1_create_grid_file
36-
- file: users_guide/case_creation/2_create_mapping_file
37-
- file: users_guide/case_creation/3_create_domain_file
38-
- file: users_guide/case_creation/4_create_surface_file
39-
- file: users_guide/case_creation/5_modifications_surface_domain_file
40-
- file: users_guide/case_creation/6_create_atm_forcings
23+
- file: users_guide/misc_tutorials/perturbation
24+
title: Atmospheric forcing noise
25+
- file: users_guide/misc_tutorials/soil_hydraulic_parameters
26+
title: Soil hydraulic properties from surface file
4127

4228
- caption: Developer's Guide
4329
chapters:
@@ -51,7 +37,3 @@ parts:
5137
- file: reference/history_fields
5238
- url: https://escomp.github.io/CTSM/release-clm5.0/tech_note/index.html
5339
title: CLM5 Technical Note
54-
- url: https://github.com/HPSCTerrSys/eCLM_static-file-generator/blob/main/README.md)
55-
title: eCLM static file generator
56-
- url: https://hpscterrsys.github.io/TSMP2_workflow-engine
57-
title: TSMP2 Workflow Engine

docs/users_guide/analyzing_model_output.md

Lines changed: 0 additions & 52 deletions
This file was deleted.

docs/users_guide/case_creation/1_create_grid_file.md

Lines changed: 0 additions & 55 deletions
This file was deleted.

docs/users_guide/case_creation/2_create_mapping_file.md

Lines changed: 0 additions & 39 deletions
This file was deleted.

docs/users_guide/case_creation/3_create_domain_file.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

docs/users_guide/case_creation/4_create_surface_file.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

0 commit comments

Comments
 (0)