Skip to content
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
208ceb0
Collected install instructions into one page
kvrigor Oct 6, 2025
6910b0b
Quick touch up of Wuestebach test case
kvrigor Oct 6, 2025
c460fcc
Removed outdated 'create custom case' guides
kvrigor Oct 6, 2025
805c8f5
Returned source installation guide and added Quickstart section
kvrigor Oct 6, 2025
05071ce
Staging changes to INDEX and Quickstart
kvrigor Oct 6, 2025
b8b3a71
Quickstart first draft
kvrigor Oct 9, 2025
55ca1b9
Renamed 'Quickstart' to 'First Tutorial'
kvrigor Oct 9, 2025
dfcd2a7
Fixed broken internal links
kvrigor Oct 10, 2025
f741b82
Removed nonfunctional anchor links
kvrigor Oct 10, 2025
16ff237
Merge branch 'master' into docs-polish-instructions
kvrigor Dec 2, 2025
e7345c1
Merge branch 'master' into docs-polish-instructions
kvrigor Dec 11, 2025
289cfd4
Removed unused images
kvrigor Jan 12, 2026
8bfb921
Replaced obsolete case creation guide with eCLM static file generator…
kvrigor Jan 12, 2026
d363967
Moved perturbation guides under misc. tutorials
kvrigor Jan 12, 2026
99fc97b
Edits on first_tutorial.md
kvrigor Jan 12, 2026
55d47d7
First tutorial writeup in progress...
kvrigor Jan 12, 2026
26f168f
Upload missing users_guide/misc_tutorials/README.md
kvrigor Jan 12, 2026
ba2ce88
Made first tutorial much shorter
kvrigor Feb 11, 2026
3b0db60
Moved introduction to homepage
kvrigor Mar 10, 2026
c1026bf
Removed nl customization and output analysis guides
kvrigor Mar 10, 2026
5836414
removed NRW and EURO-CORDEX test cases
kvrigor Mar 10, 2026
0099b84
Merge branch 'master' into docs-polish-instructions
kvrigor Mar 10, 2026
6ecc806
INDEX.md: Moved 'Difference with CLM5' section above
kvrigor Mar 19, 2026
f80acad
Merge branch 'master' into docs-polish-instructions
kvrigor Apr 14, 2026
759477a
Updated Quickstart
kvrigor Apr 15, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/INDEX.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# eCLM Documentation
# Welcome to eCLM!

```{important}
**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.
```{warning}
TODO
```

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.

An overview of eCLM can be seen from this [poster](https://virtual.oxfordabstracts.com/event/75166/submission/35) which was presented at [RSECon'25](https://rsecon25.society-rse.org).

![eCLM poster](users_guide/images/rsecon25_eclm_poster.jpg)
15 changes: 2 additions & 13 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ root: INDEX
parts:
- caption: Introduction
chapters:
- file: users_guide/installation/README
title: Installing eCLM
- file: users_guide/introduction/introduction
title: Scientific Background
- file: users_guide/introduction/first_tutorial.md
title: First Tutorial

- caption: User's Guide
chapters:
Expand All @@ -27,13 +27,6 @@ parts:

- file: users_guide/case_creation/README
title: Creating a custom case
sections:
- file: users_guide/case_creation/1_create_grid_file
- file: users_guide/case_creation/2_create_mapping_file
- file: users_guide/case_creation/3_create_domain_file
- file: users_guide/case_creation/4_create_surface_file
- file: users_guide/case_creation/5_modifications_surface_domain_file
- file: users_guide/case_creation/6_create_atm_forcings

- caption: Developer's Guide
chapters:
Expand All @@ -47,7 +40,3 @@ parts:
- file: reference/history_fields
- url: https://escomp.github.io/CTSM/release-clm5.0/tech_note/index.html
title: CLM5 Technical Note
- url: https://github.com/HPSCTerrSys/eCLM_static-file-generator/blob/main/README.md)
title: eCLM static file generator
- url: https://hpscterrsys.github.io/TSMP2_workflow-engine
title: TSMP2 Workflow Engine
55 changes: 0 additions & 55 deletions docs/users_guide/case_creation/1_create_grid_file.md

This file was deleted.

39 changes: 0 additions & 39 deletions docs/users_guide/case_creation/2_create_mapping_file.md

This file was deleted.

37 changes: 0 additions & 37 deletions docs/users_guide/case_creation/3_create_domain_file.md

This file was deleted.

43 changes: 0 additions & 43 deletions docs/users_guide/case_creation/4_create_surface_file.md

This file was deleted.

This file was deleted.

95 changes: 0 additions & 95 deletions docs/users_guide/case_creation/6_create_atm_forcings.md

This file was deleted.

Loading
Loading