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

Example & documentation updates #1724

Merged
merged 19 commits into from
Jun 25, 2024
Merged

Example & documentation updates #1724

merged 19 commits into from
Jun 25, 2024

Conversation

speth
Copy link
Member

@speth speth commented Jun 23, 2024

Changes proposed in this pull request

  • Start populating the FAQ
  • Add more entries to the glossary
  • Fix some small display issues in the docs
  • Add ReactorNet drawing (introduced in Reactor net visualization #1624) to a couple of examples
  • Revise several examples to have nicer looking output in Sphinx Gallery
  • Reorganize Python examples into fewer categories
  • Add more links between the tutorials and the examples (resolves Combination or linking of tutorials and examples. cantera-website#103)
  • Add warnings about the deficiencies and failure modes of the Mixture class and the multiphase equilibrium solvers

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

Closes Cantera/cantera-website#103

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

Copy link

codecov bot commented Jun 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.79%. Comparing base (ded4513) to head (40abe2c).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1724      +/-   ##
==========================================
- Coverage   72.80%   72.79%   -0.01%     
==========================================
  Files         381      381              
  Lines       54011    54011              
  Branches     9207     9207              
==========================================
- Hits        39321    39319       -2     
- Misses      11706    11707       +1     
- Partials     2984     2985       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@bryanwweber bryanwweber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple of small suggestions 😄

speth added 18 commits June 24, 2024 14:10
The javascript for the search box wouldn't work due to an earlier
error in the javascript for the version switcher when the switcher
JSON file couldn't be loaded.
- Structure comments for Sphinx Gallery
- Show reactor network structure at start and end of simulation
- Use pandas to show table of intermediate states and write CSV file
- Modify formatting for Sphinx Gallery
- Use a larger mechanism file from the example_data repo to better
  demonstrate the benefits of preconditioning
@bryanwweber
Copy link
Member

@speth will you fix the examples in this PR? I'm not sure if the failures are related to this branch. If not, I'll approve 😄

@speth speth merged commit bc24169 into Cantera:main Jun 25, 2024
48 checks passed
@speth speth deleted the docs-2024-06 branch June 25, 2024 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Combination or linking of tutorials and examples.
2 participants