diff --git a/README.md b/README.md index dd4f0c8d7..eb1132f21 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,10 @@ site is built using the [Nikola](https://getnikola.com) static site generator. 3. Clone the Cantera Jupyter examples: `git clone https://github.com/Cantera/cantera-jupyter.git` 4. Clone the Cantera website source: `git clone https://github.com/Cantera/cantera-website.git` 5. Enter the website repo: `cd cantera-website` -6. Inside the website repo, install the required packages: `pip install -r requirements.txt` -7. Build the website and open in browser: `nikola auto -b` +6. Copy the current development documentation: `curl -O https://cantera.org/documentation/dev/dev-docs.tar.bz2` +7. Extract the dev docs: `tar jxf dev-docs.tar.bz2 --strip-components=1 -C api-docs/dev` +8. Inside the website repo, install the required packages: `pip install -r requirements.txt` +9. Build the website and open in browser: `nikola auto -b` ## To add a language of examples diff --git a/api-docs/dev/.gitignore b/api-docs/dev/.gitignore new file mode 100644 index 000000000..5e7d2734c --- /dev/null +++ b/api-docs/dev/.gitignore @@ -0,0 +1,4 @@ +# Ignore everything in this directory +* +# Except this file +!.gitignore diff --git a/conf.py b/conf.py index ad1ef80cf..7df4450c2 100644 --- a/conf.py +++ b/conf.py @@ -272,6 +272,7 @@ # This is the "production" version of this dictionary DOCS_FOLDERS = { + "api-docs/dev": "documentation/dev", "api-docs/docs-2.0": "documentation/docs-2.0", "api-docs/docs-2.1": "documentation/docs-2.1", "api-docs/docs-2.2": "documentation/docs-2.2", diff --git a/pages/community.rst b/pages/community.rst index d4b02fc5a..79d51c7b2 100644 --- a/pages/community.rst +++ b/pages/community.rst @@ -65,11 +65,11 @@ For installation/compilation problems, please provide: scons build >buildlog.txt 2>&1 * The exact version of Cantera you are trying to compile, and how it was - obtained (i.e., downloaded source tarball or the specific Git commit). + obtained (for example, downloaded source tarball or the specific Git commit). * Your operating system, compiler versions, and the versions of any other relevant software. -For application problems (i.e., not related to installation or compilation), +For application problems (that is, not related to installation or compilation), please: * Provide a minimal, complete, and verifiable example that demonstrates diff --git a/pages/compiling/config-options-dev.rst b/pages/compiling/config-options-dev.rst index ce32100b1..da793ed87 100644 --- a/pages/compiling/config-options-dev.rst +++ b/pages/compiling/config-options-dev.rst @@ -93,7 +93,7 @@ Options List * ``python_package``: [ ``y`` | ``n`` | ``full`` | ``minimal`` | ``none`` | ``default`` ] If you plan to work in Python, then you need the ``full`` Cantera Python package. If, on the other hand, you will only use Cantera from some - other language (e.g. MATLAB or Fortran 90/95) and only need Python + other language (for example, MATLAB or Fortran 90/95) and only need Python to process CTI files, then you only need a ``minimal`` subset of the package and Cython and NumPy are not necessary. The ``none`` option doesn't install any components of the Python interface. The default @@ -231,9 +231,9 @@ Options List * ``system_eigen``: [ ``default`` | ``y`` | ``n`` ] Select whether to use Eigen from a system installation (``y``), from a Git submodule (``n``), or to decide automatically (``default``). If - Eigen is not installed directly into a system include directory, - e.g. it is installed in ``/opt/include/eigen3/Eigen``, then you will - need to add ``/opt/include/eigen3`` to the ``extra_inc_dirs`` option. + Eigen is not installed directly into a system include directory -- + for example, if it is installed in ``/opt/include/eigen3/Eigen`` -- then you + will need to add ``/opt/include/eigen3`` to the ``extra_inc_dirs`` option. - default: ``'default'`` @@ -262,7 +262,7 @@ Options List The directory where the SUNDIALS header files are installed. This should be the directory that contains the ``cvodes``, ``nvector``, etc. subdirectories. Not needed if the headers are installed in a - standard location, e.g., ``/usr/include``. + standard location such as ``/usr/include``. - default: ``''`` @@ -270,7 +270,7 @@ Options List * ``sundials_libdir``: [ ``/path/to/sundials_libdir`` ] The directory where the SUNDIALS static libraries are installed. Not - needed if the libraries are installed in a standard location, e.g., + needed if the libraries are installed in a standard location such as ``/usr/lib``. - default: ``''`` @@ -279,10 +279,10 @@ Options List * ``blas_lapack_libs``: [ ``string`` ] Cantera can use BLAS and LAPACK libraries available on your system - if you have optimized versions available (e.g., Intel MKL). + if you have optimized versions available (for example, Intel MKL). Otherwise, Cantera will use Eigen for linear algebra support. To use BLAS and LAPACK, set ``blas_lapack_libs`` to the the list of libraries - that should be passed to the linker, separated by commas, e.g., + that should be passed to the linker, separated by commas -- for example, ``"lapack,blas"`` or ``"lapack,f77blas,cblas,atlas"``. - default: ``''`` @@ -291,7 +291,7 @@ Options List * ``blas_lapack_dir``: [ ``/path/to/blas_lapack_dir`` ] Directory containing the libraries specified by ``blas_lapack_libs``. Not - needed if the libraries are installed in a standard location, e.g. + needed if the libraries are installed in a standard location such as ``/usr/lib``. - default: ``''`` @@ -301,7 +301,7 @@ Options List * ``lapack_names``: [ ``lower`` | ``upper`` ] Set depending on whether the procedure names in the specified libraries are lowercase or uppercase. If you don't know, run ``nm`` on - the library file (e.g., ``nm libblas.a``). + the library file (for example, ``nm libblas.a``). - default: ``'lower'`` @@ -347,7 +347,7 @@ Options List * ``env_vars``: [ ``string`` ] Environment variables to propagate through to SCons. Either the - string ``all`` or a comma separated list of variable names, e.g. + string ``all`` or a comma separated list of variable names such as ``LD_LIBRARY_PATH,HOME``. - default: ``'LD_LIBRARY_PATH,PYTHONPATH'`` @@ -363,7 +363,7 @@ Options List * ``cxx_flags``: [ ``string`` ] Compiler flags passed to the C++ compiler only. Separate multiple - options with spaces, e.g., ``cxx_flags='-g -Wextra -O3 --std=c++11'`` + options with spaces -- for example, ``cxx_flags='-g -Wextra -O3 --std=c++11'`` - default: ``''`` @@ -449,7 +449,7 @@ Options List * ``warning_flags``: [ ``string`` ] Additional compiler flags passed to the C/C++ compiler to enable extra warnings. Used only when compiling source code that is part of - Cantera (e.g. excluding code in the 'ext' directory). + Cantera (for example, excluding code in the 'ext' directory). - default: ``''`` @@ -473,7 +473,7 @@ Options List * ``boost_inc_dir``: [ ``/path/to/boost_inc_dir`` ] Location of the Boost header files. Not needed if the headers are - installed in a standard location, e.g. ``/usr/include``. + installed in a standard location such as ``/usr/include``. - default: ``''`` @@ -481,7 +481,7 @@ Options List * ``stage_dir``: [ ``/path/to/stage_dir`` ] Directory relative to the Cantera source directory to be used as a - staging area for building e.g., a Debian package. If specified, + staging area for building, for example, a Debian package. If specified, ``scons install`` will install files to ``stage_dir/prefix/...``. - default: ``''`` @@ -496,7 +496,7 @@ Options List .. _gtest-flags-dev: * ``gtest_flags``: [ ``string`` ] - Additional options passed to each GTest test suite, e.g. + Additional options passed to each GTest test suite, for example `--gtest_filter=*pattern*`. Separate multiple options with spaces. .. _renamed-shared-libraries-dev: @@ -515,7 +515,7 @@ Options List * ``versioned_shared_library``: [ ``yes`` | ``no`` ] If enabled, create a versioned shared library, with symlinks to the - more generic library name, e.g. ``libcantera_shared.so.2.4.0`` as the + more generic library name, for example ``libcantera_shared.so.2.4.0`` as the actual library and ``libcantera_shared.so`` and ``libcantera_shared.so.2`` as symlinks. @@ -525,7 +525,7 @@ Options List * ``layout``: [ ``standard`` | ``compact`` | ``debian`` ] The layout of the directory structure. 'standard' installs files to - several subdirectories under 'prefix', e.g. $prefix/bin, + several subdirectories under 'prefix', for example, $prefix/bin, $prefix/include/cantera, $prefix/lib. This layout is best used in conjunction with 'prefix'='/usr/local'. 'compact' puts all installed files in the subdirectory defined by 'prefix'. This layout is best diff --git a/pages/compiling/config-options.rst b/pages/compiling/config-options.rst index c6c1f82e1..ff0866e8d 100644 --- a/pages/compiling/config-options.rst +++ b/pages/compiling/config-options.rst @@ -93,7 +93,7 @@ Options List * ``python_package``: [ ``y`` | ``n`` | ``full`` | ``minimal`` | ``none`` | ``default`` ] If you plan to work in Python, then you need the ``full`` Cantera Python package. If, on the other hand, you will only use Cantera from some - other language (e.g. MATLAB or Fortran 90/95) and only need Python + other language (for example, MATLAB or Fortran 90/95) and only need Python to process CTI files, then you only need a ``minimal`` subset of the package and Cython and NumPy are not necessary. The ``none`` option doesn't install any components of the Python interface. The default @@ -297,8 +297,8 @@ Options List * ``system_eigen``: [ ``default`` | ``y`` | ``n`` ] Select whether to use Eigen from a system installation (``y``), from a Git submodule (``n``), or to decide automatically (``default``). If - Eigen is not installed directly into a system include directory, - e.g. it is installed in ``/opt/include/eigen3/Eigen``, then you will + Eigen is not installed directly into a system include directory -- + for example, it is installed in ``/opt/include/eigen3/Eigen``, then you will need to add ``/opt/include/eigen3`` to the ``extra_inc_dirs`` option. - default: ``'default'`` @@ -328,7 +328,7 @@ Options List The directory where the SUNDIALS header files are installed. This should be the directory that contains the ``cvodes``, ``nvector``, etc. subdirectories. Not needed if the headers are installed in a - standard location, e.g., ``/usr/include``. + standard location such as ``/usr/include``. - default: ``''`` @@ -336,7 +336,7 @@ Options List * ``sundials_libdir``: [ ``/path/to/sundials_libdir`` ] The directory where the SUNDIALS static libraries are installed. Not - needed if the libraries are installed in a standard location, e.g., + needed if the libraries are installed in a standard location such as ``/usr/lib``. - default: ``''`` @@ -345,10 +345,10 @@ Options List * ``blas_lapack_libs``: [ ``string`` ] Cantera can use BLAS and LAPACK libraries available on your system - if you have optimized versions available (e.g., Intel MKL). + if you have optimized versions available (for example, Intel MKL). Otherwise, Cantera will use Eigen for linear algebra support. To use BLAS and LAPACK, set ``blas_lapack_libs`` to the the list of libraries - that should be passed to the linker, separated by commas, e.g., + that should be passed to the linker, separated by commas -- for example, ``"lapack,blas"`` or ``"lapack,f77blas,cblas,atlas"``. - default: ``''`` @@ -357,7 +357,7 @@ Options List * ``blas_lapack_dir``: [ ``/path/to/blas_lapack_dir`` ] Directory containing the libraries specified by ``blas_lapack_libs``. Not - needed if the libraries are installed in a standard location, e.g. + needed if the libraries are installed in a standard location such as ``/usr/lib``. - default: ``''`` @@ -367,7 +367,7 @@ Options List * ``lapack_names``: [ ``lower`` | ``upper`` ] Set depending on whether the procedure names in the specified libraries are lowercase or uppercase. If you don't know, run ``nm`` on - the library file (e.g., ``nm libblas.a``). + the library file (for example, ``nm libblas.a``). - default: ``'lower'`` @@ -413,7 +413,7 @@ Options List * ``env_vars``: [ ``string`` ] Environment variables to propagate through to SCons. Either the - string ``all`` or a comma separated list of variable names, e.g. + string ``all`` or a comma separated list of variable names such as ``LD_LIBRARY_PATH,HOME``. - default: ``'LD_LIBRARY_PATH,PYTHONPATH'`` @@ -429,7 +429,7 @@ Options List * ``cxx_flags``: [ ``string`` ] Compiler flags passed to the C++ compiler only. Separate multiple - options with spaces, e.g., ``cxx_flags='-g -Wextra -O3 --std=c++11'`` + options with spaces, such as ``cxx_flags='-g -Wextra -O3 --std=c++11'`` - default: ``''`` @@ -515,7 +515,7 @@ Options List * ``warning_flags``: [ ``string`` ] Additional compiler flags passed to the C/C++ compiler to enable extra warnings. Used only when compiling source code that is part of - Cantera (e.g. excluding code in the 'ext' directory). + Cantera (for example, excluding code in the 'ext' directory). - default: ``''`` @@ -539,7 +539,7 @@ Options List * ``boost_inc_dir``: [ ``/path/to/boost_inc_dir`` ] Location of the Boost header files. Not needed if the headers are - installed in a standard location, e.g. ``/usr/include``. + installed in a standard location such as ``/usr/include``. - default: ``''`` @@ -547,7 +547,7 @@ Options List * ``stage_dir``: [ ``/path/to/stage_dir`` ] Directory relative to the Cantera source directory to be used as a - staging area for building e.g., a Debian package. If specified, + staging area for building for example, a Debian package. If specified, ``scons install`` will install files to ``stage_dir/prefix/...``. - default: ``''`` @@ -562,7 +562,7 @@ Options List .. _gtest-flags: * ``gtest_flags``: [ ``string`` ] - Additional options passed to each GTest test suite, e.g. + Additional options passed to each GTest test suite, such as `--gtest_filter=*pattern*`. Separate multiple options with spaces. .. _renamed-shared-libraries: @@ -581,7 +581,7 @@ Options List * ``versioned_shared_library``: [ ``yes`` | ``no`` ] If enabled, create a versioned shared library, with symlinks to the - more generic library name, e.g. ``libcantera_shared.so.2.4.0`` as the + more generic library name, for example ``libcantera_shared.so.2.4.0`` as the actual library and ``libcantera_shared.so`` and ``libcantera_shared.so.2`` as symlinks. @@ -591,7 +591,7 @@ Options List * ``layout``: [ ``standard`` | ``compact`` | ``debian`` ] The layout of the directory structure. 'standard' installs files to - several subdirectories under 'prefix', e.g. $prefix/bin, + several subdirectories under 'prefix' -- for example, $prefix/bin, $prefix/include/cantera, $prefix/lib. This layout is best used in conjunction with 'prefix'='/usr/local'. 'compact' puts all installed files in the subdirectory defined by 'prefix'. This layout is best diff --git a/pages/compiling/configure-build-dev.rst b/pages/compiling/configure-build-dev.rst index 577c33581..23b90fdf6 100644 --- a/pages/compiling/configure-build-dev.rst +++ b/pages/compiling/configure-build-dev.rst @@ -21,7 +21,7 @@ Determine configuration options see all of the options on the :ref:`Configuration Options ` page. * Configuration options are specified as additional arguments to the ``scons`` - command, e.g.: + command. For example: .. code:: bash @@ -48,7 +48,7 @@ Determine configuration options scons command option_name= * Sometimes, changes in your environment can cause SCons's configuration tests - (e.g., checking for libraries or compiler capabilities) to unexpectedly fail. + (for example, checking for libraries or compiler capabilities) to unexpectedly fail. To force SCons to re-run these tests rather than trusting the cached results, run scons with the option ``--config=force``. @@ -111,7 +111,7 @@ Windows Only Options * In Windows there aren't any proper default locations for many of the packages that Cantera depends on, so you will need to specify these paths explicitly. -* Remember to put double quotes around any paths with spaces in them, e.g. +* Remember to put double quotes around any paths with spaces in them, such as ``"C:\Program Files"``. * By default, SCons attempts to use the same architecture as the copy of Python @@ -169,8 +169,8 @@ Less Common Options Build Commands ============== -The following options are possible as commands to SCons, i.e., the first -argument after ``scons``: +The following options are possible as commands to SCons (that is, the first +argument after ``scons``): .. code:: bash @@ -210,7 +210,7 @@ argument after ``scons``: * ``scons dump`` Dump the state of the SCons environment to the - screen instead of doing ````, e.g. + screen instead of doing ````, for example, ``scons build dump``. For debugging purposes. * ``scons samples`` diff --git a/pages/compiling/configure-build.rst b/pages/compiling/configure-build.rst index 244e13603..1b2a04b35 100644 --- a/pages/compiling/configure-build.rst +++ b/pages/compiling/configure-build.rst @@ -21,7 +21,7 @@ Determine configuration options see all of the options on the :ref:`Configuration Options ` page. * Configuration options are specified as additional arguments to the ``scons`` - command, e.g.: + command. For example: .. code:: bash @@ -48,7 +48,7 @@ Determine configuration options scons command option_name= * Sometimes, changes in your environment can cause SCons's configuration tests - (e.g., checking for libraries or compiler capabilities) to unexpectedly fail. + (for example, checking for libraries or compiler capabilities) to unexpectedly fail. To force SCons to re-run these tests rather than trusting the cached results, run scons with the option ``--config=force``. @@ -103,7 +103,7 @@ Python 2 Module Options ^^^^^^^^^^^^^^^^^^^^^^^ By default, if SCons detects a Python 2 interpreter installed in a -default location (i.e., ``python2`` is on the ``PATH`` environment +default location (that is, if ``python2`` is on the ``PATH`` environment variable) or ``python2_package`` is ``full``, SCons will try to build the Python module for Python 2. The following SCons options control how the Python 2 module is built: @@ -116,7 +116,7 @@ Python 3 Module Options ^^^^^^^^^^^^^^^^^^^^^^^ By default, if SCons detects a Python 3 interpreter installed in a -default location (i.e., ``python3`` is on the ``PATH`` environment +default location (that is, if ``python3`` is on the ``PATH`` environment variable) or ``python3_package`` is ``full``, SCons will try to build the Python module for Python 3. The following SCons options control how the Python 3 module is built: @@ -139,7 +139,7 @@ Windows Only Options * In Windows there aren't any proper default locations for many of the packages that Cantera depends on, so you will need to specify these paths explicitly. -* Remember to put double quotes around any paths with spaces in them, e.g. +* Remember to put double quotes around any paths with spaces in them, such as ``"C:\Program Files"``. * By default, SCons attempts to use the same architecture as the copy of Python @@ -197,8 +197,8 @@ Less Common Options Build Commands ============== -The following options are possible as commands to SCons, i.e., the first -argument after ``scons``: +The following options are possible as commands to SCons (that is, the first +argument after ``scons``): .. code:: bash @@ -238,7 +238,7 @@ argument after ``scons``: * ``scons dump`` Dump the state of the SCons environment to the - screen instead of doing ````, e.g. + screen instead of doing ````, for example, ``scons build dump``. For debugging purposes. * ``scons samples`` diff --git a/pages/compiling/dependencies.rst b/pages/compiling/dependencies.rst index ca4c98bbb..3289cf0fc 100644 --- a/pages/compiling/dependencies.rst +++ b/pages/compiling/dependencies.rst @@ -138,6 +138,13 @@ Optional Programs * Required version >=0.23 to build the Python module. Must be installed for the same Python where SCons is installed. +* `Ruamel.yaml `__ + + * Required to convert input files from Chemkin, CTI, and XML to the YAML + format + * Known to work with versions 0.15.42, 0.15.87, and 0.16.5 + * Expected to work with versions >= 0.15.0 + * `3to2 `__ * Used to convert Python examples to Python 2 syntax. diff --git a/pages/compiling/installation-reqs.rst b/pages/compiling/installation-reqs.rst index 65c4379f6..8c6596661 100644 --- a/pages/compiling/installation-reqs.rst +++ b/pages/compiling/installation-reqs.rst @@ -84,7 +84,7 @@ Conda Requirements .. code:: bash - conda create --name cantera python=3 scons cython boost numpy + conda create --name cantera python=3 scons cython boost numpy ruamel_yaml conda activate cantera * (Optional) If you also want to build the documentation, after you've created the environment and @@ -230,7 +230,7 @@ Ubuntu & Debian * In addition to the general packages, building the Python 3 module also requires:: - cython python3 python3-dev python3-setuptools python3-numpy + cython python3 python3-dev python3-setuptools python3-numpy python3-ruamel.yaml * In addition to the general packages, building the Fortran module also requires:: @@ -274,7 +274,7 @@ Fedora & RHEL * In addition to the general packages, building the Python 3 module also requires:: - python3 python3-setuptools python3-devel Cython python3-numpy + python3 python3-setuptools python3-devel Cython python3-numpy python3-ruamel-yaml * In addition to the general packages, building the Fortran module also requires:: @@ -320,7 +320,7 @@ OpenSUSE & SUSE Linux Enterprise * In addition to the general packages, building the Python 3 module also requires:: - python-Cython python3 python3-devel python3-setuptools python3-numpy python3-numpy-devel + python-Cython python3 python3-devel python3-setuptools python3-numpy python3-numpy-devel python3-ruamel.yaml * In addition to the general packages, building the Fortran module also requires:: @@ -376,7 +376,7 @@ General Notes * It is generally helpful to have SCons and Python in your ``PATH`` environment variable. This can be done by checking the appropriate box during the installation of Python or can be accomplished by adding the top-level Python - directory and the ``Scripts`` subdirectory (e.g., + directory and the ``Scripts`` subdirectory (for example, ``C:\Python36;C:\Python36\Scripts``) to your ``PATH``. The dialog to change the ``PATH`` is accessible from:: @@ -385,9 +385,10 @@ General Notes Make sure that the installation of Python that has SCons comes first on your ``PATH``. -* In order to use SCons to install Cantera to a system folder (e.g. ``C:\Program - Files\Cantera``) you must run the ``scons install`` command in a command - prompt that has been launched by selecting the *Run as Administrator* option. +* In order to use SCons to install Cantera to a system folder (for example, + ``C:\Program Files\Cantera``) you must run the ``scons install`` command in a + command prompt that has been launched by selecting the *Run as Administrator* + option. .. _sec-windows-reqs: @@ -491,23 +492,27 @@ Windows Requirements pip3 install C:\Path\to\downloaded\file\package-file-name.whl - * Cython + * Cython - * http://www.lfd.uci.edu/~gohlke/pythonlibs/#cython + * http://www.lfd.uci.edu/~gohlke/pythonlibs/#cython - * Download the ``*.whl`` file for your Python architecture (32-bit or 64-bit) - and Python X.Y (indicated by ``cpXY`` in the file name), where X and Y are the - major and minor versions of the Python where you installed SCons. + * Download the ``*.whl`` file for your Python architecture (32-bit or 64-bit) + and Python X.Y (indicated by ``cpXY`` in the file name), where X and Y are the + major and minor versions of the Python where you installed SCons. - * Cython must be installed in the version of Python that has SCons installed + * Cython must be installed in the version of Python that has SCons installed - * NumPy + * NumPy + + * http://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy + + * Download the ``*.whl`` file for your Python architecture (32-bit or 64-bit) + and Python X.Y (indicated by ``cpXY`` in the file name), where X and Y are the + major and minor versions of Python. - * http://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy + * Ruamel.yaml:: - * Download the ``*.whl`` file for your Python architecture (32-bit or 64-bit) - and Python X.Y (indicated by ``cpXY`` in the file name), where X and Y are the - major and minor versions of Python. + pip install ruamel.yaml * In addition to the general software, building the MATLAB toolbox also requires: diff --git a/pages/compiling/special-cases.rst b/pages/compiling/special-cases.rst index 6dad7032f..3357418c7 100644 --- a/pages/compiling/special-cases.rst +++ b/pages/compiling/special-cases.rst @@ -47,7 +47,7 @@ Intel Compilers https://software.intel.com/en-us/forums/intel-c-compiler/topic/684987 * Before compiling Cantera, you may need to set up the appropriate environment - variables for the Intel compiler suite, e.g.: + variables for the Intel compiler suite. For example: .. code:: bash diff --git a/pages/documentation/dev-docs.html b/pages/documentation/dev-docs.html index 98aeeacb4..39b78837a 100644 --- a/pages/documentation/dev-docs.html +++ b/pages/documentation/dev-docs.html @@ -111,6 +111,16 @@

Search the documentation

Other Documentation
+
+ + YAML Input File Users' Guide + +
+
+ + YAML Input File API Reference + +
CTI Input File Class Reference diff --git a/pages/documentation/index.html b/pages/documentation/index.html index 58a378742..81095758b 100644 --- a/pages/documentation/index.html +++ b/pages/documentation/index.html @@ -10,7 +10,9 @@

Documentation

Sometimes you just need a little more detail. You'll find documentation for - (almost) every function in Cantera right here. + (almost) every function in Cantera right here. This is the documentation for + the current stable release, Cantera 2.4.0. For other versions, see the links + at the bottom of the page.