mirror of
https://github.com/Cantera/cantera.git
synced 2025-02-25 18:55:29 -06:00
148 lines
4.8 KiB
Plaintext
148 lines
4.8 KiB
Plaintext
|
|
Cantera should build 'out of the box' on systems running linux,
|
|
cygwin, Mac OS X, Solaris, and MS-Windows. The Windows build procedure
|
|
differs from the procedure for unix-like systems; it is described
|
|
after the unix build procedure.
|
|
|
|
The Python scripting language must be installed before building
|
|
Cantera, since a few Python scripts are run during the build
|
|
process. Linux and Mac OS X systems come with Python preinstalled; for
|
|
other systems, Python can be downloaded from www.python.org.
|
|
|
|
|
|
====================================================================
|
|
Unix/Linux Build Instructions
|
|
====================================================================
|
|
|
|
To build Cantera with a default configuration and install it in
|
|
/usr/local, type:
|
|
|
|
./configure
|
|
make
|
|
make install
|
|
|
|
To do 'make install', you may need to be super-user, or may need to
|
|
preface 'make install' by 'sudo' ('sudo make install').
|
|
|
|
Cantera applications will be put in /usr/local/bin, libraries will be
|
|
installed in a version-specific subdirectory of
|
|
/usr/local/lib/cantera, unix man pages will be installed under
|
|
/usr/share/man, C++ header files will be installed in
|
|
/usr/local/include/cantera, and various demos and data files will be
|
|
installed in subdirectories of /usr/local/cantera.
|
|
|
|
|
|
To install Cantera in a different directory:
|
|
|
|
./configure --prefix=/installation/dir
|
|
make
|
|
make install
|
|
|
|
Here '/installation/dir' should be replaced with the absolute path to
|
|
the installation directory. For example, to install in your home directory:
|
|
|
|
./configure --prefix=$HOME
|
|
make
|
|
make install
|
|
|
|
In this case, subdirectories bin, lib, include, man, and cantera will
|
|
be created within your home directory if they don't exist already, and
|
|
cantera will be installed into these directories.
|
|
|
|
|
|
Configuring the Environment
|
|
---------------------------
|
|
|
|
The build process will create a shell script 'cantera.cfg' that
|
|
configures the environment for Cantera. This script may be found in
|
|
directory 'cantera' within the installation directory
|
|
(i.e. '/usr/local/cantera'). This should be run by typing
|
|
|
|
source /usr/local/cantera/cantera.cfg
|
|
|
|
to set environment variables before using Cantera. It is recommended
|
|
to add this line to your shell login script, so that Cantera will be
|
|
correctly configured each time you log in.
|
|
|
|
|
|
The Python Interface
|
|
--------------------
|
|
|
|
If Python 2.x is installed, and the Numeric package is installed, then
|
|
the Cantera Python interface will be built and installed.
|
|
|
|
|
|
|
|
The MATLAB Toolbox
|
|
------------------
|
|
|
|
If MATLAB is present, the MATLAB toolbox will be built and installed.
|
|
If this is not desired, set environment variable BUILD_MATLAB_TOOLBOX
|
|
to anything but "y" before running the 'configure' script, or edit the 'configure' script to set
|
|
|
|
|
|
|
|
Customizing
|
|
-----------
|
|
|
|
The configure script may be customized by editing it to set the values
|
|
of various variables before running it. Alternatively, these variables
|
|
may be set in the environment before running configure.
|
|
|
|
Some of the variables that may be set are listed here.
|
|
|
|
MAKE set to 'make' utility compatible with GNU make
|
|
|
|
CXX C++ compiler (default: 'g++')
|
|
|
|
F77 Fortran 77 compiler (default: 'g77')
|
|
|
|
PYTHON_CMD Python interpreter to use with Cantera
|
|
(default: 'python')
|
|
|
|
MATLAB_CMD Matlab command (default: 'matlab')
|
|
|
|
|
|
|
|
|
|
|
|
====================================================================
|
|
Windows Build Instructions
|
|
====================================================================
|
|
|
|
Requirements:
|
|
|
|
1) cygwin (www.cygwin.com)
|
|
2) python (www.python.org)
|
|
3) MS Visual C++ 6.0
|
|
4) Compaq Visual Fortran 6.0
|
|
|
|
The Cantera build procedure for Windows requires the cygwin linux-like
|
|
environment, so that the 'configure' script can be run and the 'make'
|
|
utility used. Cygwin can be downloaded from www.cygwin.com. Only a
|
|
minimal cygwin installation is needed. In particular, no compilers are
|
|
required. During the installation of cygwin, you will be asked if text
|
|
files should use unix or DOS line endings; select DOS.
|
|
|
|
Cantera can be built under Windows using Microsoft Visual C++ 6.0 and
|
|
Compaq Visual Fortran 6.0.
|
|
|
|
To perform a Windows installation, open a cygwin shell window, go to the
|
|
top-level directory of the Cantera source tree, and type
|
|
|
|
./configure
|
|
|
|
By default, Cantera will be installed in c:/cantera; to change this,
|
|
specify the prefix option as described for the unix build procedure
|
|
above.
|
|
|
|
After running configure, start Visual Studio and open workspace
|
|
win32/cantera.dsw. Set the build configuration to 'Release' and build
|
|
project 'all'. When this finishes, return to the cygwin shell and type
|
|
|
|
make win
|
|
make win-install
|
|
|
|
After these commands finish, you should have a complete Cantera
|
|
installation including the Python interface and the Matlab toolbox.
|