diff --git a/doc/sphinx/compiling.rst b/doc/sphinx/compiling.rst index 3d74cce7e..38ae8445c 100644 --- a/doc/sphinx/compiling.rst +++ b/doc/sphinx/compiling.rst @@ -14,12 +14,13 @@ operating systems: * Linux - * Ubuntu 12.04 LTS (Precise Pangolin) or newer - * Debian 7.0 (Wheezy) or newer - * Fedora 20 or newer + * Ubuntu 12.04 LTS (Precise Pangolin) or newer; 16.04 LTS (Xenial Xerus) or + newer is recommended + * Debian 7.0 (Wheezy) or newer; 8.0 (Jessie) or newer is recommended + * Fedora 20 or newer; 22 or newer is recommended -* Windows 7, Windows 8, or Windows 10 (32-bit or 64-bit versions) -* OS X 10.9 (Mavericks), OS X 10.10 (Yosemite), or OS X 10.11 (El Capitan). +* Windows 7 or newer (32-bit or 64-bit versions) +* OS X 10.9 (Mavericks) or newer; 10.10 (Yosemite) or newer is recommended In addition to the above operating systems, Cantera should work on any Unix-like system where the necessary prerequisites are available, but some @@ -244,11 +245,8 @@ Python Module The Cantera Python module is implemented using Cython, and as such building the Cantera Python module requires the Cython package for Python. -The Python module is compatible with the following Python versions: 2.6, 2.7, -and 3.2 - 3.5. Support for Python 2.6 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 library in more recent -versions. +The Python module is compatible with the following Python versions: 2.7 +and 3.2 - 3.5. Building for Python 2 ..................... @@ -409,7 +407,7 @@ program. * Clang/LLVM (C/C++) - * Known to work with versions 3.3 through 3.5. Expected to work with version + * Known to work with versions 3.5 and 3.8. Expected to work with version >= 3.1. * Works with the versions included with Xcode 5.1 and Xcode 6.1. @@ -424,10 +422,10 @@ program. * MinGW (C/C++/Fortran) - * http://www.mingw.org (32-bit only) * http://mingw-w64.sourceforge.net/ (64-bit and 32-bit) * Known to work with Mingw-w64 3.0, which provides GCC 4.8. Expected to work - with any version that provides a supported version of GCC. + with any version that provides a supported version of GCC and includes C++11 + thread support. Other Required Software ----------------------- @@ -435,65 +433,28 @@ Other Required Software * SCons: * http://scons.org/tag/releases.html - * Linux & OS X: Known to work with SCons 2.3.0; Expected to work with versions >= 1.0.0 + * Linux & OS X: Known to work with SCons 2.4.1; Expected to work with versions >= 1.0.0 * Version 2.3.6 or newer is required to use Visual Studio 2015. * Python: * http://python.org/download/ - * Known to work with 2.6 and 2.7; Expected to work with versions >= 2.6. - * The Cython module supports Python 2.x and 3.x. However, SCons requires - Python 2.x, so compilation of the Python 3 module requires two Python + * Known to work with 2.7 and 3.5. Expected to work with versions >= 3.3. + * The Cython module supports Python 2.7 and 3.x. However, SCons requires + Python 2, so compilation of the Python 3 module requires two Python installations. * Boost * http://www.boost.org/users/download/ - * Known to work with version 1.54; Expected to work with versions >= 1.41 + * Known to work with version 1.54; Expected to work with versions >= 1.48 * Only the "header-only" portions of Boost are required. Cantera does not currently depend on any of the compiled Boost libraries. -Optional Programs ------------------ - -* Numpy - - * Required to build the Cantera Python module, and to run significant portions - of the test suite. - * http://sourceforge.net/projects/numpy/ - * Known to work with versions 1.7-1.9; Expected to work with version >= 1.4 - -* `Cython `_ - - * Required version >=0.19 to build the Python module - * Known to work with versions 0.19 and 0.20. - * Tested with Python 2.7, 3.3, and 3.4. Expected to work with Python 2.6 and - 3.2+ as well. - -* `3to2 `_ - - * Used to convert Cython examples to Python 2 syntax. - * Known to work with version 1.0 - -* `Scipy `_ - - * Required in order to use the Python module with Python 2.6. - -* Unittest2 - - * Required in order to run the test suite for the Python module with - Python 2.6. - * https://pypi.python.org/pypi/unittest2 - -* Matlab - - * Required to build the Cantera Matlab toolbox. - * Known to work with 2009a and 2014b. Expected to work with versions >= 2009a. - * Sundials - * Optional. If Sundials is not installed, it will be automatically downloaded - and the necessary portions will be compiled and installed with Cantera. + * If Sundials is not installed, it will be automatically downloaded and the + necessary portions will be compiled and installed with Cantera. * https://computation.llnl.gov/casc/sundials/download/download.html * Known to work with versions 2.4, 2.5, 2.6, and 2.7. * To use Sundials with Cantera on a Linux/Unix system, it must be compiled @@ -520,6 +481,52 @@ Optional Programs instead, so that Cantera can correctly identify the version of Sundials. +* Eigen + + * If Eigen is not installed, it will be automatically downloaded and installed + with Cantera. + * http://eigen.tuxfamily.org/ + * Known to work with version 3.2.8. + +* fmt + + * If fmt (previously known as cppformat) is not installed, it will be + automatically downloaded and the necessary portions will be compiled and + installed with Cantera. + * http://fmtlib.net/latest/index.html + * Version 3.0.1 or newer is required. + +* Google Test + + * If Google Test is not installed, it will be automatically downloaded and the + necessary portions will be compiled as part of the Cantera build process. + * https://github.com/google/googletest + * Known to work with version 1.7.0. + +Optional Programs +----------------- + +* Numpy + + * Required to build the Cantera Python module, and to run significant portions + of the test suite. + * http://sourceforge.net/projects/numpy/ + * Known to work with versions 1.7-1.11; Expected to work with version >= 1.4 + +* `Cython `_ + + * Required version >=0.23 installed for Python 2.7 to build the Python module + for both Python 2.7 and Python 3.x. + +* `3to2 `_ + + * Used to convert Cython examples to Python 2 syntax. + * Known to work with version 1.0 + +* Matlab + + * Required to build the Cantera Matlab toolbox. + * Known to work with 2009a and 2014b. Expected to work with versions >= 2009a. * `Windows Installer XML (WiX) toolset `_