eCLM Documentation - Githubissues

HPSCTerrSys / eCLM

Fork of Community Land Model v5.0

https://hpscterrsys.github.io/eCLM/

Other

8 stars 13 forks source link

eCLM Documentation #38

Closed odombro closed 1 month ago

odombro commented 3 months ago

This pull request adds a documentation for eCLM to the repository by changing and adding files to the docs/ directory. The new documentation includes a User's Guide with the following chapters:

Introduction to eCLM
Building eCLM
Running example cases
Creating a custom case
Running eCLM
Analyzing model output

jjokella commented 2 months ago

I have updated the docs-initial branch with 4 commits from master.

I plan to work through the documentation in the coming days with the goal of generating eCLM-PDAF data-assimilation testcases from the testcases discussed here.

What is the status of the PR? Could it be merged?

kvrigor commented 2 months ago

@jjokella there's a discussion on whether the Custom case creation docs should be moved to the eCLM_static_file_workflow repo. Feel free to also share your inputs there :)

jjokella commented 2 months ago

I have added some minor changes to the doc after working through it. It is very nice! I could build on Ubuntu and JSC machines.

Remarks:

Prerequisites for JSC users: I would like to more or less replace this section with a link to the central resource https://go.fzj.de/ibg-3-supercomputer-guide I already adapted this resource with some content from this documentation. @odombro If you give your ok I would start removing the sections that I have "assimilated" into the central Wiki
Building eCLM:JSC:Setting up eCLM: (1) MYPROJECT / MYSCRATCH not really needed!? Could be left out to make documentation more general. (2) Script load-eclm-variables.sh could be put in a shared folder as it is anyway very JSC-specific

Btw: These are just points of discussion I wanted to write down. They are not supposed to stop the merging of this PR!

odombro commented 2 months ago

Thanks for the review @jjokella. Regarding your comment on Prerequisites for JSC users, yes I am totally fine with that and also your other suggestions

kvrigor commented 2 months ago

Building eCLM:JSC:Setting up eCLM: (1) MYPROJECT / MYSCRATCH not really needed!? Could be left out to make documentation more general. (2) Script load-eclm-variables.sh could be put in a shared folder as it is anyway very JSC-specific

Thanks for pointing this out @jjokella . I intend to fix the build part of the documentation on the next PR.

kvrigor commented 2 months ago

@s-poll @jjokella Can we already merge this? I'd suggest to do the improvements on the next pull requests. This PR is mainly for establishing the doc CI workflow and having a decent initial set of documentation which doesn't have to be super polished.