Skip to content

Documentation and example updates#2026

Merged
ischoegl merged 14 commits intoCantera:mainfrom
speth:doc-updates
Oct 31, 2025
Merged

Documentation and example updates#2026
ischoegl merged 14 commits intoCantera:mainfrom
speth:doc-updates

Conversation

@speth
Copy link
Copy Markdown
Member

@speth speth commented Oct 30, 2025 •
edited
Loading

Changes proposed in this pull request

This is a collection of updates to the documentation and examples:

  • Fix derivation of energy equation for ideal gas mole reactor and ideal gas constant pressure mole reactor
  • Update docstrings for heat capacity getters to explicitly state that $c_p$ and $c_v$ are at constant composition
  • Update links to data files in input file tutorial
  • Explain Ubuntu sample and data file locations
  • Add man page for lxcat2yaml
  • Always show plots when running Python examples from command line
  • Remove unused imports from Python examples
  • Fix outdated "requires" annotations in the examples
  • Note required Cantera version in Matlab examples
  • Fix miscellaneous documentation typos
  • Fix formatting of elastic_power_loss docstring
  • Remove documentation for obsolete installation options (Fedora, RHEL, OpenSUSE)
  • Remove obsolete Jupyter notebook mention from README

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

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

bryanwweber
bryanwweber reviewed Oct 30, 2025
View reviewed changes
Copy link
Copy Markdown
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.

I see this is still draft but I'm bored in an airport and I just had two small comments ☺️

doc/sphinx/install/index.md Outdated

```{attention}
Packaged versions of Cantera for Fedora, Enterprise Linux (RHEL), and OpenSUSE are no
longer available due to the lack of a package maintainer for these distributions.
Copy link
Copy Markdown
Member

@bryanwweber bryanwweber Oct 30, 2025

Choose a reason for hiding this comment

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

Suggest adding a call to action here with a link to the issue.

ischoegl
ischoegl reviewed Oct 30, 2025
View reviewed changes
README.rst Outdated

- Additional installation packages are provided for Windows, macOS, Ubuntu, Fedora,
RHEL, Gentoo, and FreeBSD.
- Additional installation packages are provided for Windows, macOS, Ubuntu, Gentoo, and
Copy link
Copy Markdown
Member

@ischoegl ischoegl Oct 30, 2025

Choose a reason for hiding this comment

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

I don't think that we currently provide additional packages for macOS?

Copy link
Copy Markdown
Member Author

@speth speth Oct 30, 2025

Choose a reason for hiding this comment

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

Good point. Likewise for Windows.

@andrewgsavage
Copy link
Copy Markdown

andrewgsavage commented Oct 30, 2025

while you're doing doc updates, I had a bit of trouble installing the alpha using pixi

this page could use a note under installing the dev version saying
In the pixi.toml file, include

channels = ["conda-forge", "conda-forge/label/cantera_dev"]

[dependencies] 
cantera = {version = "3.2.0a3", channel = "conda-forge/label/cantera_dev"}
libcantera = {version = "3.2.0a3", channel = "conda-forge/label/cantera_dev"}

@speth
Copy link
Copy Markdown
Member Author

speth commented Oct 30, 2025

I wonder whether it would be better to cover installation using Pixi on a separate page, even though it's installing the same underlying packages. There's already a lot of scenarios covered on the Conda installation page, and adding this on that page might make these instructions harder to follow.

@andrewgsavage
Copy link
Copy Markdown

andrewgsavage commented Oct 30, 2025

yea I thought that too. You've also got matlab on that page which doesn't really fit

@speth
Copy link
Copy Markdown
Member Author

speth commented Oct 30, 2025

You've also got matlab on that page which doesn't really fit

Well, for previous versions of the Matlab toolbox, the installation route that was discussed there was installation using a Conda package. It's not yet clear to me how packaging / installation of the new Matlab toolbox is going to work.

@speth
Copy link
Copy Markdown
Member Author

speth commented Oct 30, 2025

I don't think I want to add a Pixi page via this PR, as I think doing it well will require a bit of experimentation with Pixi that I haven't yet done. @andrewgsavage, could you create an issue on the Cantera Enhancements tracker with this suggestion?

speth added 14 commits October 30, 2025 15:11
@speth
Remove Jupyter notebook mention from README
13754b8
@speth
[Doc] Remove obsolete installation options
5453865 
Resolves Cantera#1985
@speth
[Doc] Fix formatting of elastic_power_loss Sphinx annotation
1412c6f
@speth
Fix miscellaneous typos
c846b52
@speth
[Matlab/Samples] Note required Cantera version
71a6c40
@speth
[Python/Samples] Fix outdated "requires" annotations
5299dd4
@speth
[Python/Samples] Remove unused imports
525b0c4
@speth
[Python/Samples] Show plots when running from command line
3f60fa0
@speth
[Doc] Add man page for lxcat2yaml
ef9daf8
@speth
[Doc] Explain Ubuntu sample and data file locations
080b375
@speth
[Doc] Update links to data files in input file tutorial
fe4d998
@speth
[Doc] Clarify that cp and cv are at constant composition
d07f144
@speth
[Doc] Fix energy equation for ideal gas mole reactor
a895b2e
@speth
[Doc] Fix energy equation for ideal gas constant pressure mole reactor
c9b4d4d
@speth speth marked this pull request as ready for review October 31, 2025 02:51
ischoegl
ischoegl reviewed Oct 31, 2025
View reviewed changes
ischoegl
ischoegl approved these changes Oct 31, 2025
View reviewed changes
Copy link
Copy Markdown
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 - this all looks good to me!

@ischoegl ischoegl merged commit 2054d5e into Cantera:main Oct 31, 2025
53 of 54 checks passed
@speth speth deleted the doc-updates branch October 31, 2025 20:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bryanwweber bryanwweber bryanwweber left review comments

@ischoegl ischoegl ischoegl approved these changes

Assignees

No one assigned

Labels

documentation Examples

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Fedora Cantera package is orphaned/retired

4 participants

@speth @andrewgsavage @bryanwweber @ischoegl