Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

eCLM Documentation #38

Merged
merged 69 commits into from
Aug 29, 2024
Merged

eCLM Documentation #38

merged 69 commits into from
Aug 29, 2024

Conversation

odombro
Copy link
Collaborator

@odombro odombro commented Jul 8, 2024

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

kvrigor and others added 30 commits May 3, 2024 16:40
@kvrigor
Docs initial commit
9240cb7
@kvrigor
Fixed wrong pip install path and added README on how to build docs
0955e79
@kvrigor
Set full path to doc artifacts
01403d8
@kvrigor
Try docs/_build/html
e5e7d9f
@kvrigor
Fixed typo on docs.yml
83e1e5a
@kvrigor
Specified github-pages env var
523ae8a
@kvrigor
Added Makefile for building docs locally
00891de
@kvrigor
Test .ipynb notebook
4e79eb1
@kvrigor
Restructured docs
dfeb86f
@kvrigor
CI: Renamed upload-pages-artifact -> upload-artifact
9a86e22
@kvrigor
CI: Revert to upload-page-artifact@v2
d86ba25
@kvrigor
CI: Revert to upload-pages-artifact@v2
82df3fd
@kvrigor
CI: Supported pip caching
5da48de
@kvrigor
CI: Add checks for dead links
b43c0c0
@kvrigor
CI: Fixed wrong path for linkcheck
7887266
@kvrigor
Slightly modified ToC structure
cca9726
@kvrigor
Set branch to docs-initial
bb677b7
@kvrigor
Disabled edit button
f1ad2ff
@kvrigor
Renamed Tutorials -> User's Guide
8e3eb4e
@kvrigor
Added eCLM Source Code browser
3354f91
@kvrigor
docs.yml: Fixed working-directory path
95c86a1
@kvrigor
Uploaded FORD_options.md
057abe1
@odombro
Added description for building eCLM on JSC machines
1493955
@odombro
Updated description for building eCLM on JSC machines
f936022
@odombro
Additional updates to building eCLM on JSC machines
83c4ef7
@odombro
Added introduction to the Guide, updated toc
1a90c7d
@odombro
Updates to INDEX and introduction
bff2fdb
@odombro
Updated introduction and eCLM build on JSC machines
27b5b7d
@odombro
Updated URLs
22e7130
@odombro
Modified README of case_creation
9e87b19
@kvrigor
Copy link
Member

kvrigor commented Aug 7, 2024

@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.

@jjokella
docs: -r flags for cp command needed
18103be 
Error message:

```
cp: -r not specified; omitting directory
'/p/scratch/cslts/shared_data/rlmod_eCLM/example_cases/nrw_300x300'
```
@AGonzalezNicolas AGonzalezNicolas merged commit 4a809b0 into master Aug 29, 2024
10 checks passed
@jjokella jjokella deleted the docs-initial branch October 18, 2024 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kvrigor kvrigor kvrigor approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@odombro @jjokella @kvrigor @AGonzalezNicolas