Adds Preliminary Documentation for ASM2d-GHG #1598
Open
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
lbianchi-lbl
added
documentation
adam-a-a
reviewed
Jul 9, 2025
adam-a-a
reviewed
Jul 9, 2025
adam-a-a
reviewed
Jul 9, 2025
adam-a-a
reviewed
Jul 9, 2025
adam-a-a
reviewed
Jul 9, 2025
adam-a-a
reviewed
Jul 9, 2025
adam-a-a
reviewed
Jul 9, 2025
adam-a-a
reviewed
Jul 9, 2025
adam-a-a
reviewed
Jul 9, 2025
Contributor
|
Are there differences between documentation here and in #1605 ? |
Contributor
Author
MarcusHolly
commented
Aug 28, 2025
Comment on lines
+120
to
+123
| "Fraction of inert COD from lysis", ":math:`f_{XI}`", "f_XI", 0.1, ":math:`\text{dimensionless}`" | ||
| "Fraction of inert COD from lysis", ":math:`f_{XIH}`", "f_XIH", 0.1, ":math:`\text{dimensionless}`" | ||
| "Fraction of inert COD from lysis", ":math:`f_{XIP}`", "f_XIP", 0.1, ":math:`\text{dimensionless}`" | ||
| "Fraction of inert COD from lysis", ":math:`f_{XIA}`", "f_XIA", 0.1, ":math:`\text{dimensionless}`" |
Contributor
Author
There was a problem hiding this comment.
@adam-a-a Just to provide a bit of context here, these are actually not mistranslations - the c-code provides the same description for all of these variables (f_XI is technically blank, but this description can be seen in other files). Nevertheless, we prob should add some descriptor to clearly distinguish these parameters from one another
Contributor
|
Moving this to the Dec release board. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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/Motivation:
Adds preliminary documentation for the ASM2d-GHG property and reaction package that will be developed in the near future.
Changes proposed in this PR:
Legal Acknowledgement
By contributing to this software project, I agree to the following terms and conditions for my contribution: