Update documentation for adding a tracer and the tutorial #493
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
tutorial in the appendix.
|
Two sections of the documentation were modified, 5.5 (Adding tracers) and 6.2 (Icepack Tutorial). See the readthedocs link above and please suggest further changes. |
eclare108213
approved these changes
Jul 25, 2024
doc/source/appendices/tutorial.rst
Outdated
|
|
||
| **NOTE:** The file, **doc/source/tutorial/fluff.diff** in the Icepack repository, demonstrates code differences for this fluffball activity as implemented in a version of Icepack from July, 2024. These code difference may not be directly applicable to other code versions, but these diffs provide an example of the typical code differences required to add the tracer, fluff. |
There was a problem hiding this comment.
very minor corrections:
"These code differences..."
"example of the typical code modifications required..."
|
@dabail10 please take a look at this when you have a chance. Thanks! |
dabail10
approved these changes
Jul 29, 2024
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.
PR checklist
Update documentation for adding a tracer and the tutorial
apcraig
No testing done, just documentation changes
Documentation is being update based on the Consortium workshop in 2024. The adding a tracer section has been updated as has the tutorial section related to adding a fluff tracer. An example set of code diffs for the tutorial is also includes as reference.
Closes #489