Configure & Build Cantera¶
These directions are for the development version of Cantera. For the current release, see these instructions.
Determine configuration options¶
Run scons help to see a list of all of the configuration options for Cantera, or see all of the options on the Configuration Options page.
Configuration options are specified as additional arguments to the scons command, e.g.:
where scons is the program that manages the build steps, and command is most commonly one of
Other commands are possible, and are explained in the Build Commands section.
SCons saves configuration options specified on the command line in the file cantera.conf in the root directory of the source tree, so generally it is not necessary to respecify configuration options when rebuilding Cantera. To unset a previously set configuration option, either remove the corresponding line from cantera.conf or use the syntax:
Sometimes, changes in your environment can cause SCons’s configuration tests (e.g., 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.
The following lists of options are not complete, they show only some commonly used options. The entire list of options can be found on the Configuration options page.
Python Module Options¶
Compiling the Cantera Python module requires that NumPy and Cython are installed for the target installation of Python. The following SCons options control how the Python module is built:
- By default, SCons will try to build the full Python interface for copy of Python that is running SCons. Use this option if you wish to build Cantera for a different Python installation.
For backwards compatibility, the following options are also allowed, but are overridden by the above options. These options will be removed in a future version of Cantera:
Windows Only Options¶
The cantera.conf file uses the backslash character \ as an escape character. When modifying this file, backslashes in paths need to be escaped like this: boost_inc_dir = 'C:\\Program Files (x86)\\boost\\include' This does not apply to paths specified on the command line. Alternatively, you can use forward slashes (/) in paths.
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. "C:\Program Files".
By default, SCons attempts to use the same architecture as the copy of Python that is running SCons, and the most recent installed version of the Visual Studio compiler. If you aren’t building the Python module, you can override this with the configuration options target_arch and msvc_version.
To compile with MinGW, specify the toolchain option:
MATLAB Toolbox Options¶
Building the MATLAB toolbox requires an installed copy of MATLAB, and the path to the directory where MATLAB is installed must be specified using the following option:
Fortran Module Options¶
Building the Fortran module requires a compatible Fortran comiler. SCons will attempt to find a compatible compiler by default in the PATH environment variable. The following options control how the Fortran module is built:
The following options control if the documentation is built:
The following options are possible as commands to SCons, i.e., the first argument after scons:
- scons help
- Print a description of user-specifiable options.
- scons build
- Compile Cantera and the language interfaces using default options.
- scons clean
- Delete files created while building Cantera.
- [sudo] scons install
- Install Cantera.
- [sudo] scons uninstall
- Uninstall Cantera.
- scons test
- Run all tests which did not previously pass or for which the results may have changed.
- scons test-reset
- Reset the passing status of all tests.
- scons test-clean
- Delete files created while running the tests.
- scons test-help
- List available tests.
- scons test-NAME
- Run the test named NAME.
- scons <command> dump
- Dump the state of the SCons environment to the screen instead of doing <command>, e.g. scons build dump. For debugging purposes.
- scons samples
- Compile the C++ and Fortran samples.
- scons msi
- Build a Windows installer (.msi) for Cantera.
- scons sphinx
- Build the Sphinx documentation
- scons doxygen
- Build the Doxygen documentation
Compile Cantera & Test¶
Run SCons with the list of desired configuration options:
If Cantera compiles successfully, you should see a message that looks like:
******************************************************* Compilation completed successfully. - To run the test suite, type 'scons test'. - To install, type '[sudo] scons install'. *******************************************************
If you do not see this message, check the output for errors to see what went wrong.
Cantera has a series of tests that can be run with the command:
- When the tests finish, you should see a summary indicating the number of tests that passed and failed.
- If you have tests that fail, try looking at the following to determine the
source of the error:
- Messages printed to the console while running scons test
- Output files generated by the tests