cantera/doc/sphinx/index.rst
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

46 lines
1.3 KiB
ReStructuredText

.. Cantera documentation master file, created by
sphinx-quickstart on Mon Mar 12 11:43:09 2012.
*******
Welcome
*******
Cantera is a suite of object-oriented software tools for problems involving
chemical kinetics, thermodynamics, and/or transport processes.
Cantera provides types (or classes) of objects representing phases of
matter, interfaces between these phases, reaction managers, time-dependent
reactor networks, and steady one-dimensional reacting flows. Cantera is
currently used for applications including combustion, detonations,
electrochemical energy conversion and storage, fuel cells, batteries, aqueous
electrolyte solutions, plasmas, and thin film deposition.
Cantera can be used from Python and Matlab, or in applications written
in C++ and Fortran 90.
Documentation
=============
.. toctree::
:maxdepth: 2
Compiliation Instructions <compiling>
language-interfaces
cti/index
python/index
cython/index
matlab/index
cxx-guide/index
Cantera Development Homepage <http://cantera.googlecode.com>
* **C++ Documentation**
* `Module Organization <../../doxygen/html/modules.html>`_
* `Index of Classes <../../doxygen/html/classes.html>`_
* `Deprecation List <../../doxygen/html/deprecated.html>`_
Indexes
=======
* :ref:`genindex`
* :ref:`search`