How to guide dt and integration scheme #2438
Merged
Conversation
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
Member
erikvansebille
left a comment
erikvansebille
left a comment
There was a problem hiding this comment.
Great notebook! A few suggestions below
| <!-- examples/tutorial_kernelloop.ipynb --> | ||
|
|
||
| ```{toctree} | ||
| :caption: Run a simulation |
Member
There was a problem hiding this comment.
The other sections start with a How-to guide (with a book emoji), this one doesn't. Is that a problem?
Contributor
Author
There was a problem hiding this comment.
I think it’s not a problem; explanations (with the book emoji) should only exist for more complicated components that benefit from background reading. For “Create ParticleSets” and “Run a simulation” I think the “Parcels conceptual workflow” is a sufficient explanation.
for more information, see https://pre-commit.ci
This was referenced Dec 19, 2025
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.
This PR adds a guide describing how to choose an appropriate dt and integration scheme. It is based on @michaeldenes notebook from the 10-years Parcels event.
The basics of how to write a custom kernel are now in the Parcels conceptual workflow explanation, and I have added a bit more text and figures to help users decide what to consider in their simulation setup. @michaeldenes I am mainly interested in your thoughts on how detailed this should be and how to generalize the advice we can give in this guide. Curious to hear what you think!