Ray Speth
98b8fa63cc
[SCons] Add option to skip running Sphinx Gallery examples
2024-06-03 23:26:46 -04:00
Ray Speth
47e7c1a2de
[Matlab] Return 0 as reverse rate constant for irreversible reactions
...
This behavior is consistent with Python and the default behavior in C++
2024-06-03 23:26:22 -04:00
Ray Speth
529ed11918
[Matlab] Fix docstring for Kinetics.equilibriumConstants
...
The equilibrium constant is calculated regardless of whether the
reaction is marked as reversible. This is consistent with the
behavior of the Python and C++ interfaces.
2024-06-03 23:26:22 -04:00
Cory Kinney
1ed2b28bb1
yaml2ck: Implement undeclared third body test
...
- Converted species names to set comprehension, as suggested
- Added phase definition from original issue for test
- Implemented test to check that only the undeclared third body was omitted
- Temperature and pressure conditions used for kinetics check matched to GRI 3.0 test function
2024-06-03 17:34:26 -04:00
Cory Kinney
f8fdb8e508
yaml2ck: Check if third body is in species list
...
Does not write the third body efficiencies for species that are not in the solution's species list
Fixed #1683
2024-06-03 17:34:26 -04:00
Ray Speth
06b3500a31
[CI] Remove MSVC toolset 14.1 runs due to upstream image changes
2024-06-02 17:23:59 -04:00
Ray Speth
7c0acf4a8b
Fix compatibility with Sphinx 7.3 and Sphinx Gallery 0.16
2024-06-02 17:23:59 -04:00
Ray Speth
5254a6bff6
[Doc] Add general tips for working with VS Code
...
Co-authored-by: Bryan W. Weber <bryan.w.weber@gmail.com>
2024-06-02 17:23:59 -04:00
Ray Speth
9c6f457c2a
[Doc] Describe running PyTest tests through VS Code
2024-06-02 17:23:59 -04:00
Ray Speth
15cc2f6e02
[Doc] Describe setup for debugging through VS Code
2024-06-02 17:23:59 -04:00
Ray Speth
331601da20
[Doc] Describe steps for running and debugging tests
2024-06-02 17:23:59 -04:00
Ray Speth
1c89a9366c
[Doc] Rework YAML reference landing page
2024-06-02 17:23:59 -04:00
Ray Speth
379ae509aa
[Doc] Rework Python API landing page
2024-06-02 17:23:59 -04:00
Ray Speth
ec0fabef07
[Doc] Add a page on writing examples for Sphinx Gallery
2024-06-02 17:23:59 -04:00
Ray Speth
355e8f75f5
[Doc] Update contributing suggestions
2024-06-02 17:23:59 -04:00
Ray Speth
1ff5423c89
[Doc] Update PR/git workflow guidance
2024-06-02 17:23:59 -04:00
Ray Speth
3cfab75428
[Doc] Start page about writing tests
2024-06-02 17:23:59 -04:00
Ray Speth
2c23124a61
[Doc] Describe method for documenting Cython class attributes
2024-06-02 17:23:59 -04:00
Ray Speth
19d159a961
[Doc] Update author credit guidelines
2024-06-02 17:23:59 -04:00
Ray Speth
fca36a5906
[Doc] Show CONTRIBUTING.md contents on website
2024-06-02 17:23:59 -04:00
Ray Speth
c68e3f9844
[Doc] Move code style guidelines into Sphinx docs
2024-06-02 17:23:59 -04:00
Ray Speth
17982b5cf9
[CI] Use stable version of Sphinx Gallery
...
The changes we need to suppport non-Python examples were included
in the 0.15.0 release.
2024-06-02 17:23:59 -04:00
Ray Speth
4b72c97969
[Doc] Update dependencies for building docs
2024-06-02 17:23:59 -04:00
Ray Speth
eee03421c5
[Doc] Add reference for PLOG formulation
2024-06-02 17:23:59 -04:00
Ray Speth
d37a76bf61
Ignore warning about caching Sphinx config
2024-04-20 07:37:18 -05:00
Ray Speth
020b18b449
[CI] Show Sphinx warnings separately
2024-04-20 07:37:18 -05:00
Ray Speth
d81bb794df
[CI] Avoid errors from running certain examples
2024-04-20 07:37:18 -05:00
Ray Speth
6bcec8d016
[CI] Fix failing Codecov uploads
2024-04-20 07:37:18 -05:00
Ray Speth
b39c64aee8
Migrate CSTR example from Jupyter
...
Co-authored-by: Santosh Shanbhogue <santosh.shanbhogue@gmail.com>
2024-04-20 07:37:18 -05:00
Ray Speth
84b9c9c3a7
[CI] Update packages needed for examples
2024-04-20 07:37:18 -05:00
Ray Speth
9576bd084c
Migrate interactive path diagram example from Jupyter
...
Co-authored-by: Sai Krishna <sirumalla.s@husky.neu.edu>
2024-04-20 07:37:18 -05:00
Ray Speth
76cc445a29
Revise nonideal shock tube example based on Jupyter Notebooks
...
Brings in some updates based on nonideal_shock_tube.ipynb and
batch_reactor_ignition_delay_NTC.ipynb.
Co-authored-by: Santosh Shanbhogue <santosh.shanbhogue@gmail.com>
Co-authored-by: Steven DeCaluwe <steven.decaluwe@gmail.com>
2024-04-20 07:37:18 -05:00
Ray Speth
a230d54da5
Migrate 1D packed bed example from Jupyter
...
Co-authored-by: Gandhali Kogekar <gkogekar@gmail.com>
2024-04-20 07:37:18 -05:00
Ray Speth
5077786b02
Revise twin flame example based on Jupyter
...
Re-draw figure from Jupyter example as an SVG.
Co-authored-by: Santosh Shanbhogue <santosh.shanbhogue@gmail.com>
2024-04-20 07:37:18 -05:00
Ray Speth
1fda1c022f
Migrate flame convergence analysis example from Jupyter
...
Co-authored-by: Richard West <r.west@northeastern.edu>
2024-04-20 07:37:18 -05:00
Ray Speth
3fdd45e357
[Doc] Automatically ignore unwanted Matplotlib output in gallery
2024-04-20 07:37:18 -05:00
Ray Speth
32a6d3da4e
Revise flame speed sensitivity example based on Jupyter version
...
Co-authored-by: Santosh Shanbhogue <santosh.shanbhogue@gmail.com>
2024-04-20 07:37:18 -05:00
Ray Speth
e97aed10fc
Revise lithium ion battery example based on Jupyter version
...
Co-authored-by: Steven DeCaluwe <steven.decaluwe@gmail.com>
2024-04-20 07:37:18 -05:00
Ray Speth
28092621e4
Migrate heating value example from Jupyter
2024-04-20 07:37:18 -05:00
Ray Speth
9d8d3c3b80
Migrate flame temperature example from Jupyter
2024-04-20 07:37:18 -05:00
Ray Speth
f609e42068
[Doc] Fix error in PFR surface species equation
...
See https://groups.google.com/g/cantera-users/c/_-pzZdv1lDM
2024-04-20 07:37:18 -05:00
Ray Speth
908ee90267
Migrate nonideal equation of state example from Jupyter
...
Co-authored-by: Gandhali Kogekar <gkogekar@gmail.com>
Co-authored-by: Bryan W. Weber <bryan.w.weber@gmail.com>
2024-04-20 07:37:18 -05:00
Ray Speth
2a57a963c8
[CI] Skip whitespace checks on specific files
2024-04-11 08:57:01 -04:00
Ray Speth
9a33c9532a
[Examples] Move input for coverage dependent surface to submodule
2024-04-11 08:57:01 -04:00
Ray Speth
3da2d27b22
[Examples] Move input files for PorousMediaBurner.py to submodule
2024-04-11 08:57:01 -04:00
Ray Speth
0c5fa1b201
[Python] List data files from subdirectories
2024-04-11 08:57:01 -04:00
Ray Speth
9ec376ec06
Move Itikawa example mechanism to data repo
2024-04-11 08:57:01 -04:00
Ray Speth
9bbd0fac3d
[SCons] Install example input files from git submodule
2024-04-11 08:57:01 -04:00
Ray Speth
92d3aeca42
[SCons] Refactor git submodule checkout into a function
2024-04-11 08:57:01 -04:00
Ray Speth
0d362b7bfe
[SCons] Avoid creating extra copy of data files in build/data
2024-04-11 08:57:01 -04:00
