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

[Doc] Drop references to the "legacy" vs "new" Python modules

Browse source
This commit is contained in:
Ray Speth 2016-04-02 22:13:42 -04:00
parent 6d91b44ed6
commit 4799d19b39
2 changed files with 7 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/sphinx/compiling.rst
View file

@ -243,14 +243,10 @@ General
Python Module
-------------
Cantera 2.1 introduces a new Python module implemented using Cython. This new
module provides support for both Python 2.x and Python 3.x. It also features a
redesigned API that simplifies many operations and aims to provide a more
"Pythonic" interface to Cantera.
The Cantera Python module is implemented using Cython, and as such building the
Cantera Python module requires the Cython package for Python.
Building the new Python module requires the Cython package for Python.
The Cython module is compatible with the following Python versions: 2.6, 2.7,
The Python module is compatible with the following Python versions: 2.6, 2.7,
3.1, 3.2, and 3.3. Support for Python 2.6 and Python 3.1 requires the ``scipy``
and ``unittest2`` packages to be installed as well (see :ref:`sec-dependencies`)
to provide certain features that are included in the standard
@ -266,7 +262,7 @@ Building for Python 3
.....................
If SCons detects a Python 3 interpreter installed in a default location
(i.e. ``python3`` is on the path), it will try to build the new Python module
(i.e. ``python3`` is on the path), it will try to build the Python module
for Python 3. The following SCons options control how the Python 3 module is
built::

6
doc/sphinx/faq.rst
View file

@ -72,7 +72,7 @@ General
**Which Cantera interface should I use?**
If you're new to Cantera, the best interface to get started with is
probably the "new" Python interface. It offers most of the features of the
probably the Python interface. It offers most of the features of the
C++ core in a much more flexible environment. Since all of the
calculations are still done in C++, there is very little performance
penalty to using the high-level language interfaces.
@ -81,12 +81,12 @@ General
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 legacy Python examples should be
interfaces. The Matlab, C++, and Fortran examples should be
installed in the ``samples`` subdirectory of the Cantera installation
directory, or they can be found in the ``samples`` subdirectory of the
Cantera source directory.
Examples for the new Python interface can be found in the ``examples``
Examples for the Python interface can be found in the ``examples``
subdirectory of the Cantera Python module installation directory, or in
the ``interfaces/cython/cantera/examples`` subdirectory of the Cantera
source directory.