Update unit test docs #1690
Merged
Update unit test docs #1690
+215
−110
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
this syncs up with Castro
zhichen3
reviewed
Jan 6, 2025
Docs/source/one_zone_tests.rst
Outdated
| \begin{align*} | ||
| \frac{dX_k}{dt} &= \dot{\omega}_k(\rho, X_k, T) \\ | ||
| \frac{de}{dt} &= f(\rho, X_k, T) |
There was a problem hiding this comment.
I think we want to use epsilon notation now.
Docs/source/one_zone_tests.rst
Outdated
| .. note:: | ||
|
|
||
| Since the energy evolves due to the heat release (or loss) | ||
| from reactions, the temperature will change during the burn. |
There was a problem hiding this comment.
maybe we should also mention temperature evolution can be optionally disabled via integrator.call_eos_in_rhs=0 to offer more flexibility for users to explore the difference.
zhichen3
approved these changes
Jan 6, 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.
The
burn_celldocs were very out of date. This makes them accurate and alsoadds a new plot script for looking at the output. It also removes the unused prefix
from the test's parameters and removes an old
matplotlibrcfile.