Skip to content
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

Add derivative documentation #1563

Merged
merged 3 commits into from
Aug 4, 2023

Conversation

ischoegl
Copy link
Member

@ischoegl ischoegl commented Jul 30, 2023

Changes proposed in this pull request

Add documentation of derivative calculation. Documentation is added to pre-existing Doxygen section.

If applicable, fill in the issue number this pull request is fixing

Closes Cantera/cantera-website#169

If applicable, provide an example illustrating new features this pull request is introducing

Checklist

  • The pull request includes a clear description of this code change
  • Commit messages have short titles and reference relevant issues
  • Build passes (scons build & scons test) and unit tests address code coverage
  • Style & formatting of contributed code follows contributing guidelines
  • The pull request is ready for review

@codecov
Copy link

codecov bot commented Jul 30, 2023

Codecov Report

Merging #1563 (e08e824) into main (6ba497c) will not change coverage.
The diff coverage is n/a.

❗ Current head e08e824 differs from pull request most recent head 83c2766. Consider uploading reports for the commit 83c2766 to get more accurate results

@@           Coverage Diff           @@
##             main    #1563   +/-   ##
=======================================
  Coverage   70.45%   70.45%           
=======================================
  Files         379      379           
  Lines       59093    59093           
  Branches    21230    21230           
=======================================
  Hits        41636    41636           
  Misses      14376    14376           
  Partials     3081     3081           
Files Changed Coverage Δ
include/cantera/kinetics/Kinetics.h 32.66% <ø> (ø)
include/cantera/kinetics/ReactionRate.h 78.87% <ø> (ø)

... and 10 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@ischoegl ischoegl force-pushed the add-derivative-documentation branch 2 times, most recently from 61ca600 to 717a90e Compare July 30, 2023 15:24
@ischoegl ischoegl marked this pull request as ready for review July 30, 2023 15:26
@ischoegl ischoegl requested a review from a team July 30, 2023 15:26
@ischoegl ischoegl force-pushed the add-derivative-documentation branch 4 times, most recently from e08e824 to 1b87a0f Compare August 3, 2023 14:39
@ischoegl
Copy link
Member Author

ischoegl commented Aug 3, 2023

Rebased and ready for review. BibTeX sort moved to #1567.

include/cantera/kinetics/Kinetics.h Show resolved Hide resolved
include/cantera/kinetics/Kinetics.h Outdated Show resolved Hide resolved
include/cantera/kinetics/Kinetics.h Outdated Show resolved Hide resolved
test/python/test_jacobian.py Outdated Show resolved Hide resolved
test/python/test_jacobian.py Outdated Show resolved Hide resolved
@ischoegl ischoegl force-pushed the add-derivative-documentation branch from 1b87a0f to 83c2766 Compare August 3, 2023 21:34
@ischoegl ischoegl requested a review from speth August 3, 2023 23:53
@ischoegl
Copy link
Member Author

ischoegl commented Aug 4, 2023

Thanks for the review comments. I took care of everything except for what I believe is a CSS styling issue?

@speth speth merged commit 5c0490b into Cantera:main Aug 4, 2023
41 checks passed
@ischoegl ischoegl deleted the add-derivative-documentation branch August 4, 2023 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Add information on derivative calculation to science section
2 participants