-
-
Notifications
You must be signed in to change notification settings - Fork 347
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Migrate "Science" docs #1647
Migrate "Science" docs #1647
Conversation
Requesting @decaluwe's review specifically for the updates to the "species thermo" and "standard state" docs. |
Thanks @speth --will get to it! Excited to see this come through (and wish I had done more to help get it there). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 😸
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, @speth! All good from my side. As I didn’t do heavy lifting to review, it’s not my place to approve though.
Changes proposed in this pull request
cantera-website
"Science" section into the versioned Sphinx documentationSpeciesThermoInterpType
models (e.g. NASA polynomials), models derived fromPDSS
(e.g. temperature-dependent density), and models where the parameters are processed directly by theThermoPhase
model (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