Merged
Conversation
Member
Author
|
Requesting @decaluwe's review specifically for the updates to the "species thermo" and "standard state" docs. |
Member
|
Thanks @speth --will get to it! Excited to see this come through (and wish I had done more to help get it there). |
5 tasks
bryanwweber
reviewed
Dec 25, 2023
Member
bryanwweber
left a comment
bryanwweber
left a comment
There was a problem hiding this comment.
Thanks for all this work @speth! I'm probably not going to have time to review this all again, so please feel free to incorporate or discard these comments at your discretion. If you have any questions, I'm happy to help clarify 😸
decaluwe
reviewed
Jan 4, 2024
Member
decaluwe
left a comment
decaluwe
left a comment
There was a problem hiding this comment.
Thanks @speth for this massive undertaking. I've added a number of thoughts. The two most relevant:
- The phase thermo sections have a lot less detail than the kinetics sections. I think my preference would be to get this merged before adding more on top, but if you'd rather add it in now (assuming you want to at all), lmk and I can help.
- The reference vs. standard state. I added some thoughts to tune the wording. Long term, I think we can get rid of the non-standard use of standard state in RedlichKwong and PengRobinson, assuming I am correct that they are the only two that use it. In those two is it just a minor mathematical convenience and can be pretty easily removed/adjusted. That said I do like "reference state" better than "standard state," generally, since a little digging shows that there is no single "standard" that applies across fields. The user provided info really is just a reference: "We know the properties well at this one condition." But that is a different windmill for a different day, I suppose.
Expand the description to cover both the calculation of standard-state cp/h/s and the models that provide parameters affecting the equation of state. Also try to provide a description of the difference between the typical definition of standard state and the distinction that Cantera sometimes tries to make between "reference state" and "standard state" properties.
Split among science reference, an introductory tutorial, and more detailed information in the developer guide.
Able to update now that MyST-NB 1.0 has been released Also build docs with a newer version of Python
Co-authored-by: Bryan Weber <[email protected]>
Co-authored-by: Steven C. DeCaluwe <[email protected]>
bryanwweber
approved these changes
Jan 9, 2024
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
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.
Changes proposed in this pull request
cantera-website"Science" section into the versioned Sphinx documentationSpeciesThermoInterpTypemodels (e.g. NASA polynomials), models derived fromPDSS(e.g. temperature-dependent density), and models where the parameters are processed directly by theThermoPhasemodel (e.g. Peng-Robinson).If applicable, fill in the issue number this pull request is fixing
Continues work on Cantera/enhancements#178
Closes Cantera/cantera-website#249
If applicable, provide an example illustrating new features this pull request is introducing
Checklist
scons build&scons test) and unit tests address code coverage