research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove most content from Sphinx docs index page

Browse source 
It's all moved elsewhere on the new site.
This commit is contained in:
Bryan W. Weber 2018-06-12 16:17:43 -04:00 • committed by Ray Speth
parent 2f3a0122d6
commit 9670c5dac6
1 changed files with 4 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
doc/sphinx/index.rst
View file

@ -1,56 +1,14 @@
.. Cantera documentation master file, created by
sphinx-quickstart on Mon Mar 12 11:43:09 2012.
*******
Welcome
*******
Cantera is an open-source suite of object-oriented software tools for problems
involving chemical kinetics, thermodynamics, and/or transport processes. The
software automates the chemical kinetic, thermodynamic, and transport
calculations so that the users can efficiently incorporate detailed chemical
thermo-kinetics and transport models into their calculations.
The code utilizes object-oriented concepts for robust yet flexible phase models,
and algorithms are generalized so that users can explore different phase models
with minimal changes to their overall code. Currently, Cantera can be used from
Python and Matlab, or in applications written in C/C++ and Fortran 90. Cantera
also provides a limited number of solvers for 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.
Documentation
=============
These are the detailed API documentation pages for the Python and Matlab
interfaces for Cantera.
.. toctree::
:maxdepth: 2
about
faq
Installation Instructions <install>
Compiliation Instructions <compiling/index>
language-interfaces
cti/index
reactors
flames
cython/index
matlab/index
cxx-guide/index
glossary
old-docs
Cantera Development Homepage <https://github.com/Cantera/cantera>
* **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`