Commit Graph

11154 Commits

Author SHA1 Message Date
Ray Speth
d005585e4d [Doc] Remove secondary sidebar from example pages
This sidebar usually only had a "get page source" link, which isn't
very useful for autogenerated pages.
2023-10-03 11:23:39 -04:00
Ray Speth
868678de5d Set py:currentmodule to enable link resolution 2023-10-03 11:23:39 -04:00
Ray Speth
7e35b7123c [Python] Avoid strange behavior from custom module loader
This was causing problems with re-importing cantera.with_units.units
while running the samples as part of the sphinx-gallery build
2023-10-03 11:23:39 -04:00
Ray Speth
305f4ed90c [Doc] Link code in Python examples to API docs 2023-10-03 11:23:39 -04:00
Ray Speth
4ad5642237 [Doc] Hide note about download link location 2023-10-03 11:23:39 -04:00
Ray Speth
9db15111b6 [Doc] Use sphinx-tags to enable finding examples by tag 2023-10-03 11:23:39 -04:00
Ray Speth
6c0b9b80fc [Doc] Build Sphinx docs and run gallery samples in build dir
Sphinx-gallery creates new .rst files alongside existing manually
maintained documentation, and runs the samples in-place, generating
their output files in the source tree. Moving this all to the build
directory lets us keep the repo clean.
2023-10-03 11:23:39 -04:00
Ray Speth
666f4d474c [Doc] Minimal working sphinx-gallery integration
This includes just the Python "kinetics" examples to start
2023-10-03 11:23:39 -04:00
g3bk47
329952d1bf [Tests] address review comments for legacy hdf5 tests 2023-10-01 21:43:53 -04:00
g3bk47
bcbf442e9b [Test] adjust tolerances for legacy hdf5 tests 2023-10-01 21:43:53 -04:00
g3bk47
9588047e43 [1D] Use midpoint properties for diffusion fluxes 2023-10-01 21:43:53 -04:00
Ray Speth
9696e27ea6 Fix a broken link to pint docs in sound_speed_units.py 2023-09-24 15:17:42 -04:00
Ray Speth
fb847bfe62 [SCons] Use build >= 1.0 for sdist
build 1.0 comes with multiple breaking changes
2023-09-24 15:17:42 -04:00
Christopher Neal
baf28afdaf [1D] updates to docstrings 2023-09-11 18:00:04 -05:00
Christopher Neal
8c7d9087cd [1D] Small equation formatting changes 2023-09-11 18:00:04 -05:00
Christopher Neal
c40de97079 docstring updates & eval() signature update 2023-09-11 18:00:04 -05:00
Christopher Neal
b87e6d8043 evalContinuity logic update & some docstring updates 2023-09-11 18:00:04 -05:00
Christopher Neal
4426b6cfc2 update logic for momentum/lambda in StFlow and species in IonFlow
moved computeRadiation to original location

updates to logic for residual eval methods & better argument names for eval() method
2023-09-11 18:00:04 -05:00
Christopher Neal
7979ba7c3a doxygen latex fixes in docstrings 2023-09-11 18:00:04 -05:00
Christopher Neal
d36319a940 moved transport/diffusive flux methods back to original spots 2023-09-11 18:00:04 -05:00
Christopher Neal
ee89b47c44 updates to logic & some code positioning changes 2023-09-11 18:00:04 -05:00
Christopher Neal
1bbffa17d3 docstring updates and minor formatting/whitespace adjustments 2023-09-11 18:00:04 -05:00
Christopher Neal
f667d518cc [1D] Moved comments to headers
improved comments for the residual evaluation equations
2023-09-11 18:00:04 -05:00
Christopher Neal
563ef533f6 removed getWdot() method as it isn't used anywhere by any methods 2023-09-11 18:00:04 -05:00
Christopher Neal
1d6b4f4345 [1D] Split StFlow evaluation into separate functions for each equation
- pull radiation computation into a separate method
- Various comment formatting/cleaning up
- eliminate evalResidual and evalRightBoundary methods
- moved wdot eval to update_thermo() method
- removed setGas() call as it is redundant
2023-09-11 18:00:04 -05:00
Ingmar Schoegl
bc8ebe8d48 [sphinx] Switch note to seealso admonitions 2023-09-10 22:37:38 -05:00
Ingmar Schoegl
3f6e2f7e89 Fix links in converter scripts 2023-09-10 22:37:38 -05:00
Ingmar Schoegl
475d855099 [unittest] Ensure yaml2ck handles notes correctly 2023-09-09 18:15:48 -05:00
Ingmar Schoegl
816d60d290 [yaml2ck] Note is always a string 2023-09-09 18:15:48 -05:00
Ingmar Schoegl
3a403fdc7c [ck2yaml] Update help text to match tutorial 2023-09-09 18:15:48 -05:00
Ingmar Schoegl
1118711332 [unittests] Add test for Solution.write_chemkin 2023-09-09 18:15:48 -05:00
Ingmar Schoegl
f15a34d0f2 [Python] Fix default arguments for Solution.write_chemkin
Also, add quiet option to suppress output
2023-09-09 18:15:48 -05:00
Ingmar Schoegl
363fe2cf73 [docs] Update ck2yaml.rst 2023-09-09 18:15:48 -05:00
Ingmar Schoegl
395a7d2252 [ck2yaml] Rename convert_mech to convert
Adopt the same naming convention as used by other converter scripts.
2023-09-09 18:15:48 -05:00
Ingmar Schoegl
964ec2dcbf [ck2yaml] Switch from getopt to argparse 2023-09-09 18:15:48 -05:00
Ingmar Schoegl
e6d59459da [ck2yaml] Simplify main 2023-09-09 18:15:48 -05:00
ThorstenZirwes
2f3ba6a577 add missing porosity to PorousMediaBurner.py
The chemical source term of the gas-phase temperature equation was missing the porosity
2023-09-08 09:52:35 -05:00
Ingmar Schoegl
c1281c1137 [CI] Adopt review suggestions 2023-09-05 09:50:29 -04:00
Ingmar Schoegl
d372713237 [CI] Add test for Python 3.12 pre-release 2023-09-05 09:50:29 -04:00
Ingmar Schoegl
0d4876d326 Fix incorrect logger info 2023-09-05 09:50:29 -04:00
Ingmar Schoegl
25b52d3d1d Fix syntax warnings for Python 3.12 2023-09-05 09:50:29 -04:00
Mark E. Fuller
b2f383a446 add Fedora CI config 2023-09-02 09:10:37 -05:00
Mark E. Fuller
27f8362f53 mods to enable python3.12 2023-09-02 09:10:37 -05:00
Ingmar Schoegl
9ee13ebb4e [CI] Test ubuntu:rolling/devel in docker container 2023-08-29 20:10:39 -04:00
Ingmar Schoegl
397e61d948 [Python] Remove vestigial h5py references 2023-08-29 20:10:39 -04:00
Ingmar Schoegl
d6b5224d8c [CI] Remove h5py from GH runners 2023-08-29 20:10:39 -04:00
Ray Speth
e2c446c25a [SCons] Restore missing regression test log output 2023-08-27 04:15:16 -07:00
Ray Speth
a76b349627 [SCons] Prevent reading of outdated test output files 2023-08-27 04:15:16 -07:00
Ray Speth
0e12271d34 [Examples] Return non-zero status after error
Allows the SCons test runner to detect errors running these samples
2023-08-27 04:15:16 -07:00
Ray Speth
7e071df5cd [SCons] Missing test output files are an "error", not "info" 2023-08-27 04:15:16 -07:00