Fix docs #199
Merged
Fix docs #199
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
ceserz2
approved these changes
Nov 11, 2023
LukeSeifert
approved these changes
Nov 30, 2023
doc/methods/reprocessing.rst
Outdated
Comment on lines
10
to
11
| A material flow represents a material with a given | ||
| volume, density, temperature, and nuclide composition. |
There was a problem hiding this comment.
Represents the flow of a material?
doc/methods/reprocessing.rst
Outdated
|
|
||
| a. The mass of the sum is :math:`m_{1+2} = m_{1} + m_{2}` | ||
|
|
||
| b. The composition of the sum is :math:`N_{1+2} = \frac{N_{1} * m_{1} + N_{2} * m_{2}}{m_{1} + m_{2}}` |
There was a problem hiding this comment.
Consider including in the above paragraph if N and m are vectors, scalars, etc.
doc/methods/reprocessing.rst
Outdated
Comment on lines
39
to
40
| 2. An extraction efficiency, :math:`\epsilon`, for target element(s). | ||
| 3. A method to apply the process on a :class:`saltproc.Materialflow` object. |
There was a problem hiding this comment.
Remove periods for consistency with previous lines
doc/methods/reprocessing.rst
Outdated
| SaltProc does not currently track the volume and mass flow rate of waste streams. | ||
| In practice, since it is extremely resource intensive to separate individual | ||
| isotopes, SaltProc only allows extraction efficiencies to be defined for | ||
| elements. So, for any isotope :math:`a` of xenon, |
There was a problem hiding this comment.
You could also mention here that for MSRs, chemical processes operate on elements, so having isotope specific extraction efficiencies is not required
|
@LukeSeifert it's been a hot minute but I just addressed your comments. If this is good to go lmk. |
github-actions bot
pushed a commit
to khurrumsaleem/saltproc
that referenced
this pull request
Feb 26, 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.
Summary of changes
This PR fixes the docs not deploying. This is due to a mismatch between the dependencies of v0.4.0 and earlier versions, and v0.5.0.
This PR also removes unused sections of the theory manual, and fleshes out a mathematical description of reprocessing in SaltProc
Types of changes
Required for Merging
Checklist for Reviewers
Reviewers should use this link to get to the
Review Checklist before they begin their review.