rework the unit test docs #1570
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
|
this is ready for review. |
yut23
reviewed
Jul 15, 2024
Comment on lines
+67
to
+103
| For each of the ``numsteps`` steps defined in the inputs | ||
| file, the code will output a files into a new directory titled | ||
| ``run_prefix_output`` where ``run_prefix`` is the run prefix defined in the | ||
| inputs file. Each output file will be named using the run prefix | ||
| defined in the inputs file and the corresponding timestep. | ||
|
|
||
| Next, run ``burn_cell.py`` using python 3.x, giving the defined run prefix as an argument. | ||
| For example:: | ||
|
|
||
| python3 burn_cell.py react_aprox13 | ||
|
|
||
| The ``burn_cell.py`` code will gather information from all of the | ||
| output files and compile them into three graphs explained below. | ||
|
|
||
| Graphs Output by ``burn_cell.py`` | ||
| --------------------------------- | ||
|
|
||
| The file ``run-prefix_logX.png`` and ``run-prefix_logX.eps`` will display a | ||
| graph of the chemical abundances as a function of the time, both on | ||
| logarithmic scales, for all species involved in the simulation. An | ||
| example of this graph is shown below. | ||
|
|
||
| .. figure:: react_aprox13_logX.png | ||
| :alt: An example of a plot output by the burn_cell unit test. This is the logX output corresponding to the network aprox13. | ||
| :width: 4.5in | ||
|
|
||
| An example of a plot output by the burn_cell unit test. This is the | ||
| logX output corresponding to the network aprox13. | ||
|
|
||
|
|
||
|
|
||
| The file ``run-prefix_ydot.png`` and ``run-prefix_ydot.eps`` will display the | ||
| molar fraction (mass fraction / atomic weight) as a function of time, | ||
| both on logarithmic scales, for all species involved in the code. | ||
|
|
||
| The file ``run-prefix_T-edot.png`` and ``run-prefix_T-edot.eps`` will display | ||
| the temperature and the energy generation rate as a function of time. |
There was a problem hiding this comment.
This is all for the old Fortran burn_cell; we should mention state_over_time.txt instead
There was a problem hiding this comment.
yeah, I just moved the burn_cell docs and didn't update them, since we also need to update the README. I was thinking of that as a separate PR / maybe for the hackathon
| +-----------------------+----------------------------------------+ | ||
| | ``temperature`` | State Temperature (K) | | ||
| +-----------------------+----------------------------------------+ | ||
| | ``massfractions(i)`` | Mass Fraction for element i | |
There was a problem hiding this comment.
This should be something like Xi instead
| asks for so that the user does not have to input all 5+ | ||
| parameters that are required every time the test is run. Each input | ||
| required is defined and initialized on the lines following | ||
| ``&cellparams``. The use of the parameters is show below: |
There was a problem hiding this comment.
We should remove the Fortran references here
Co-authored-by: Eric T. Johnson <yut23@users.noreply.github.com>
Co-authored-by: Eric T. Johnson <yut23@users.noreply.github.com>
yut23
approved these changes
Jul 15, 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.
We split the current page into 3 separate pages and add descriptions for all of the unit tests