-
Notifications
You must be signed in to change notification settings - Fork 168
[main] ccpp-physics SciDocs to github pages #1207
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
Merged
Merged
Changes from 143 commits
Commits
Show all changes
155 commits
Select commit
Hold shift + click to select a range
a0f17b5
add doxygen action
mzhangw 55af499
minor changes
mzhangw 1b04bbb
minor changes
mzhangw 5c382be
minor changes
mzhangw 14c12a2
doxy only
mzhangw 6e6251f
Create main.yml
mzhangw 88c42d8
Create jekyll-gh-pages.yml
mzhangw 3bc16e7
change
mzhangw e213b4f
add doxyfile into wkfl
mzhangw 173a0a2
Update doxygen.yml
mzhangw 639e095
Update doxygen.yml
mzhangw 65ff7c5
Update doxygen.yml
mzhangw 0153ff9
Update doxygen.yml
mzhangw 4eaf41c
Update doxygen.yml
mzhangw 0fb88e9
Update doxygen.yml
mzhangw 310afbf
Update doxygen.yml
mzhangw 7efd81d
Update doxygen.yml
mzhangw f926b72
Update doxygen.yml
mzhangw 94bb4aa
Update doxygen.yml
mzhangw 2d643c9
Update doxygen.yml
mzhangw 8d3cbea
Update doxygen.yml
mzhangw d706260
Update ccpp_doxyfile
mzhangw 86bfbf3
Update ccpp_doxyfile
mzhangw 41c0a24
update ccpp doxyfile
mzhangw f33cc26
Update doxygen.yml
mzhangw 00675dd
update doxyfile
mzhangw 4cc5c34
Merge branch 'dox' of https://github.com/mzhangw/ccpp-physics into dox
mzhangw a01a78c
Update doxygen.yml
mzhangw e16205e
Update doxygen.yml
mzhangw 9b66245
update doxyfile
mzhangw 53eef3b
Update doxygen.yml
mzhangw 6df1bb3
Update doxygen.yml
mzhangw 3d47ce1
Update doxygen.yml
mzhangw 1d07030
Update doxygen.yml
mzhangw 176fe1e
Update doxygen.yml
mzhangw 1faec18
Update doxygen.yml
mzhangw 7085923
Update doxygen.yml
mzhangw 6cb2d89
Update doxygen.yml
mzhangw 47194cc
Update doxygen.yml
mzhangw c72cd1c
Update doxygen.yml
mzhangw ecc2800
Update doxygen.yml
mzhangw fc5bce8
Update doxygen.yml
mzhangw 1c7c894
Update doxygen.yml
mzhangw b86f88d
Update doxygen.yml
mzhangw 1c4915c
Update doxygen.yml
mzhangw 215530d
Update doxygen.yml
mzhangw 172a54e
Update doxygen.yml
mzhangw 18ce313
Update doxygen.yml
mzhangw b28864c
Update doxygen.yml
mzhangw 1d8385c
Update doxygen.yml
mzhangw 33208f2
Update doxygen.yml
mzhangw 1d84e14
Update doxygen.yml
mzhangw d92218b
Update doxygen.yml
mzhangw eef0f52
Update doxygen.yml
mzhangw da49569
change path
mzhangw a3b4725
Merge branch 'dox' of https://github.com/mzhangw/ccpp-physics into dox
mzhangw ff53895
add mactex
mzhangw 117d82e
add mactex
mzhangw 213f61f
minor changes
mzhangw 724e40b
minor fix
mzhangw 40035aa
try1
mzhangw c8afcc5
try1
mzhangw 0095d8d
try2
mzhangw ecd6dcb
updates
mzhangw 594fbeb
update perl
mzhangw f408aa2
update perl
mzhangw bdc1673
update path
mzhangw f79ebeb
explicitly install
mzhangw fc55094
updates
mzhangw 20c1621
updates
mzhangw 8cee5bc
fix
mzhangw ef9ffa4
fix path
mzhangw 6b58aef
fix
mzhangw c2501d1
fix path
mzhangw 12ad2ba
fixes
mzhangw 84689f2
fix3
mzhangw 0368f65
cleanup
mzhangw 2e51931
restore yml files
mzhangw 0e19c22
hsd updates
hertneky 6c2ec9c
add doxygen.yml
hertneky b1bac39
update branch
hertneky af7558b
update wflw
hertneky b785d2a
test
hertneky 86d8793
fix
hertneky e9feb6a
fix
hertneky 94a0ff9
fix
hertneky 7172491
fix
hertneky 1bf1730
rearrange steps
hertneky 78d7e8e
oops
hertneky 60ea395
.
hertneky e461b53
debug
hertneky 7fba6de
chng dir
hertneky 4a96302
chng dir
hertneky cd90715
chng dir
hertneky 2c39d6f
-landing page
hertneky 80dab08
-update para
hertneky cd5ba76
Merge branch 'main' into dox
grantfirl 1e119cc
try to add a backlink, fix typo
hertneky 5dc4dd7
fix css link
hertneky 5d4737e
link path
hertneky be5473c
try cp stylesheet
hertneky 98a74a1
Add CCPP website
hertneky f599543
fix
hertneky cc47a33
add SRW build, backlink
hertneky cb2b80f
try mainpage
hertneky 06e68c0
changes for mainpage
hertneky 8c7544e
mainpage config
hertneky ac49952
mainpage config
hertneky ba42b4e
mainpage config
hertneky 96a4d68
mainpage debug
hertneky 5883cc1
mainpage debug
hertneky 7ff2b7c
mainpage debug
hertneky 9dd220d
mainpage debug
hertneky 098b5de
mainpage debug
hertneky ec611d5
fix landing page sidebar.
hertneky 5a58b7d
fix landing page sidebar.
hertneky 1d09c10
fix landing page sidebar.
hertneky 3c37027
fix landing page sidebar.
hertneky d912293
style updates
hertneky f01287d
mainpage style
hertneky 00eed98
mainpage style
hertneky f2a713a
hide tree on mainpage
hertneky e1b526b
add back tree
hertneky e432082
try adding backlink
hertneky 78fb90f
add backlink to other pages
hertneky f0e5060
Merge branch 'NCAR:main' into scidocs_hsd_aqua
hertneky d28777c
Merge branch 'dox' into scidocs_hsd_aqua
hertneky a624d42
updates migrated from mzhangw
hertneky d092755
fix missed conflicts
hertneky f22c3bc
fix syntax
hertneky 4e43da1
run workflow on this branch
hertneky 4f1a057
remove branch from workflow run, update doxyfile
hertneky ef9f649
mods to mainpag dxy
hertneky 95185d7
updates
hertneky 881e38b
try update for v7 arg table
hertneky c1004c3
turn on scidoc branch for deploy
hertneky 03d5aa7
recurse checkout
hertneky 86c574e
fix directory
hertneky 0062a12
try fix
hertneky 101589c
update landing page with acknowledgements
hertneky 8db1ce7
fix path
hertneky 046c999
fix path
hertneky 8990175
debug
hertneky 18caebf
add prebuild_config for building tables
hertneky b928539
fix
hertneky e6c62d5
debug
hertneky ba10b09
debug
hertneky 4c4cba1
restructure workflow to work with metadata2html.py
hertneky edadacc
add remaining prebuild configs
hertneky 35716f0
attempt fix srwv3 checkout
hertneky 8bd358c
fix main checkout for landing page, stash prebuild configs
hertneky f215093
fix syntax
hertneky 1a82574
update prebuild location
hertneky b0b86d2
workflow updates
hertneky cdb1b8a
point to NCAR/main
hertneky File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| name: Doxygen GitHub Pages Deploy Action | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| - scidocs_hsd_aqua | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| deploy: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| pages: write | ||
| id-token: write | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
|
|
||
| steps: | ||
|
|
||
| - name: Checkout current ccpp-physics code | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| submodules: recursive | ||
|
|
||
| - name: Install Doxygen + Graphviz + LaTeX | ||
| run: | | ||
| sudo apt-get update | ||
| sudo apt-get install -y doxygen graphviz perl texlive-latex-base texlive-latex-extra texlive-fonts-recommended texlive-bibtex-extra | ||
|
|
||
| - name: Verify installations | ||
| run: | | ||
| which perl | ||
| which bibtex | ||
| doxygen --version | ||
|
|
||
| - name: Build HSD docs | ||
| run: | | ||
| cd physics/docs | ||
| doxygen ccpphsd_doxyfile | ||
|
|
||
| - name: Checkout SCM V7 | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| repository: NCAR/ccpp-scm | ||
| ref: v7.0.1 | ||
| path: scm_repo | ||
| submodules: recursive | ||
|
|
||
| - name: Generate metadata tables (SCM V7) | ||
| run: | | ||
| pwd | ||
| cd scm_repo | ||
| ls | ||
|
|
||
| export PYTHONPATH=$(pwd)/ccpp/framework/scripts:$(pwd)/ccpp/framework/scripts/parse_tools | ||
|
|
||
| ./ccpp/framework/scripts/metadata2html.py -c ccpp/config/ccpp_prebuild_config.py | ||
|
|
||
| mkdir -p ccpp/physics/physics/docs/html/V7 | ||
| mv ccpp/physics/physics/docs/*.html ccpp/physics/physics/docs/html/V7 | ||
|
|
||
| - name: Build V7 docs | ||
| run: | | ||
| cd scm_repo/ccpp/physics/physics/docs | ||
| doxygen ccpp_doxyfile | ||
| mv doc/html/* html/V7/ | ||
|
|
||
| - name: Checkout ufs-community SRWv3 branch | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| repository: ufs-community/ccpp-physics | ||
| ref: release/srw-v3 | ||
| path: srw_repo | ||
| submodules: recursive | ||
|
|
||
| - name: Build SRWv3 docs | ||
| run: | | ||
| cd srw_repo/physics/docs | ||
| doxygen ccppsrw_doxyfile | ||
| mkdir -p ../../../physics/docs/html/SRWv3 | ||
| mv doc/html/* ../../../physics/docs/html/SRWv3/ | ||
|
|
||
| - name: Checkout main branch again for landing page | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| ref: scidocs_hsd_aqua | ||
| path: main_repo | ||
|
|
||
| - name: Build landing page | ||
| run: | | ||
| cd main_repo/physics/docs | ||
| doxygen mainpage_doxyfile | ||
| cp -r html/* $GITHUB_WORKSPACE/physics/docs/html/ | ||
|
|
||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v5 | ||
|
|
||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| with: | ||
| path: physics/docs/html | ||
|
|
||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/[email protected] |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # CCPP Physics Scientific Documentation | ||
|
|
||
| The Common Community Physics Package (CCPP) provides scientific documentation for the physics suites and parameterizations used across a variety of atmospheric modeling applications. The documentation describes the scientific basis, configuration options, and implementation details for the parameterizations included in the CCPP physics suites for different modeling systems and use cases. | ||
|
|
||
| - [CCPP Physics V7.0.0 Scientific Documentation](./V7/) | ||
| - [CCPP Physics UFS Hierarchical System Development (HSD) Scientific Documentation](./HSD/) | ||
| - [CCPP Physics SRW v3.0.0 Scientific Documentation](./SRWv3/) | ||
|
|
||
| For more information about the CCPP including Release Information, Technical Documentation, and Code, please visit the | ||
| <a href="https://dtcenter.org/community-code/common-community-physics-package-ccpp" target="_blank">CCPP website</a>, hosted by the Developmental Testbed Center (DTC). | ||
|
|
||
| ## Acknowledgements | ||
|
|
||
| CCPP team would like to express our deepest gratitude for UFS physics developers' contribution to the | ||
| development of CCPP-Physics. | ||
| \n We would also like to give special thanks to: | ||
|
|
||
| - \b NOAA \b NWS \b Environmental \b Modeling \b Center | ||
| - \b NOAA \b OAR \b Global \b Systems \b Laboratory | ||
| - \b NOAA \b OAR \b Physical \b Sciences \b Laboratory | ||
| - \b NOAA \b OAR \b National \b Severe \b Storms \b Laboratory | ||
| - \b NOAA \b OAR \b Atlantic \b Oceanographic \b & \b Meteorological \b Laboratory | ||
| - \b Atmospheric \b and \b Environmental \b Research, \b Inc. | ||
| - \b Joint \b Center \b for \b Satellite \b Data \b Assimilation | ||
| - \b NASA \b Goddard \b Space \b Flight \b Center | ||
| - \b U.S. \b Naval \b Research \b Laboratory | ||
| - \b NOAA \b OAR \b Geophysical \b Fluid \b Dynamics \b Laboratory | ||
|
|
||
| for their support and contribution for this CCPP scientific documentation (SciDoc). | ||
| \n Thanks also to the CCPP SciDoc Team at the Developmental Testbed Center: Man Zhang, Ligia Bernardet, Mike Kavulich, and Tracy Hertneky. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.