GreenPolyProducts/cantera
5
0
Fork 0
mirror of https://github.com/Cantera/cantera.git synced 2025-02-25 18:55:29 -06:00
Code Issues Packages Projects Releases Wiki Activity

[Doc] Update example links in FAQ

Browse Source
This commit is contained in:
Bryan W. Weber
2018-02-04 21:28:52 -05:00
parent af4a78ddde
commit ec5aecd3d6
3 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/sphinx/cxx-guide/simple-example.rst
View File

@@ -1,3 +1,4 @@
.. _sec-cxx-simple-example:
*************************
A Very Simple C++ Program

2
doc/sphinx/cython/tutorial.rst
View File

@@ -6,7 +6,7 @@ Tutorial
Getting Started
---------------
Start by opening an interactive Python session, e.g. by running `IPython
Start by opening an interactive Python session, e.g., by running `IPython
<http://ipython.org/>`_. Import the Cantera Python module and NumPy by running::
>>> import cantera as ct

8
doc/sphinx/faq.rst
View File

@@ -78,7 +78,13 @@ General
**Where can I find examples of how to use Cantera?**
Cantera is distributed with many examples for the Python and Matlab
Examples of how to use Cantera are available in our online documentation.
For Python, visit the :ref:`sec-cython-examples` or the Jupyter Notebook
examples on `GitHub <https://github.com/Cantera/cantera-jupyter>`_. For
Matlab visit the :ref:`sec-matlab-examples`, and for a simple C++ example
see :ref:`sec-cxx-simple-example`.
In addition, Cantera is distributed with many examples for the Python and Matlab
interfaces, and a smaller number of examples for the C++ and Fortran
interfaces. The Matlab, C++, and Fortran examples should be
installed in the ``samples`` subdirectory of the Cantera installation