-
Notifications
You must be signed in to change notification settings - Fork 319
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.
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
[WIP] Add hillslope scripts (to python/ctsm/) and external, plus docs #2425
base: b4b-dev
Are you sure you want to change the base?
Conversation
* -i/--input-file * -o/--output-file * --overwrite
This can move forward now that #2434 is done. |
# Conflicts: # .git-blame-ignore-revs # .gitignore # Externals.cfg
* Treats Sphinx warnings as errors (see also PR at ESMCI/doc-builder#4) * Points at my Docker container, which includes Python package needed for mdinclude in .rst files
Updated README.
[submodule "representative-hillslopes"] | ||
path = tools/external/representative-hillslopes | ||
url = https://github.com/samsrabin/Representative_Hillslopes | ||
fxtag = 2126ffe018b2268ed479469421763cbb45d9c264 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Change this to Sean's repo, not my fork. Waiting on Improvements to shell_scripts/README.md swensosc/Representative_Hillslopes#6.
url = https://github.com/ESMCI/doc-builder | ||
fxtag = v1.0.8 | ||
url = https://github.com/samsrabin/doc-builder | ||
fxtag = c51795f65d230803418c932bfd8639c85c33a19a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Change this back to ESMCI repo, not my fork. Waiting on updates there that (a) treat sphinx warnings as errors and (b) point to an updated version of the
escomp/base
container that includessphinx-mdinclude
(see this comment).
I think the problem with the test builds at this point is that I need to manually do diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index f8d7b4962..20927f776 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -42,7 +42,7 @@ jobs:
# Build documentation under ${PWD}/_build
- name: Build Sphinx docs with makefile
run: |
- make SPHINXOPTS="-W --keep-going" BUILDDIR=${PWD}/_build -C doc/ html
+ bin/git-fleximod update -o && make SPHINXOPTS="-W --keep-going" BUILDDIR=${PWD}/_build -C doc/ html
test-doc-builder:
if: ${{ always() }}
@@ -71,4 +71,4 @@ jobs:
# Build documentation under ${PWD}/_build
- name: Build Sphinx docs with doc-builder
run: |
- cd doc && ./build_docs -b ${PWD}/_build -c
+ bin/git-fleximod update -o && cd doc && ./build_docs -b ${PWD}/_build -c
|
b6145b0
to
61122a2
Compare
By renaming some of the test hillslope gridcell files, this tests the scripts' ability to handle (a) multiple gridcells per chunk and (b) missing chunks.
Work in progress! Do not review! At risk of force pushes!
Description of changes
Sean Swenson has various scripts related to making files/variables for use in hillslope runs. Some of these are not CTSM-specific, so they're in a separate Representative_Hillslopes repo. Some are CTSM-specific, though, so this PR will add those to
python/ctsm/
. It also adds the Representative_Hillslopes repo as an optional external to CTSM.Also adds the ability to include Markdown files natively in .rst files, making the following easier and/or more valuable to tackle:
- #1718
- #2753
- #2761
- #2771
However, it does that by pointing to a new version of the Docker container that I made. This is only temporary while I wait for @briandobbins to update the
escomp/base
container withsphinx_mdinclude
. If that's not ready in time, I'll change any suchmdinclude
s back toinclude
s. Otherwise,escomp/base
.Replaces PR #2401, which I couldn't get to rebase properly.
Specific notes
Contributors other than yourself, if any: Sean Swenson (@swensosc)
CTSM Issues Fixed (include github issue #):
Are answers expected to change (and if so in what way)? No
Any User Interface Changes (namelist or namelist defaults changes)? No
Testing performed, if any: None so far.
Remaining work
combine_chunk_files
synthetic_hillslope
hillslope_file
instead offsurdat