research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
5680 commits 2 branches 16 tags 37 MiB
Commit graph

45 commits

Author SHA1 Message Date
Bryan W. Weber
8d1f374fc7 [Doc] Add link to Working with Input Files section 2016-01-25 18:39:16 -05:00
Bryan W. Weber
2b2b0947ec [Doc] Update docs for ck2cti 
Update documentation to give short tutorial and reflect most recent
version. Add notes for common errors encountered. Remove old ck2cti
docs from Matlab and Cython interface documentation, prefering
cti/input-files.rst. Resolves #295.
 2016-01-25 18:39:01 -05:00
Ray Speth
5597d1e374 [Doc] Fix typo in Planck constant units 
Fixes #280.
 2015-07-01 12:04:58 -04:00
Ray Speth
0f55a3bdff [Python/Doc] Add section on kinetics to the tutorial 2015-06-01 17:01:25 -04:00
Ray Speth
c7e79e64b4 [Doc] Add local tables of contents for thermo and kinetics 2015-05-29 17:32:23 -04:00
Ray Speth
51c8d7365a [Doc] Fix spelling errors 2015-05-25 20:57:19 -04:00
Ray Speth
468369df13 [Python] Include docs for all classes in Sphinx docs 2015-05-25 00:22:03 -04:00
Ray Speth
ba9c9c768f [Kinetics] Use the name 'ThreeBodyReaction' consistently 2015-05-11 16:35:46 -04:00
Ray Speth
11f4b1b7f7 [Doc] CTI to XML conversion does not generate new files 2015-05-06 21:15:02 -04:00
Ray Speth
14b41ea338 [Python/Doc] Update docs for Solution and Interface 2015-05-06 21:15:02 -04:00
Ray Speth
c214d912e5 [Doc] Add labels to enable linking to Python/Matlab examples 
The labels are "py-example-scriptname.py" and "matlab-example-scriptname.m",
respectively.
 2015-05-06 21:15:02 -04:00
Ray Speth
d470486bee [Python] Reactants and products can be specified in Reaction constructor 2015-05-06 21:15:01 -04:00
Ray Speth
d68c41197e [Python/Doc] Document GasTransportData 2015-05-05 11:34:07 -04:00
Ray Speth
18e2ab7c8d [Python/Doc] Document Reaction and derived classes 2015-05-05 11:34:07 -04:00
Ray Speth
4ea96b810d [Python] Document Species, SpeciesThermo, and derived classes 2015-05-05 11:00:25 -04:00
Ray Speth
d6f7fd855a [Python] Add access to SpeciesThermo(InterpType) objects 2015-04-20 18:34:36 -04:00
Ray Speth
4890cccb03 [Doc] Update phase report examples to show compact species output 2015-03-10 22:41:23 +00:00
Ray Speth
86f0058a0c [Doc] Fix some inconsistencies in the Python tutorial 
Resolves Issue 255.
 2015-03-10 22:41:19 +00:00
Ray Speth
ddfc15bb77 Allow CANTERA_DATA to include multiple directories 2014-12-12 01:36:56 +00:00
Ray Speth
0fd419028a [Doc] Add local tables of contents to Reactor and 1D documentation 
This makes these pages, which document many classes, easier to navigate.
 2014-09-02 22:34:08 +00:00
Bryan W. Weber
47b8c49aed [Doc] Fix names of the physical constants in the Cython documentation 2014-07-16 16:15:21 +00:00
Ray Speth
d2ff7dbaaa [SCons] 'clean' removes auto-generated .rst files from examples 2014-04-08 16:26:11 +00:00
Ray Speth
8471200fc1 [Doc] Add class Mixture to Sphinx docs 2014-02-21 19:07:54 +00:00
Ray Speth
452a9160f0 [Doc] Fix line lengths in Cython migration guide 2014-02-13 22:26:40 +00:00
Ray Speth
bc4d68eb20 [Cython] Add saveState/restoreState info to the migration guide 2014-02-13 22:26:36 +00:00
Ray Speth
22eac2abcd [Sphinx/Cython] Add call signatures to constructors 2014-01-11 00:20:33 +00:00
Bryan W. Weber
421e5356cb [Doc] Fix some formatting in cython/tutorial.rst 
See Issue 196.
 2013-12-18 17:47:03 +00:00
Bryan W. Weber
6973579b88 [Doc] Correct typo in migrating.rst 
See Issue 196.
 2013-12-18 17:46:57 +00:00
Ray Speth
12f3b2739c [Doc] Add ideal gas reactor classes to the Sphinx documentation 2013-12-14 00:18:04 +00:00
Ray Speth
d7c939e60c [Cython/Doc] Migration guide covers transport model and Soret effect 2013-11-03 21:06:54 +00:00
Ray Speth
1cedf904df [Doc] Add all Python examples to the Sphinx docs 2013-08-22 21:46:27 +00:00
Ray Speth
e667978655 [Cython] Allow setting state while holding specific properties constant 
The value "None" is used to indicate the property or properties being held
constant.
 2013-05-31 15:56:36 +00:00
Ray Speth
4743abbe2b [Cython/Doc] Add summary of changes to Python module syntax 2013-05-31 15:56:20 +00:00
Ray Speth
f90d136232 [Doc] Add content from tut[1-4].py to the Sphinx documentation 
Update the tutorials to follow the Cython module's syntax
 2013-05-31 15:56:01 +00:00
Ray Speth
1352a67e1c [Cython] Added interface for ReactionPathDiagram 2013-05-29 00:11:57 +00:00
Ray Speth
92016a2b31 [Cython] Fixed some problems building the Sphinx documentation 2013-01-30 22:05:46 +00:00
Ray Speth
f53ad9b47b [Cython] Added Sphinx docs for composite classes & importing 2012-12-26 23:56:24 +00:00
Ray Speth
8e355464de [Cython] Added physical constants to Sphinx docs 2012-12-26 23:56:21 +00:00
Ray Speth
8c0c2e16e4 [Cython] Added 1D simulation docs to Sphinx 2012-12-26 23:56:18 +00:00
Ray Speth
2134e5d570 [Cython] Added documentation for Reactor and related classes 2012-10-10 18:25:34 +00:00
Ray Speth
ced2e6c978 [Cython] Generalized interface to Func1 
It is now possible to use any callable Python object when the Cantera C++ core
requires an instance of Func1.
 2012-10-10 18:25:06 +00:00
Ray Speth
4ff9e61e0d Added docstrings for Cython Transport class 2012-09-06 19:59:58 +00:00
Ray Speth
25f361651a Added docstrings for the Cython Kinetics and InterfaceKinetics classes 2012-09-06 19:59:28 +00:00
Ray Speth
5a722f9608 Added docstrings to Cython ThermoPhase class 2012-09-06 19:58:50 +00:00
Ray Speth
0c904bebfa Added infrastructure for using Sphinx to document the new Python module 
This includes adding the sphinx_cmd option to SCons, which can be set to the
Python 3 version of sphinx-build as necessary.
 2012-09-06 19:58:13 +00:00