Skip to content

Commit 4f3d53f

Browse files
jjokellajjokella
committed
initial commit
README, LICENSE, gitignore, .github/, docs/ copied in the style of - eCLM static file generator - eCLM atmospheric forcing generator
0 parents  commit 4f3d53f

12 files changed

Lines changed: 225 additions & 0 deletions

File tree

‎.github/workflows/doc.yml‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: eCLM namelist generator Docs
2+
3+
on:
4+
push:
5+
branches: [ 'main' ]
6+
pull_request:
7+
branches: [ 'main' ]
8+
9+
env:
10+
BASE_URL: /${{ github.event.repository.name }}
11+
12+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
13+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-24.04
21+
steps:
22+
- uses: actions/checkout@v4
23+
with:
24+
submodules: false
25+
sparse-checkout: |
26+
.github
27+
docs
28+
29+
- name: Set up Python 3.12
30+
uses: actions/setup-python@v5
31+
with:
32+
python-version: 3.12
33+
cache: 'pip'
34+
35+
- name: Install dependencies
36+
run: pip install -r ${GITHUB_WORKSPACE}/docs/requirements.txt
37+
38+
- name: Build eCLM namelist generator doc homepage
39+
working-directory: ./docs
40+
run: |
41+
make clean docs
42+
43+
- name: Upload documentation artifacts
44+
uses: actions/upload-pages-artifact@v3
45+
with:
46+
path: "docs/_build/html"
47+
name: tsmp2_eclm_static_file_generator_docs
48+
49+
deploy:
50+
if: github.event_name != 'pull_request'
51+
needs: build
52+
runs-on: ubuntu-24.04
53+
environment:
54+
name: github-pages
55+
url: ${{ steps.deployment.outputs.page_url }}
56+
57+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
58+
permissions:
59+
pages: write # to deploy to Pages
60+
id-token: write # to verify the deployment originates from an appropriate source
61+
62+
steps:
63+
- name: Deploy to GitHub Pages
64+
id: deployment
65+
uses: actions/deploy-pages@v4
66+
with:
67+
artifact_name: tsmp2_eclm_namelist_generator_docs

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs/_build/*

‎LICENSE‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Copyright (c) 2026, Simulation and Data Laboratory Terrestrial Systems - Research Centre Jülich (SDLTS - FZJ)
2+
All rights reserved.
3+
4+
Developed by:
5+
6+
Simulation and Data Laboratory Terrestrial Systems - Research Centre Jülich (SDLTS - FZJ)
7+
https://www.hpsc-terrsys.de/hpsc-terrsys/EN/Home/simulation_lab/activities/activities_node.html
8+
9+
Permission is hereby granted, free of charge, to any person obtaining
10+
a copy of this software and associated documentation files (the "Software"),
11+
to deal with the Software without restriction, including without limitation
12+
the rights to use, copy, modify, merge, publish, distribute, sublicense,
13+
and/or sell copies of the Software, and to permit persons to whom
14+
the Software is furnished to do so, subject to the following conditions:
15+
16+
- Redistributions of source code must retain the above copyright notice,
17+
this list of conditions and the following disclaimers.
18+
- Redistributions in binary form must reproduce the above copyright notice,
19+
this list of conditions and the following disclaimers in the documentation
20+
and/or other materials provided with the distribution.
21+
- Neither the names of [Name of Development Group, UCAR],
22+
nor the names of its contributors may be used to endorse or promote
23+
products derived from this Software without specific prior written permission.
24+
25+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
26+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28+
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
29+
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30+
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31+
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32+
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33+
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34+
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35+
POSSIBILITY OF SUCH DAMAGE.

‎README.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# eCLM namelist generator
2+
3+
[![docs](https://github.com/HPSCTerrSys/eCLM_namelist-generator/actions/workflows/doc.yml/badge.svg)](https://github.com/HPSCTerrSys/eCLM_namelist-generator/actions/workflows/doc.yml)
4+
5+
## Introduction
6+
7+
This repository collects scripts used for generating and manipulating
8+
eCLM namelist files.
9+
10+
## Usage / Documentation
11+
12+
13+
Then please check the [generated documentation](https://hpscterrsys.github.io/eCLM_namelist-generator/INDEX.html) online, [generate a static version](docs/README.md) yourself or browse it locally: `$VISUAL docs/users_guide/?_*.md` with `$VISUAL` your editor or viewer of choice.
14+
15+
## License
16+
eCLM namelist generator is open source software and is licensed under an [MIT License](https://github.com/HPSCTerrSys/eCLM_namelist-generator/blob/master/LICENSE).

‎docs/INDEX.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# eCLM namelist generator Documentation
2+
3+
```{important}
4+
**Welcome!** You are viewing the first version of the documentation for eCLM namelist generator. This is a living document, which means it will be continuously updated and improved. Please check back regularly for the latest information and updates.
5+
```

‎docs/Makefile‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
BUILD_DIR = ./_build
2+
SRC_DIR = ../src
3+
4+
docs:
5+
jupyter-book build -W -n --keep-going .
6+
7+
all: docs
8+
9+
.PHONY: clean
10+
11+
clean:
12+
jupyter-book clean .

‎docs/README.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Building eCLM namelist generator Documentation
2+
3+
If you'd like to develop and/or build the eCLM namelist generator documentation, you should:
4+
5+
1. Switch to this directory: `cd docs`
6+
2. Run `pip install -r requirements.txt`
7+
3. (*Optional*) Edit the books source files (`*.md`) in this folder. Check out the [MyST syntax cheat sheet](https://jupyterbook.org/en/stable/reference/cheatsheet.html) for reference.
8+
4. Build the docs: `make clean docs`.
9+
5. Launch the doc homepage on your default browser: `open _build/html/index.html`
10+
11+
## Contributors
12+
13+
We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/HPSCTerrSys/eCLM_namelist-generator/graphs/contributors).
14+
15+
## Credits
16+
17+
This project is created using the excellent open source [Jupyter Book project](https://jupyterbook.org/) and the [executablebooks/cookiecutter-jupyter-book template](https://github.com/executablebooks/cookiecutter-jupyter-book).

‎docs/_config.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
#######################################################################################
2+
# A default configuration that will be loaded for all jupyter books
3+
# See the documentation for help and more options:
4+
# https://jupyterbook.org/customize/config.html
5+
6+
#######################################################################################
7+
# Book settings
8+
title : eCLM namelist generator Documentation # The title of the book. Will be placed in the left navbar.
9+
author : HPSC TerrSys # The author of the book
10+
copyright : "2026" # Copyright year to be placed in the footer
11+
logo : "" # A path to the book logo
12+
13+
# Force re-execution of notebooks on each build.
14+
# See https://jupyterbook.org/content/execute.html
15+
execute:
16+
execute_notebooks: force
17+
18+
# Define the name of the latex output file for PDF builds
19+
latex:
20+
latex_documents:
21+
targetname: book.tex
22+
23+
sphinx:
24+
config:
25+
language: en
26+
27+
# Information about where the book exists on the web
28+
repository:
29+
url: https://github.com/HPSCTerrSys/eCLM_namelist-generator # Online location of your book
30+
path_to_book: docs # Optional path to your book, relative to the repository root
31+
branch: main # Which branch of the repository should be used when creating links (optional)
32+
33+
# Add GitHub buttons to your book
34+
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
35+
html:
36+
use_issues_button: true
37+
use_repository_button: true
38+
39+
# Do not parse these files
40+
exclude_patterns: [README.md]

‎docs/_toc.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# https://hpscterrsys.github.io/eCLM_namelist-generator
2+
3+
format: jb-book
4+
root: INDEX
5+
parts:
6+
7+
- caption: User's Guide
8+
chapters:
9+
- file: users_guide/README
10+
title: Scripts for eCLM namelist generation and manipulation
11+
sections:
12+
- file: users_guide/example_site

‎docs/requirements.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
jupyter-book < 2
2+
matplotlib
3+
numpy
4+
ghp-import

0 commit comments

Comments
 (0)