Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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