Feature/doc ug - #563
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the SCALE-DG user guide to address Issue #558 by documenting additional physical-process options (MYNN level-2 PBL, simplified radiation, and ocean slab/fixed SST), plus a few layout/formatting tweaks to improve the rendered guide.
Changes:
- Add new UG sections for PBL (MYNN level 2), simplified radiation, and ocean model configuration.
- Add page breaks between physics subsections and relax table float placement to
[htbp]in several sections. - Update the introduction’s physical-process feature list and add a missing citation in the PBL turbulence description.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| doc/user-guide/scale_dg_users_guide.tex | Includes the new physics subsections and adds page breaks between them. |
| doc/user-guide/58_setting_physics_tb.tex | Changes turbulence table float placement to [htbp]. |
| doc/user-guide/58_setting_physics_sf.tex | Changes surface-flux table float placement to [htbp]. |
| doc/user-guide/58_setting_physics_mp.tex | Changes microphysics table float placement to [htbp]. |
| doc/user-guide/58_setting_physics_bl.tex | New PBL (MYNN level 2) user-guide section. |
| doc/user-guide/58_setting_physics_rd.tex | New simplified radiation user-guide section. |
| doc/user-guide/58_setting_physics_ocn.tex | New ocean model (slab/fixed SST) user-guide section. |
| doc/user-guide/11_introduction.tex | Updates feature list to mention new/clarified physical-process options. |
| doc/description/pbl_turbulence.tex | Adds an explicit citation for the MYNN level-2.0 description. |
Suppressed comments (1)
doc/user-guide/scale_dg_users_guide.tex:138
- Same as above: \newpage won’t flush floats, so radiation/surface-flux tables can appear after the next section starts. Prefer \clearpage between these \input blocks if you need hard section breaks with float containment.
\newpage
\input{58_setting_physics_rd}
\newpage
\input{58_setting_physics_sf}
\newpage
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
close #558