Skip to content
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

Run Examples on GPU for Documentation #104

Merged
merged 781 commits into from
Aug 13, 2024

Conversation

simone-silvestri
Copy link
Collaborator

@simone-silvestri simone-silvestri commented Jul 24, 2024

This PR is just a test to check that the documentation build triggers correctly on the GPU on the Caltech cluster and the results are literated correctly.

The setup now is that the documentation build without examples runs through github actions every commit while the documentation with examples runs every commit when the label Generate docs is attached (and stops running if we remove the label) and (should) run every time the PR is merged.

thanks @Sbozzolo for helping with the setup

preview here: https://clima.github.io/ClimaOceanDocumentation/previews/PR104/

simone-silvestri and others added 30 commits June 10, 2024 20:21
Co-authored-by: Gregory L. Wagner <wagner.greg@gmail.com>
Co-authored-by: Gregory L. Wagner <wagner.greg@gmail.com>
Co-authored-by: Gregory L. Wagner <wagner.greg@gmail.com>
Co-authored-by: Gregory L. Wagner <wagner.greg@gmail.com>
Comment on lines +85 to +89
# - CATKE turbulence closure for vertical mixing, see [`CATKEVerticalDiffusivity`](@ref)
# - WENO-based advection scheme for momentum in the vector invariant form, see [`WENOVectorInvariant`](@ref)
# - WENO-based advection scheme for tracers, see [`WENO`](@ref)
# - `SplitExplicitFreeSurfaceSolver` with 75 substeps, see [`SplitExplicitFreeSurface`](@ref)
# - TEOS-10 equation of state, see [`TEOS10EquationOfState`](@ref)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the docs refs here (i.e. (@ref)) won't work because they mean to point to the docs of Oceananigans which is a different package.

@simone-silvestri simone-silvestri merged commit 41aa1e4 into main Aug 13, 2024
10 checks passed
@simone-silvestri simone-silvestri deleted the ss/documentation-on-caltech branch August 13, 2024 23:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build docs Add this label to built the docs in a PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants