Remove TC1 from docs examples. #62
Merged
Conversation
This file contains 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
|
bors r+ |
bors bot
added a commit
that referenced
this pull request
Aug 2, 2022
75: Sea Breeze Tutorial Docs r=LenkaNovak a=jb-mackay ## Purpose and Content This PR will turn the sea breeze test case into a tutorial to be included in the docs. This replaces tc1 which was removed in #62. The sea breeze driver, README, and all files included in the driver should be documented and included as tutorial pages. ## Benefits and Risks This tutorial should clearly and concisely explain and demonstrate the different parts of the ClimaCoupler interface as well as how to set up a coupled simulation. It should be straightforward to add docs as the interface is enhanced. ## Linked Issues - Closes #63 ## PR Checklist - [x] This PR has a corresponding issue OR is linked to an SDI. - [x] I have followed CliMA's codebase [contribution](https://clima.github.io/ClimateMachine.jl/latest/Contributing/) and [style](https://clima.github.io/ClimateMachine.jl/latest/DevDocs/CodeStyle/) guidelines OR N/A. - [x] I have followed CliMA's [documentation policy](https://github.com/CliMA/policies/wiki/Documentation-Policy). - [x] I have checked all issues and PRs and I certify that this PR does not duplicate an open PR. - [x] I linted my code on my local machine prior to submission OR N/A. - [x] Unit tests are included OR N/A. - [x] Code used in an integration test OR N/A. - [x] All tests ran successfully on my local machine OR N/A. - [x] All classes, modules, and function contain docstrings OR N/A. - [x] Documentation has been added/updated OR N/A. Co-authored-by: Ben Mackay <[email protected]>
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.
Purpose and Content
Removes tc1 (heat equation + slab) from the docs as it now breaks. It should be replaced by the sea breeze which is cleaner, uses ClimaCoupler, and is checked by buildkite.
PR Checklist