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

Update example formatting for better sphinx-gallery rendering #1821

Merged
merged 11 commits into from
Dec 2, 2024

Conversation

speth
Copy link
Member

@speth speth commented Dec 1, 2024

Changes proposed in this pull request

  • Add plots to several examples
  • Add sphinx-gallery section headings / description blocks to several examples
  • Adjust plotting in some examples to avoid re-use of existing figures (which doesn't work well with sphinx-gallery) and use plt.show() more consistently for when examples are run from the command line
  • More extensive revisions to piston.py, mechanism_reduction.py, isentropic.py, and blowers_masel.py
  • Fix some issues with output files and missing overwrite flags when saving 1D flame data

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

@speth speth added the Examples label Dec 1, 2024
Copy link

codecov bot commented Dec 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.24%. Comparing base (fc2a16e) to head (2e6d7ee).
Report is 11 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1821      +/-   ##
==========================================
- Coverage   73.25%   73.24%   -0.01%     
==========================================
  Files         383      383              
  Lines       54624    54624              
  Branches     9103     9103              
==========================================
- Hits        40015    40012       -3     
- Misses      11603    11605       +2     
- Partials     3006     3007       +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.

Some small suggestions, thanks @speth!

samples/python/kinetics/mechanism_reduction.py Outdated Show resolved Hide resolved
samples/python/kinetics/shock_tube.py Outdated Show resolved Hide resolved
samples/python/kinetics/shock_tube.py Outdated Show resolved Hide resolved
samples/python/reactors/combustor.py Show resolved Hide resolved
@speth speth force-pushed the example-formatting branch from 2f9f92f to 2e6d7ee Compare December 1, 2024 21:44
@speth speth marked this pull request as ready for review December 2, 2024 02:04
Copy link
Member

@ischoegl ischoegl left a comment

Choose a reason for hiding this comment

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

Thanks, @speth!

@speth speth merged commit 6b38604 into Cantera:main Dec 2, 2024
58 of 59 checks passed
@speth speth deleted the example-formatting branch December 2, 2024 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants