Skip to content

Conversation

@kaiyuan-cheng
Copy link
Collaborator

@kaiyuan-cheng kaiyuan-cheng commented Jan 9, 2026

This PR adds a splitting supercell case following the DCMIP2016 protocol. The case provides a standardized, well-documented benchmark for validating dynamical core behavior in a deep, moist convective regime.

@giordano giordano added the examples 👩‍🏫 not _everyone_ was born knowing how to use Breeze label Jan 9, 2026
@giordano
Copy link
Collaborator

giordano commented Jan 9, 2026

┌ Error: Generated HTML over size_threshold limit: literated/splitting_supercell.md
│     Generated file size: 16.84 (MiB)
│     size_threshold_warn: 512.0 (KiB)
│     size_threshold:      1.0 (MiB)
│     HTML file:           literated/splitting_supercell/index.html
└ @ Documenter.HTMLWriter /usr/local/share/julia/packages/Documenter/xvqbW/src/html/HTMLWriter.jl:2000

We could increase the threshold, but this suggests the embedded images are large, maybe we can reduce the resolution? An alternative is to try again DisplayAs.PNG, but I know Greg wasn't a fan of that solution.

@giordano
Copy link
Collaborator

giordano commented Jan 9, 2026

Oh, another alternative is to display the PNG images saved to disk, i.e. replace things like

save("supercell_warm_bubble.png", fig) #src
fig

with

save("supercell_warm_bubble.png", fig)
# ![](supercell_warm_bubble.png)

But again, the other PNG images we have seem to be a lot smaller.

@kaiyuan-cheng kaiyuan-cheng marked this pull request as ready for review January 9, 2026 13:41
@giordano
Copy link
Collaborator

giordano commented Jan 9, 2026

The simulation is run in single precision.
@glwagner
Copy link
Member

@kaiyuan-cheng
Copy link
Collaborator Author

Does anyone happen to know why one of the checks has been pending for hours?

@giordano
Copy link
Collaborator

It's not pending, it's a github UI glitch: it's a "required" check, but this PR only touches documentation and we don't run the tests jobs in that case to save resources, so they will never run anyway. The github UI shows the check as "pending" because they don't seem to have a concept of a job which is "required to pass when it runs, but could be skipped", for them "required" is always required to even run.

@kaiyuan-cheng
Copy link
Collaborator Author

It's not pending, it's a github UI glitch: it's a "required" check, but this PR only touches documentation and we don't run the tests jobs in that case to save resources, so they will never run anyway. The github UI shows the check as "pending" because they don't seem to have a concept of a job which is "required to pass when it runs, but could be skipped", for them "required" is always required to even run.

Got it. In this case, how do we merge the PR? Use the command line?

@giordano
Copy link
Collaborator

If this is good to go (it is from my point of view, I don't know if @glwagner has more comments), we can bypass the required check
image

@kaiyuan-cheng
Copy link
Collaborator Author

If this is good to go (it is from my point of view, I don't know if @glwagner has more comments), we can bypass the required check image

Let’s wait to see if @glwagner has any additional comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

examples 👩‍🏫 not _everyone_ was born knowing how to use Breeze

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants