Bryan W. Weber
c7db81f33c
[Doc] Document the ReactorSurface class in Python
...
Fixes #407
2016-12-09 19:51:46 -05:00
Santosh Shanbhogue
08b14b24ed
[Doc] Add more links to Jupyter notebooks
2016-12-03 13:24:09 -05:00
Bryan W. Weber
d1c2ec48e7
Add function to get the data directories Cantera searches
2016-10-31 17:14:26 -04:00
Ray Speth
a35a0cb510
[Doc] Include summaries of each example in index of Python examples
2016-10-14 17:06:45 -04:00
Ray Speth
00b104af50
[Python/Doc] Add documentation for class SolutionArray
2016-07-09 19:15:07 -04:00
Ray Speth
f081fa3f91
[Doc] Add NumPy import to Python tutorial
2016-05-05 10:16:13 -04:00
Ray Speth
5bf57795fc
[Doc] Add slicing and dict-based compositions to Python tutorial
2016-04-15 13:00:48 -04:00
Ray Speth
77e3775c08
[1D] Provide reasonable initial grid for ImpingingJet
2016-03-27 17:07:36 -04:00
Ray Speth
8e81292558
[1D] Provide reasonable default grid for CounterflowDiffusionFlame
2016-03-27 17:07:36 -04:00
Ray Speth
87a8419380
[1D] Provide reasonable initial grid for BurnerFlame
2016-03-27 17:07:36 -04:00
Ray Speth
f0a1e25cd9
[1D] Better initial grid for CounterflowPremixedFlame
2016-03-25 12:21:19 -04:00
Ray Speth
de8348ecb2
[1D] Use a better default initial grid for FreeFlame
...
This initial grid is designed to work well with how the initial profile and
temperature fixed point are set. The only parameter that needs to be
user-specified is the width of the domain.
2016-03-25 12:21:19 -04:00
Bryan W. Weber
9577409516
[Doc] Add documentation for new Element class and functions
2016-01-22 18:18:43 -05:00
Bryan W. Weber
10981277ae
[Doc] Add link to Working with Input Files section
2015-11-19 08:02:07 -05:00
Bryan W. Weber
61736bd2ef
[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 .
2015-11-18 18:09:12 -05:00
Bryan W. Weber
ee14246b12
[Doc] Put physical constant units into consistent form
2015-11-18 18:09:12 -05:00
Ray Speth
d559af9d38
[Python] Add docs for class Quantity
2015-08-24 17:31:04 -04:00
Ray Speth
9a4bc3c34f
[Doc] Fix typo in Planck constant units
...
Fixes #280 .
2015-07-01 12:04:36 -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
