Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
87 commits
Select commit Hold shift + click to select a range
a5ca6de
TN: Crops: Convert to Markdown.
samsrabin May 28, 2026
fdc74bf
TN: Crops: Remove CLM history lessons.
samsrabin May 28, 2026
b565241
Crop TN: Mostly avoid mentioning CLM version.
samsrabin May 28, 2026
e1937c8
Crops TN: No "the CLM."
samsrabin May 28, 2026
99d0255
Crops TN: Convert italics to math.
samsrabin May 28, 2026
4729974
Crops TN: Use \times instead of *.
samsrabin May 28, 2026
733d304
UG: Running custom crop cals: Fix cross-ref label.
samsrabin May 28, 2026
aeea5ef
Crops TN: Update sowing window info.
samsrabin May 28, 2026
f4b6c85
Crops TN: Clarify "leaf emergence" phase.
samsrabin May 28, 2026
6bcc857
Crops TN: Simplify reference to maintenance respiration.
samsrabin May 28, 2026
c8de056
Crops TN: Fix typos.
samsrabin May 28, 2026
88116c1
Crops TN: Just refer to fsurdat and flanduse_timeseries docs.
samsrabin May 29, 2026
5d67e39
Crops TN: Add line breaks to Eq 25.4.
samsrabin May 31, 2026
c3cddb4
Crops TN: Clarify logic in Eq. 25.4.
samsrabin May 31, 2026
8da89a4
Crops TN: Relabel Eq. 25.4 to eq-lfemerg-allocations.
samsrabin May 31, 2026
7ab265a
Crops TN: eq-lfemerg-allocations: Change a cdot to a times.
samsrabin May 31, 2026
53a59dc
Crops TN: Reference eq-lfemerg-allocations.
samsrabin May 31, 2026
178b362
Crops TN: Phase-transition HUI threshold symbols now have subscript p…
samsrabin May 31, 2026
39ca4ec
Crops TN: Add math macros for GDD symbols.
samsrabin May 31, 2026
d738079
Crops TN: Use math macros for baset and ztopmx.
samsrabin May 31, 2026
d5dd124
Crops TN: Update maturity requirement section w/ new behavior.
samsrabin May 31, 2026
b5ec5da
Crops TN: Reduce number of blank lines from math macro defs.
samsrabin May 31, 2026
4996d02
Crops TN: Phenology: Delete bit about non-crop PFTs.
samsrabin Jun 1, 2026
cbd7a0b
Crops TN: Improve crop phen params table caption.
samsrabin Jun 1, 2026
1b9e86f
Merge branch 'b4b-dev' into crop-tech-note-6.0
samsrabin Jun 1, 2026
72b847c
Crops TN: Refer to section on landunits and soil cols.
samsrabin Jun 2, 2026
0b65596
Crops TN: Clarify allocation after reaching max LAI.
samsrabin Jun 3, 2026
959b795
Crops TN: New math macro \huigrain.
samsrabin Jun 3, 2026
bbd2386
Crops TN: Better indicate threshold GDD/mat levels.
samsrabin Jun 3, 2026
d4b9bef
More complete and accurate description of HUI threshold for grainfill.
samsrabin Jun 3, 2026
aed8bc8
Crops TN: Fix sentence about tropical param values.
samsrabin Jun 4, 2026
43808d3
Crops TN: crop allocation params table now list-table.
samsrabin Jun 5, 2026
79472cf
Crops TN: Update crop alloc params table values.
samsrabin Jun 5, 2026
4a5bafc
Crops TN: Improve eq on N retransloc
samsrabin Jun 5, 2026
2cf4b53
Crops TN: Alloc params table: Delete unnecessary notes.
samsrabin Jun 5, 2026
9ed249b
Crops TN: Remove a TODO (now on PR).
samsrabin Jun 5, 2026
115d081
Crops TN: Mention declfact param name
samsrabin Jun 5, 2026
e0e6987
Crops TN: Pheno/morph params table now md.
samsrabin Jun 6, 2026
dae312c
Crops TN: Pheno/morph params table: Add variable col.
samsrabin Jun 6, 2026
7d0e1a8
Crops TN: Update crop phenology/morphology table.
samsrabin Jun 7, 2026
2d79c4f
Fix out-of-date submodules.
samsrabin Jun 8, 2026
a515050
Crops TN: Refer to mxmat in text.
samsrabin Jun 8, 2026
58ff7e2
Crops TN: Improve intro.
samsrabin Jun 8, 2026
da67237
Crops TN: Simplify crop PFT table.
samsrabin Jun 8, 2026
bf506e2
Crops TN: Crop PFT table now list-table.
samsrabin Jun 8, 2026
05db816
Crops TN: Mention mergetoclmpft var name.
samsrabin Jun 8, 2026
37c0c35
Crops TN: Define IVT.
samsrabin Jun 8, 2026
56a9153
Crops TN: Explain how to get pure mgd crops.
samsrabin Jun 8, 2026
ad41c56
Crops TN: Mention that trying to enable inactive crops will fail.
samsrabin Jun 8, 2026
99be27f
Crops TN: Fix typo
samsrabin Jun 8, 2026
8618470
Crops TN: Replace some math symbols with monospaced text.
samsrabin Jun 8, 2026
91087f1
Crops TN: Clarify crop food and product pools.
samsrabin Jun 8, 2026
2af8e18
Crops TN: Convert irrig params table to list-table.
samsrabin Jun 8, 2026
a1068bb
Crops TN: Irrig params table: Add param names
samsrabin Jun 8, 2026
1ff581c
Crops TN: grnfill alloc eqn: Split into 'organ', repr.
samsrabin Jun 8, 2026
a6aba2a
Crops TN: Define fracthrugrnfill math macro.
samsrabin Jun 8, 2026
17f5d9a
Crops TN: Rearrange and relabel eqn about leaf/stem alloc in grnfill.
samsrabin Jun 8, 2026
a3fdb49
Crops TN: Use subscript for C3 and C4.
samsrabin Jun 8, 2026
0023bc8
Crops TN: "Enabling the inactive crop PFTs" warning now admonition.
samsrabin Jun 8, 2026
a46d8e2
Crops TN: Crop PFT table: Clarify unmanaged vs managed"
samsrabin Jun 8, 2026
f68906f
Crops TN: Clarify unmanaged crops not USUALLY simulated.
samsrabin Jun 9, 2026
9a218db
Docs: Add setting disclaimer substitution strings.
samsrabin Jun 9, 2026
9a4434e
Crops TN: Add disclaimer to parameter tables.
samsrabin Jun 9, 2026
d370031
Crops TN: Clarify "functional form."
samsrabin Jun 9, 2026
5372828
Crops TN: Always say "stem," not "live stem."
samsrabin Jun 9, 2026
d198657
Crops TN: Remove ref to a table row number.
samsrabin Jun 10, 2026
a3cca82
Crops TN: Clarify a sentence
samsrabin Jun 10, 2026
b825a75
Crops TN: Align lfemerg alloc eqn.
samsrabin Jun 10, 2026
0d835bf
Crops TN: Explain 48 in equation.
samsrabin Jun 10, 2026
e39c05e
Crops TN: Fix min/max in GDD per-timestep eqn.
samsrabin Jun 10, 2026
7d479a1
Crops TN: Consistently use _Miscanthus_.
samsrabin Jun 10, 2026
73b0fbd
Crops TN: Make some var names literals.
samsrabin Jun 10, 2026
246d9d7
Crops TN: Align an equation.
samsrabin Jun 11, 2026
89f9706
Crops TN: Simplify lat variation in base T.
samsrabin Jun 11, 2026
bb2ee53
Update doc-builder: build_docs_to_publish now gets --verbose option
samsrabin Jun 18, 2026
53b1ed3
docs-update-dependency-common.yml: Work with act.
samsrabin Jun 18, 2026
f5fa4c8
test_container_eq_ctsm_pylib.sh: Verbose.
samsrabin Jun 18, 2026
8980963
Use doc-building container from doc-builder.
samsrabin Jun 19, 2026
1ea9683
tools/contrib/preview_docs_pr now at doc/doc-builder/tools/preview_do…
samsrabin Jun 19, 2026
547e259
ts: test-build-docs-container now verbose
samsrabin Jun 19, 2026
556b4e6
doc-builder: Fix build_commands.py image version
samsrabin Jun 19, 2026
a63dc2f
Update doc-builder to official v3.5.1.
samsrabin Jun 19, 2026
89da872
python-tests.yml: Check out doc-builder.
samsrabin Jun 19, 2026
5dd0614
ts: All docs tests now verbose.
samsrabin Jun 19, 2026
1dbead0
Fix doc-builder path in conda_env_ctsm_py.yml.
samsrabin Jun 19, 2026
ed94539
test_container_eq_ctsm_pylib.sh: Avoid needing doc-builder/test/conf.py.
samsrabin Jun 19, 2026
080b958
doc/test/test_build_docs_-r-v.sh: Avoid using doc-builder/test/conf.py.
samsrabin Jun 19, 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
86 changes: 0 additions & 86 deletions .github/workflows/docker-image-build-publish.yml

This file was deleted.

28 changes: 0 additions & 28 deletions .github/workflows/docker-image-build.yml

This file was deleted.

97 changes: 0 additions & 97 deletions .github/workflows/docker-image-common.yml

This file was deleted.

72 changes: 0 additions & 72 deletions .github/workflows/docker-image-get-version.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/docs-build-and-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ jobs:
id: build-docs
run: |
cd doc
./build_docs_to_publish -d --site-root https://escomp.github.io/CTSM
./build_docs_to_publish -d --site-root https://escomp.github.io/CTSM --verbose

- name: Upload artifact
uses: actions/upload-pages-artifact@0252fc4ba7626f0298f0cf00902a25c6afc77fa8 # v3
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/docs-common.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,13 @@ jobs:
uses: actions/cache@2f8e54208210a422b2efd51efaa6bd6d7ca8920f # v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('doc/ctsm-docs_container/requirements.txt') }}
key: ${{ runner.os }}-pip-${{ hashFiles('doc/doc-builder/doc-build-container/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install Python requirements
if: ${{ ! inputs.use_conda }}
run: |
pip install -r doc/ctsm-docs_container/requirements.txt
pip install -r doc/doc-builder/doc-build-container/requirements.txt

# Do this if using conda
- name: Set up conda environment
Expand All @@ -73,7 +73,7 @@ jobs:
if: success() || failure()
run: |
if ${{ inputs.use_conda }}; then
cd doc && conda run -n ${{ inputs.conda_env_name }} ./build_docs -b ${PWD}/_build -c
cd doc && conda run -n ${{ inputs.conda_env_name }} ./build_docs -b ${PWD}/_build -c --verbose
else
cd doc && ./build_docs -b ${PWD}/_build -c
cd doc && ./build_docs -b ${PWD}/_build -c --verbose
fi
4 changes: 2 additions & 2 deletions .github/workflows/docs-update-ctsm_pylib.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ on:
branches: ['*']
paths:
- 'python/conda_env_ctsm_py.txt'
- 'doc/ctsm-docs_container/requirements.txt'
- 'doc/doc-builder'
- '.github/workflows/docs-common.yml'
- '.github/workflows/docs-update-dependency-common.yml'

pull_request:
# Run on pull requests that change the listed files
paths:
- 'python/conda_env_ctsm_py.txt'
- 'doc/ctsm-docs_container/requirements.txt'
- 'doc/doc-builder'
- '.github/workflows/docs-common.yml'
- '.github/workflows/docs-update-dependency-common.yml'

Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/docs-update-dependency-common.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ jobs:

# Don't run on forks, because test_container_eq_ctsm_pylib.sh uses
# build_docs_to_publish, which will look for branch(es) that forks
# may not have
# may not have.
# To run locally with `act`, include `--env GITHUB_REPOSITORY=ESCOMP/CTSM` in the call.
if: ${{ github.repository == 'ESCOMP/CTSM' }}

runs-on: ubuntu-latest
Expand All @@ -44,6 +45,7 @@ jobs:
environment-file: ${{ inputs.conda_env_file }}
channels: conda-forge
auto-activate-base: false
miniconda-version: "latest"

- name: Compare docs built with container vs. ctsm_pylib
run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ jobs:
run: |
set -o pipefail
mkdir -p build-logs
cd doc && PYTHONUNBUFFERED=1 ./build_docs -b ${PWD}/_build -c -d 2>&1 | tee >(sed -E $'s/\x1b\\[[0-9;]*[a-zA-Z]//g' > "${GITHUB_WORKSPACE}/build-logs/build.log")
cd doc && PYTHONUNBUFFERED=1 ./build_docs -b ${PWD}/_build -c -d --verbose 2>&1 | tee >(sed -E $'s/\x1b\\[[0-9;]*[a-zA-Z]//g' > "${GITHUB_WORKSPACE}/build-logs/build.log")
# The tee writes build.log for the PR comment (posted by docs-pr-failure-post-comment.yml); the inner sed strips ANSI color codes that would otherwise render as garbage in the comment.
# PYTHONUNBUFFERED=1 because otherwise the teed log will be out of order

Expand Down
8 changes: 8 additions & 0 deletions .github/workflows/python-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ jobs:
# Checkout the code
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: Check out doc-builder, which has a requirements.txt we need
run: |
bin/git-fleximod update doc-builder

# Set up the conda environment
- uses: conda-incubator/setup-miniconda@2defc80cc6f4028b1780c50faf08dd505d698976 # v3
with:
Expand All @@ -44,6 +48,10 @@ jobs:
# Checkout the code
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: Check out doc-builder, which has a requirements.txt we need
run: |
bin/git-fleximod update doc-builder

# Set up the conda environment
- uses: conda-incubator/setup-miniconda@2defc80cc6f4028b1780c50faf08dd505d698976 # v3
with:
Expand Down
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ fxDONOTUSEurl = https://github.com/ESMCI/mpi-serial
[submodule "doc-builder"]
path = doc/doc-builder
url = https://github.com/ESMCI/doc-builder
fxtag = v3.2.1
fxtag = v3.5.1
fxrequired = ToplevelOptional
# Standard Fork to compare to with "git fleximod test" to ensure personal forks aren't committed
fxDONOTUSEurl = https://github.com/ESMCI/doc-builder
Loading
Loading