""" SCons build script for Cantera Basic usage: 'scons help' - print a description of user-specifiable options. 'scons build' - Compile Cantera and the language interfaces using default options. 'cons clean' - Delete files created while building Cantera. '[sudo] scons install' - Install Cantera. 'scons test' - Run full regression test suite. 'scons test-clean' - Delete files created while running the regression tests. 'scons test-help' - List available regression tests. 'scons test-NAME' - Run the regression test named "FOO". 'scons samples' - Compile the C++ and Fortran samples 'scons msi' - Build a Windows installer (.msi) for Cantera. """ from buildutils import * if not COMMAND_LINE_TARGETS: # Print usage help print __doc__ sys.exit(0) extraEnvArgs = {} if 'clean' in COMMAND_LINE_TARGETS: removeDirectory('build') removeDirectory('stage') removeDirectory('.sconf_temp') removeFile('.sconsign.dblite') for name in os.listdir('.'): if name.endswith('.msi'): removeFile(name) print 'Done removing output files.' sys.exit(0) # ****************************************************** # *** Set system-dependent defaults for some options *** # ****************************************************** opts = Variables('cantera.conf') if os.name == 'nt': # On Windows, use the same version of Visual Studio that was used # to compile Python, and target the same architecture, unless # the user specified another option pycomp = platform.python_compiler() if pycomp.startswith('MSC v.1400'): msvc_version = '8.0' # Visual Studio 2005 elif pycomp.startswith('MSC v.1500'): msvc_version = '9.0' # Visual Studio 2008 elif pycomp.startswith('MSC v.1600'): msvc_version = '10.0' # Visual Studio 2010 else: msvc_version = None if '64 bit' in pycomp: target_arch = 'amd64' else: target_arch = 'x86' opts.AddVariables( ('msvc_version', """Version of Visual Studio to use. The default is the same version that was used to compile the installed version of Python.""", msvc_version), ('target_arch', """Target architecture. The default is the same architecture as the installed version of Python""", target_arch), EnumVariable( 'toolchain', """The preferred compiler toolchain.""", 'msvc', ('msvc', 'mingw', 'intel'))) pickCompilerEnv = Environment() opts.Update(pickCompilerEnv) if pickCompilerEnv['toolchain'] == 'msvc': toolchain = ['default'] if msvc_version: extraEnvArgs['MSVC_VERSION'] = pickCompilerEnv['msvc_version'] elif pickCompilerEnv['toolchain'] == 'mingw': toolchain = ['mingw', 'f90'] extraEnvArgs['F77'] = None # Next line fixes http://scons.tigris.org/issues/show_bug.cgi?id=2683 extraEnvArgs['WINDOWS_INSERT_DEF'] = 1 elif pickCompilerEnv['toolchain'] == 'intel': toolchain = ['intelc'] # note: untested extraEnvArgs['TARGET_ARCH'] = pickCompilerEnv['target_arch'] else: toolchain = ['default'] env = Environment(tools=toolchain+['textfile', 'subst', 'recursiveInstall', 'wix'], ENV={'PATH': os.environ['PATH']}, toolchain=toolchain, **extraEnvArgs) # # To print the current environment # # print env.Dump() env['OS'] = platform.system() env['OS_BITS'] = int(platform.architecture()[0][:2]) # Fixes a linker error in Windows if os.name == 'nt' and 'TMP' in os.environ: env['ENV']['TMP'] = os.environ['TMP'] # Fixes issues with Python subprocesses. See http://bugs.python.org/issue13524 if os.name == 'nt': env['ENV']['SystemRoot'] = os.environ['SystemRoot'] # Needed for Matlab to source ~/.matlab7rc.sh if 'HOME' in os.environ: env['ENV']['HOME'] = os.environ['HOME'] # Fix an issue with Unicode sneaking into the environment on Windows if os.name == 'nt': for key,val in env['ENV'].iteritems(): env['ENV'][key] = str(val) add_RegressionTest(env) class defaults: pass if os.name == 'posix': defaults.prefix = '/usr/local' # defaults.boostIncDir = '/usr/include' # defaults.boostLibDir = '/usr/lib' defaults.boostIncDir = '' defaults.boostLibDir = '' env['INSTALL_MANPAGES'] = True elif os.name == 'nt': defaults.prefix = pjoin(os.environ['ProgramFiles'], 'Cantera') defaults.boostIncDir = '' defaults.boostLibDir = '' env['INSTALL_MANPAGES'] = False else: print "Error: Unrecognized operating system '%s'" % os.name sys.exit(1) opts.AddVariables( ('CXX', 'The C++ compiler to use.', env['CXX']), ('CC', """The C compiler to use. This is only used to compile CVODE and the Python extension module.""", env['CC']), ) opts.Update(env) defaults.cxxFlags = '' defaults.ccFlags = '' defaults.noOptimizeCcFlags = '' defaults.optimizeCcFlags = '' defaults.debugCcFlags = '' defaults.noDebugCcFlags = '' defaults.debugLinkFlags = '' defaults.noDebugLinkFlags = '' if env['CC'] == 'gcc' or env['CC'] == 'llvm-gcc': defaults.cxxFlags = '-ftemplate-depth-128' defaults.ccFlags = '-Wall -Wno-deprecated-declarations' defaults.debugCcFlags = '-g' defaults.noOptimizeCcFlags = '-O0 -fno-inline' defaults.optimizeCcFlags = '-O3 -DNDEBUG -finline-functions -Wno-inline' elif env['CC'] == 'cl': # Visual Studio defaults.cxxFlags = '/EHsc' defaults.ccFlags = ' '.join(['/MD', '/nologo', '/W3', '/Zc:wchar_t', '/Zc:forScope', '/D_SCL_SECURE_NO_WARNINGS', '/D_CRT_SECURE_NO_WARNINGS', '/wd4996']) defaults.debugCcFlags = '/Zi /Fd${TARGET}.pdb' defaults.noOptimizeCcFlags = '/Od /Ob0' defaults.optimizeCcFlags = '/O2 /DNDEBUG' defaults.debugLinkFlags = '/DEBUG' elif env['CC'] == 'icc': defaults.cxxFlags = '-ftemplate-depth-128' defaults.ccFlags = '-Wcheck -vec-report0 -diag-disable 1478' defaults.debugCcFlags = '-g' defaults.noOptimizeCcFlags = '-O0 -fno-inline' defaults.optimizeCcFlags = '-O3 -finline-functions -DNDEBUG' elif env['CC'] == 'clang': defaults.cxxFlags = '' defaults.ccFlags = '-Wall -fcolor-diagnostics -Wno-deprecated-declarations' defaults.debugCcFlags = '-g' defaults.noOptimizeCcFlags = '-O0' defaults.optimizeCcFlags = '-O3 -DNDEBUG' else: print "WARNING: Unrecognized C compiler '%s'" % env['CC'] # TODO: Once deprecated functions have been removed, remove the # compiler options: -Wno-deprecated-declarations and /wd4996 if env['OS'] in ('Windows', 'Darwin'): defaults.threadFlags = '' else: defaults.threadFlags = '-pthread' # ************************************** # *** Read user-configurable options *** # ************************************** # This check prevents requiring root permissions to build when the # installation directory is not writable by the current user. if 'install' in COMMAND_LINE_TARGETS: installPathTest = PathVariable.PathIsDirCreate else: installPathTest = PathVariable.PathAccept opts.AddVariables( PathVariable( 'prefix', 'Set this to the directory where Cantera should be installed.', defaults.prefix, installPathTest), EnumVariable( 'python_package', """If you plan to work in Python, or you want to use the graphical MixMaster application, 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 to process .cti files, then you only need a 'minimal' subset of the package (actually, only one file). The default behavior is to build the Python package if the required prerequisites (numpy) are installed.""", 'default', ('full', 'minimal', 'none','default')), PathVariable( 'python_cmd', """Cantera needs to know where to find the Python interpreter. If PYTHON_CMD is not set, then the configuration process will use the same Python interpreter being used by SCons.""", sys.executable), EnumVariable( 'python_array', """The Cantera Python interface requires one of the Python array packages listed. Support for the legacy 'numeric' and 'numarray' packages is deprecated, and will be removed in a future version of Cantera.""", 'numpy', ('numpy', 'numarray', 'numeric')), PathVariable( 'python_array_home', """If numpy was installed using the --home option, set this to the home directory for numpy.""", '', PathVariable.PathAccept), PathVariable( 'python_prefix', """If you want to install the Cantera Python package somewhere other than the default 'site-packages' directory within the Python library directory, then set this to the desired directory. This is useful when you do not have write access to the Python library directory.""", '', PathVariable.PathAccept), EnumVariable( 'matlab_toolbox', """This variable controls whether the Matlab toolbox will be built. If set to 'y', you will also need to set the value of the 'matlab_path' variable. If set to 'default', the Matlab toolbox will be built if 'matlab_path' is set.""", 'default', ('y', 'n', 'default')), PathVariable( 'matlab_path', """Path to the Matlab install directory. This should be the directory containing the 'extern', 'bin', etc. subdirectories. Typical values are: "C:/Program Files/MATLAB/R2011a" on Windows, "/Applications/MATLAB_R2011a.app" on OS X, or "/opt/MATLAB/R2011a" on Linux.""", '', PathVariable.PathAccept), EnumVariable( 'f90_interface', """This variable controls whether the Fortran 90/95 interface will be built. If set to 'default', the builder will look for a compatible Fortran compiler in the $PATH, and compile the Fortran 90 interface if one is found.""", 'default', ('y', 'n', 'default')), PathVariable( 'F90', """The Fortran 90 compiler. If unspecified, the builder will look for a compatible compiler (gfortran, ifort, g95) in the $PATH.""", '', PathVariable.PathAccept), ('F90FLAGS', 'Compilation options for the Fortran 90 compiler.', '-O3'), BoolVariable( 'debug_verbose', """Enable extra printing to aid in debugging. This code is marked by the preprocessor macros DEBUG_MODE and DEBUG_MODE_ENABLED.""", False), BoolVariable( 'coverage', """Enable collection of code coverage information with gcov. Available only when compiling with gcc.""", False), BoolVariable( 'doxygen_docs', """Build HTML documentation for the C++ interface using Doxygen""", False), BoolVariable( 'sphinx_docs', """Build HTML documentation for the Python module using Sphinx""", False), BoolVariable( 'with_lattice_solid', """Include thermodynamic model for lattice solids in the Cantera kernel.""", True), BoolVariable( 'with_metal', """Include thermodynamic model for metals in the Cantera kernel.""", True), BoolVariable( 'with_stoich_substance', """Include thermodynamic model for stoichiometric substances in the Cantera kernel.""", True), BoolVariable( 'with_semiconductor', """Include thermodynamic model for semiconductors in the Cantera kernel.""", True), BoolVariable( 'with_adsorbate', """Include thermodynamic model for adsorbates in the Cantera kernel""", True), BoolVariable( 'with_spectra', """Include spectroscopy capability in the Cantera kernel.""", True), BoolVariable( 'with_pure_fluids', """Include accurate liquid/vapor equations of state for several fluids, including water, nitrogen, hydrogen, oxygen, methane, and HFC-134a.""", True), BoolVariable( 'with_real_gases', """Enable the Redlich-Kwong MFTP real gas model.""", True), BoolVariable( 'with_ideal_solutions', """Include capabilities for working with ideal solutions.""", True), BoolVariable( 'with_electrolytes', """Enable expanded electrochemistry capabilities, including thermodynamic models for electrolyte solutions.""", True), BoolVariable( 'with_prime', """Enable generating phase models from PrIMe models. For more information about PrIME, see http://www.primekinetics.org WARNING: Support for PrIMe is experimental!""", False), BoolVariable( 'with_h298modify_capability', """Enable changing the 298K heats of formation directly via the C++ layer.""", False), BoolVariable( 'enable_ck', """Build the ck2cti program that converts Chemkin input files to Cantera format (.cti). If you don't use Chemkin format files, or if you run ck2cti on some other machine, you can set this to 'n'.""", True), BoolVariable( 'with_kinetics', """Enable homogeneous kinetics.""", True), BoolVariable( 'with_hetero_kinetics', """Enable heterogeneous kinetics (surface chemistry). This also enables charge transfer reactions for electrochemistry.""", True), BoolVariable( 'with_reaction_paths', """Enable reaction path analysis""", True), BoolVariable( 'with_vcsnonideal', """Enable vcs equilibrium package for nonideal phases""", True), BoolVariable( 'enable_transport', 'Enable transport property calculations.', True), BoolVariable( 'enable_equil', 'Enable chemical equilibrium calculations', True), BoolVariable( 'enable_reactors', 'Enable stirred reactor models', True), BoolVariable( 'enable_flow1d', 'Enable one-dimensional flow models', True), BoolVariable( 'enable_solvers', 'Enable ODE integrators and DAE solvers', True), BoolVariable( 'with_html_log_files', """write HTML log files. Some multiphase equilibrium procedures can write copious diagnostic log messages. Set this to 'n' to disable this capability. (results in slightly faster equilibrium calculations)""", True), EnumVariable( 'use_sundials', """Cantera uses the CVODE or CVODES ODE integrator to time-integrate reactor network ODE's and for various other purposes. An older version of CVODE comes with Cantera, but it is possible to use the latest version as well, which now supports sensitivity analysis (CVODES). CVODES is a part of the 'sundials' package from Lawrence Livermore National Laboratory. Sundials is not distributed with Cantera, but it is free software that may be downloaded and installed separately. If you leave USE_SUNDIALS = 'default', then it will be used if you have it, and if not the older CVODE will be used. Or set USE_SUNDIALS to 'y' or 'n' to force using it or not. Note that sensitivity analysis with Cantera requires use of sundials. See: http://www.llnl.gov/CASC/sundials""", 'default', ('default', 'y', 'n')), PathVariable( 'sundials_include', """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.""", '', PathVariable.PathAccept), PathVariable( 'sundials_libdir', """The directory where the sundials static libraries are installed. Not needed if the libraries are installed in a standard location, e.g. /usr/lib.""", '', PathVariable.PathAccept), ('blas_lapack_libs', """Cantera comes with Fortran (or C) versions of those parts of BLAS and LAPACK it requires. But performance may be better if you use a version of these libraries optimized for your machine hardware. If you want to use your own libraries, set blas_lapack_libs to the the list of libraries that should be passed to the linker, separated by commas, e.g. "lapack,blas" or "lapack,f77blas,cblas,atlas". """, ''), PathVariable('blas_lapack_dir', """Directory containing the libraries specified by 'blas_lapack_libs'.""", '', PathVariable.PathAccept), EnumVariable( 'lapack_names', """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').""", 'lower', ('lower','upper')), BoolVariable( 'lapack_ftn_trailing_underscore', '', True), BoolVariable( 'lapack_ftn_string_len_at_end', '', True), ('env_vars', """Environment variables to propagate through to SCons. Either the string "all" or a comma separated list of variable names, e.g. 'LD_LIBRARY_PATH,HOME'""", ''), ('cxx_flags', 'Compiler flags passed to the C++ compiler only.', defaults.cxxFlags), ('cc_flags', 'Compiler flags passed to both the C and C++ compilers, regardless of optimization level', defaults.ccFlags), ('thread_flags', 'Compiler and linker flags for POSIX multithreading support', defaults.threadFlags), BoolVariable( 'optimize', """Enable extra compiler optimizations specified by the "optimize_flags" variable, instead of the flags specified by the "debug_flags" variable""", True), ('optimize_flags', 'Additional compiler flags passed to the C/C++ compiler when optimize=yes.', defaults.optimizeCcFlags), ('no_optimize_flags', 'Additional compiler flags passed to the C/C++ compiler when optimize=no.', defaults.noOptimizeCcFlags), BoolVariable( 'debug', """Enable compiler debugging symbols.""", True), ('debug_flags', 'Additional compiler flags passed to the C/C++ compiler when debug=yes.', defaults.debugCcFlags), ('no_debug_flags', 'Additional compiler flags passed to the C/C++ compiler when debug=no.', defaults.noDebugCcFlags), ('debug_linker_flags', 'Additional options passed to the linker when debug=yes', defaults.debugLinkFlags), ('no_debug_linker_flags', 'Additional options passed to the linker when debug=yes', defaults.noDebugLinkFlags), BoolVariable( 'build_thread_safe', """Cantera can be built so that it is thread safe. Doing so requires using procedures from the Boost library, so if you want thread safety then you need to get and install Boost (http://www.boost.org) if you don't have it. This is turned off by default, in which case Boost is not required to build Cantera.""", False), PathVariable( 'boost_inc_dir', 'Location of the Boost header files', defaults.boostIncDir, PathVariable.PathAccept), PathVariable( 'boost_lib_dir', 'Directory containing the Boost.Thread library', defaults.boostLibDir, PathVariable.PathAccept), ('boost_thread_lib', 'The name of the Boost.Thread library.', 'boost_thread'), BoolVariable( 'build_with_f2c', """For external procedures written in Fortran 77, both the original F77 source code and C source code generated by the 'f2c' program are included. Set this to "n" if you want to build Cantera using the F77 sources in the ext directory.""", True), ('F77', """Compiler used to build the external Fortran 77 procedures from the Fortran source code""", env['F77']), ('F77FLAGS', """Fortran 77 Compiler flags. Note that the Fortran compiler flags must be set to produce object code compatible with the C/C++ compiler you are using.""", '-O3'), PathVariable( '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, 'scons install' will install files to 'stage_dir/prefix/...' instead of installing into the local filesystem.""", '', PathVariable.PathAccept), BoolVariable( 'legacy_headers', """Create symbolic links for headers that were installed to the 'kernel' subdirectory in previous versions of Cantera.""", False), BoolVariable( 'renamed_shared_libraries', """If this option is turned on, which is the default, the shared libraries that are created will be renamed to have a "_shared" extension added to their base name. If not, the base names will be the same as the static libraries. In some cases this simplifies subsequent linking environments with static libaries and avoids a bug with using valgrind with the -static linking flag.""", True), PathVariable( 'graphvizdir', """The directory location of the graphviz program, "dot". dot is used for creating the documentation, and for making reaction path diagrams. If "dot" is in your path, you can leave this unspecified. NOTE: Matlab comes with a stripped-down version of 'dot'. If 'dot' is on your path, make sure it is not the Matlab version!""", '', PathVariable.PathAccept), ('rpfont', """The font to use in reaction path diagrams. This must be a font name recognized by the 'dot' program. On linux systems, this should be lowercase 'helvetica'.""", 'Helvetica'), ('cantera_version', '', '2.0.0b1') ) opts.Update(env) opts.Save('cantera.conf', env) if 'help' in COMMAND_LINE_TARGETS: ### Print help about configuration options and exit. print """ ************************************************** * Configuration options for building Cantera * ************************************************** The following options can be passed to SCons to customize the Cantera build process. They should be given in the form: scons build option1=value1 option2=value2 Variables set in this way will be stored in the 'cantera.conf' file and reused automatically on subsequent invocations of scons. Alternatively, the configuration options can be entered directly into 'cantera.conf' before running 'scons build'. The format of this file is: option1 = 'value1' option2 = 'value2' ************************************************** """ for opt in opts.options: print '\n'.join(formatOption(env, opt)) sys.exit(0) # ******************************************** # *** Configure system-specific properties *** # ******************************************** # Copy in external environment variables if env['env_vars'] == 'all': env['ENV'].update(os.environ) elif env['env_vars']: for name in env['env_vars'].split(','): if name in os.environ: env['ENV'][name] = os.environ[name] else: print 'WARNING: failed to propagate environment variable', name # Try to find a Fortran compiler: if env['f90_interface'] in ('y','default'): foundF90 = False if env['F90']: env['f90_interface'] = 'y' if which(env['F90']) is not None: foundF90 = True else: print "WARNING: Couldn't find specified Fortran compiler: '%s'" % env['F90'] for compiler in ['gfortran', 'ifort', 'g95']: if foundF90: break if which(compiler) is not None: print "INFO: Using '%s' to build the Fortran 90 interface" % which(compiler) env['F90'] = compiler foundF90 = True if foundF90: env['f90_interface'] = 'y' elif env['f90_interface'] == 'y': print "ERROR: Couldn't find a suitable Fortran compiler to build the Fortran 90 interface" sys.exit(1) else: print "INFO: Skipping compilation of the Fortran 90 interface." if env['F90'] == 'gfortran': env['FORTRANMODDIRPREFIX'] = '-J' elif env['F90'] == 'g95': env['FORTRANMODDIRPREFIX'] = '-fmod=' elif env['F90'] == 'ifort': env['FORTRANMODDIRPREFIX'] = '-module ' env['FORTRANMODDIR'] = '${TARGET.dir}' if env['CC'] == 'cl': # embed manifest file env['LINKCOM'] = [env['LINKCOM'], 'if exist ${TARGET}.manifest mt.exe -nologo -manifest ${TARGET}.manifest -outputresource:$TARGET;1'] env['SHLINKCOM'] = [env['SHLINKCOM'], 'if exist ${TARGET}.manifest mt.exe -nologo -manifest ${TARGET}.manifest -outputresource:$TARGET;2'] if env['boost_inc_dir']: env.Append(CPPPATH=env['boost_inc_dir']) if (env['use_sundials'] == 'default' and (env['sundials_include'] or env['sundials_libdir'])): env['use_sundials'] = 'y' if env['use_sundials'] in ('y','default'): if env['sundials_include']: env.Append(CPPPATH=[env['sundials_include']]) if env['sundials_libdir']: env.Append(LIBPATH=[env['sundials_libdir']]) conf = Configure(env) # Set up compiler options before running configuration tests env['CXXFLAGS'] = listify(env['cxx_flags']) env['CCFLAGS'] = listify(env['cc_flags']) + listify(env['thread_flags']) env['LINKFLAGS'] += listify(env['thread_flags']) if env['optimize']: env['CCFLAGS'] += listify(env['optimize_flags']) else: env['CCFLAGS'] += listify(env['no_optimize_flags']) if env['debug']: env['CCFLAGS'] += listify(env['debug_flags']) env['LINKFLAGS'] += listify(env['debug_linker_flags']) else: env['CCFLAGS'] += listify(env['no_debug_flags']) env['LINKFLAGS'] += listify(env['no_debug_linker_flags']) if env['coverage']: if env['CC'] == 'gcc': env.Append(CCFLAGS=['-fprofile-arcs', '-ftest-coverage']) env.Append(LINKFLAGS=['-fprofile-arcs', '-ftest-coverage']) # ipdb() else: print 'Error: coverage testing is only available with GCC' exit(0) # First, a sanity check: if not conf.CheckCXXHeader('cmath', '<>'): print 'ERROR: The C++ compiler is not correctly configured.' sys.exit(0) env['HAS_SSTREAM'] = conf.CheckCXXHeader('sstream', '<>') env['HAS_TIMES_H'] = conf.CheckCHeader('sys/times.h', '""') env['HAS_UNISTD_H'] = conf.CheckCHeader('unistd.h', '""') env['HAS_MATH_H_ERF'] = conf.CheckDeclaration('erf', '#include ', 'C++') env['HAS_BOOST_MATH'] = conf.CheckCXXHeader('boost/math/special_functions/erf.hpp', '<>') env['HAS_SUNDIALS'] = conf.CheckLibWithHeader('sundials_cvodes', 'cvodes/cvodes.h', 'C++', 'CVodeCreate(CV_BDF, CV_NEWTON);', False) env['NEED_LIBM'] = not conf.CheckLibWithHeader(None, 'math.h', 'C', 'double x; log(x);', False) if env['NEED_LIBM']: env['LIBM'] = ['m'] else: env['LIBM'] = [] if env['HAS_SUNDIALS'] and env['use_sundials'] != 'n': # Determine Sundials version sundials_version_source = """ #include #include "sundials/sundials_config.h" int main(int argc, char** argv) { std::cout << SUNDIALS_PACKAGE_VERSION << std::endl; return 0; }""" retcode, sundials_version = conf.TryRun(sundials_version_source, '.cpp') if retcode == 0: print """ERROR: Failed to determine Sundials version.""" sys.exit(0) # Ignore the minor version, e.g. 2.4.x -> 2.4 env['sundials_version'] = '.'.join(sundials_version.strip().split('.')[:2]) print """INFO: Using Sundials version %s""" % sundials_version.strip() env = conf.Finish() if env['python_package'] in ('full','default'): # Test to see if we can import the specified array module warnNoPython = False if env['python_array_home']: sys.path.append(env['python_array_home']) try: np = __import__(env['python_array']) try: env['python_array_include'] = np.get_include() except AttributeError: print """WARNING: Couldn't find include directory for Python array package""" env['python_array_include'] = '' print """INFO: Building the full Python package using %s.""" % env['python_array'] env['python_package'] = 'full' except ImportError: if env['python_package'] == 'full': print ("""ERROR: Unable to find the array package """ """'%s' required by the full Python package.""" % env['python_array']) sys.exit(1) else: print ("""WARNING: Not building the full Python package """ """ because the array package '%s' could not be found.""" % env['python_array']) warnNoPython = True env['python_package'] = 'minimal' else: warnNoPython = False env['python_array_include'] = '' # Matlab Toolbox settings if env['matlab_path'] != '' and env['matlab_toolbox'] == 'default': env['matlab_toolbox'] = 'y' if env['matlab_toolbox'] == 'y': matPath = env['matlab_path'] if matPath == '': print """ERROR: Unable to build the Matlab toolbox because 'matlab_path' has not been set.""" sys.exit(1) if not (os.path.isdir(matPath) and os.path.isdir(pjoin(matPath, 'extern'))): print """ERROR: Path set for 'matlab_path' is not correct.""" print """ERROR: Path was: '%s'""" % matPath sys.exit(1) # Sundials Settings if env['use_sundials'] == 'default': if env['HAS_SUNDIALS']: env['use_sundials'] = 'y' else: print "INFO: Sundials was not found. Building with minimal ODE solver capabilities." env['use_sundials'] = 'n' elif env['use_sundials'] == 'y' and not env['HAS_SUNDIALS']: print "ERROR: Unable to find Sundials headers and / or libraries." print "See config.log for details." sys.exit(1) elif env['use_sundials'] == 'y' and env['sundials_version'] not in ('2.2','2.3','2.4'): print """ERROR: Sundials version %r is not supported.""" sys.exit(1) # Deprecation warnings for old Sundials versions if env.get('sundials_version') in ('2.2', '2.3'): print 'WARNING: Support for Sundials %s is deprecated and will be removed.' % env['sundials_version'] print 'WARNING: Upgrading to Sundials 2.4 is strongly recommended.' # Deprecation warnings for numarray and numeric if env.get('python_array') in ('numarray', 'numeric'): print 'WARNING: Support for "%s" is deprecated and will be removed.' % env['python_array'] print 'WARNING: Upgrading to the "numpy" package is strongly recommended.' # ********************************************** # *** Set additional configuration variables *** # ********************************************** if env['blas_lapack_libs'] != '': env['blas_lapack_libs'] = env['blas_lapack_libs'].split(',') env['BUILD_BLAS_LAPACK'] = False elif env['OS'] == 'Darwin': env['BUILD_BLAS_LAPACK'] = False env.Append(FRAMEWORKS=['Accelerate']) else: # External BLAS/LAPACK were not given, so we need to compile them env['BUILD_BLAS_LAPACK'] = True env['blas_lapack_libs'] = [] # built into libcantera # Directories where things will be after actually being installed # These variables are the ones that are used to populate header files, # scripts, etc. env['ct_libdir'] = pjoin(env['prefix'], 'lib') env['ct_bindir'] = pjoin(env['prefix'], 'bin') env['ct_incdir'] = pjoin(env['prefix'], 'include', 'cantera') env['ct_incroot'] = pjoin(env['prefix'], 'include') env['ct_datadir'] = pjoin(env['prefix'], 'data') env['ct_sampledir'] = pjoin(env['prefix'], 'samples') env['ct_mandir'] = pjoin(env['prefix'], 'man1') env['ct_matlab_dir'] = pjoin(env['prefix'], 'matlab', 'toolbox') # Always set the stage directory before building an MSI installer if 'msi' in COMMAND_LINE_TARGETS: env['stage_dir'] = 'stage' env['prefix'] = '.' env['PYTHON_INSTALLER'] = 'binary' else: env['PYTHON_INSTALLER'] = 'direct' # Directories where things will be staged for package creation. These # variables should always be used by the Install(...) targets if env['stage_dir']: pp = env['python_prefix'] instRoot = pjoin(os.getcwd(), env['stage_dir'], stripDrive(env['prefix']).strip('/\\')) if env['python_prefix']: env['python_prefix'] = pjoin(os.getcwd(), env['stage_dir'], stripDrive(env['python_prefix']).strip('/\\')) else: env['python_prefix'] = pjoin(os.getcwd(), env['stage_dir']) else: instRoot = env['prefix'] env['inst_libdir'] = pjoin(instRoot, 'lib') env['inst_bindir'] = pjoin(instRoot, 'bin') env['inst_incdir'] = pjoin(instRoot, 'include', 'cantera') env['inst_incroot'] = pjoin(instRoot, 'include') env['inst_datadir'] = pjoin(instRoot, 'data') env['inst_sampledir'] = pjoin(instRoot, 'samples') env['inst_docdir'] = pjoin(instRoot, 'doc') env['inst_mandir'] = pjoin(instRoot, 'man1') env['inst_matlab_dir'] = pjoin(instRoot, 'matlab', 'toolbox') env['python_module_loc'] = pjoin(env['prefix'], 'lib', 'python%i.%i' % sys.version_info[:2], 'site-packages') # ************************************** # *** Set options needed in config.h *** # ************************************** configh = {'CANTERA_VERSION': quoted(env['cantera_version']), } # Conditional defines def cdefine(definevar, configvar, comp=True, value=1): if env.get(configvar) == comp: configh[definevar] = value else: configh[definevar] = None cdefine('DEBUG_MODE', 'debug_verbose') # Need to test all of these to see what platform.system() returns configh['SOLARIS'] = 1 if env['OS'] == 'Solaris' else None configh['DARWIN'] = 1 if env['OS'] == 'Darwin' else None configh['CYGWIN'] = 1 if env['OS'] == 'Cygwin' else None cdefine('NEEDS_GENERIC_TEMPL_STATIC_DECL', 'OS', 'Solaris') cdefine('HAS_NUMPY', 'python_array', 'numpy') cdefine('HAS_NUMARRAY', 'python_array', 'numarray') cdefine('HAS_NUMERIC', 'python_array', 'numeric') cdefine('HAS_NO_PYTHON', 'python_package', 'none') cdefine('HAS_SUNDIALS', 'use_sundials', 'y') if env['use_sundials']: cdefine('SUNDIALS_VERSION_22', 'sundials_version', '2.2') cdefine('SUNDIALS_VERSION_23', 'sundials_version', '2.3') cdefine('SUNDIALS_VERSION_24', 'sundials_version', '2.4') cdefine('WITH_ELECTROLYTES', 'with_electrolytes') cdefine('WITH_IDEAL_SOLUTIONS', 'with_ideal_solutions') cdefine('WITH_LATTICE_SOLID', 'with_lattice_solid') cdefine('WITH_METAL', 'with_metal') cdefine('WITH_STOICH_SUBSTANCE', 'with_stoich_substance') cdefine('WITH_SEMICONDUCTOR', 'with_semiconductor') cdefine('WITH_PRIME', 'with_prime') cdefine('H298MODIFY_CAPABILITY', 'with_h298modify_capability') cdefine('WITH_PURE_FLUIDS', 'with_pure_fluids') cdefine('WITH_HTML_LOGS', 'with_html_log_files') cdefine('WITH_VCSNONIDEAL', 'with_vcsnonideal') cdefine('WITH_REAL_GASES', 'with_real_gases') cdefine('LAPACK_FTN_STRING_LEN_AT_END', 'lapack_ftn_string_len_at_end') cdefine('LAPACK_FTN_TRAILING_UNDERSCORE', 'lapack_ftn_trailing_underscore') cdefine('FTN_TRAILING_UNDERSCORE', 'lapack_ftn_trailing_underscore') cdefine('LAPACK_NAMES_LOWERCASE', 'lapack_names', 'lower') configh['RXNPATH_FONT'] = quoted(env['rpfont']) cdefine('THREAD_SAFE_CANTERA', 'build_thread_safe') cdefine('HAS_SSTREAM', 'HAS_SSTREAM') if not env['HAS_MATH_H_ERF']: if env['HAS_BOOST_MATH']: configh['USE_BOOST_MATH'] = 1 else: print "Error: Couldn't find 'erf' in either or Boost.Math" sys.exit(1) else: configh['USE_BOOST_MATH'] = None config_h = env.Command('include/cantera/base/config.h', 'include/cantera/base/config.h.in', ConfigBuilder(configh)) env.AlwaysBuild(config_h) env['config_h_target'] = config_h if env['build_thread_safe']: env['use_boost_libs'] = True env['boost_libs'] = env['boost_thread_lib'] else: env['use_boost_libs'] = False env['boost_libs'] = [] # ********************* # *** Build Cantera *** # ********************* # Some options to speed up SCons env.SetOption('max_drift', 2) env.SetOption('implicit_cache', True) buildTargets = [] libraryTargets = [] # objects that go in the Cantera library installTargets = [] sampleTargets = [] def build(targets): """ Wrapper to add target to list of build targets """ buildTargets.extend(targets) return targets def buildSample(*args, **kwargs): """ Wrapper to add target to list of samples """ targets = args[0](*args[1:], **kwargs) sampleTargets.extend(targets) return targets def install(*args, **kwargs): """ Wrapper to add target to list of install targets """ if 'install' not in COMMAND_LINE_TARGETS: return if len(args) == 2: inst = env.Install(*args, **kwargs) else: inst = args[0](*args[1:], **kwargs) installTargets.extend(inst) return inst env.SConsignFile() env.Append(CPPPATH=[], LIBPATH=[Dir('build/lib')]) if 'install' in COMMAND_LINE_TARGETS: # Put headers in place headerBase = 'include/cantera' install(env.RecursiveInstall, '$inst_incdir', 'include/cantera') # Make symlinks to replicate old header directory structure if env['legacy_headers']: install(env.Command, pjoin('$inst_incdir', 'kernel'), [], Mkdir("$TARGET")) install('$inst_incdir', 'platform/legacy/Cantera_legacy.h') if env['OS'] == 'Windows': cmd = Copy("$TARGET", "$SOURCE") else: def RelativeSymlink(target, source, env): if os.path.exists(target[0].path): os.remove(target[0].path) srcpath = psplit(source[0].abspath) tgtpath = psplit(target[0].abspath) nCommon = max(i for i,(dir1,dir2) in enumerate(zip(srcpath, tgtpath)) if dir1 == dir2) relsrc = os.sep.join(['..'] + srcpath[nCommon-1:]) os.symlink(relsrc, target[0].abspath) cmd = RelativeSymlink for name in os.listdir('include/cantera'): if not os.path.isdir(pjoin('include/cantera', name)): continue for filename in os.listdir(pjoin('include/cantera', name)): if not filename.endswith('.h'): continue headerdir = pjoin(instRoot, 'include', 'cantera') install(env.Command, pjoin(headerdir, 'kernel', filename), pjoin(headerdir, name, filename), cmd) # Data files install('$inst_datadir', mglob(env, pjoin('data','inputs'), 'cti', 'xml')) ### List of libraries needed to link to Cantera ### linkLibs = ['cantera'] linkSharedLibs = ['cantera_shared'] if env['use_sundials'] == 'y': env['sundials_libs'] = ['sundials_cvodes', 'sundials_ida', 'sundials_nvecserial'] linkLibs.extend(('sundials_cvodes', 'sundials_ida', 'sundials_nvecserial')) linkSharedLibs.extend(('sundials_cvodes', 'sundials_ida', 'sundials_nvecserial')) else: env['sundials_libs'] = [] linkLibs.extend(['cvode']) linkSharedLibs.extend(['cvode_shared']) #print 'linkLibs = ', linkLibs linkLibs.append('ctmath') linkSharedLibs.append('ctmath_shared') # # Add lapack and blas to the link line # if env['blas_lapack_libs'] == []: linkLibs.extend(('ctlapack', 'ctblas')) linkSharedLibs.extend(('ctlapack_shared', 'ctblas_shared')) else: linkLibs.extend(env['blas_lapack_libs']) # # Add execstream to the link line # linkLibs.append('execstream') linkSharedLibs.append('execstream_shared') # # Add the f2c library if it is necessary to link fortran libraries # if not env['build_with_f2c']: # # Early gcc compilers will fail on this line as they use g77 and not gfortran # linkLibs.append('gfortran') linkSharedLibs.append('gfortran') else: # Add the f2c library when f2c is requested # linkLibs.append('ctf2c') linkSharedLibs.append('ctf2c_shared') # # Store the list of needed static link libraries in the environment # env['cantera_libs'] = linkLibs env['cantera_shared_libs'] = linkSharedLibs if env['renamed_shared_libraries'] == False : env['cantera_shared_libs'] = linkLibs # Add targets from the SConscript files in the various subdirectories Export('env', 'build', 'libraryTargets', 'install', 'buildSample') # ext needs to come before src so that libraryTargets is fully populated VariantDir('build/ext', 'ext', duplicate=0) SConscript('build/ext/SConscript') # Fortran needs to come before src so that libraryTargets is fully populated if env['f90_interface'] == 'y': VariantDir('build/src/fortran/', 'src/fortran', duplicate=1) SConscript('build/src/fortran/SConscript') VariantDir('build/src', 'src', duplicate=0) SConscript('build/src/SConscript') if env['python_package'] in ('full','minimal'): SConscript('src/python/SConscript') SConscript('build/src/apps/SConscript') if env['OS'] != 'Windows': VariantDir('build/platform', 'platform/posix', duplicate=0) SConscript('build/platform/SConscript') if env['matlab_toolbox'] == 'y': SConscript('build/src/matlab/SConscript') if env['doxygen_docs'] or env['sphinx_docs']: SConscript('doc/SConscript') if 'samples' in COMMAND_LINE_TARGETS or 'install' in COMMAND_LINE_TARGETS: VariantDir('build/samples', 'samples', duplicate=0) sampledir_excludes = ['ct2ctml', '\\.o$', '^~$', 'xml$', '\\.in', 'SConscript', 'Makefile.am'] SConscript('build/samples/cxx/SConscript') # Install C++ samples install(env.RecursiveInstall, pjoin('$inst_sampledir', 'cxx'), 'samples/cxx', exclude=sampledir_excludes) if env['f90_interface'] == 'y': SConscript('build/samples/f77/SConscript') SConscript('build/samples/f90/SConscript') # install F90 / F77 samples install(env.RecursiveInstall, pjoin('$inst_sampledir', 'f77'), 'samples/f77', sampledir_excludes) install(env.RecursiveInstall, pjoin('$inst_sampledir', 'f90'), 'samples/f90', sampledir_excludes) ### Meta-targets ### build_samples = Alias('samples', sampleTargets) def postBuildMessage(target, source, env): print "**************************************************************" print "Compiliation complete. Type '[sudo] scons install' to install." print "**************************************************************" finish_build = env.Command('finish_build', [], postBuildMessage) env.Depends(finish_build, buildTargets) build_cantera = Alias('build', finish_build) Default('build') def postInstallMessage(target, source, env): print """ Cantera has been successfully installed. File locations: applications %(ct_bindir)s library files %(ct_libdir)s C++ headers %(ct_incdir)s samples %(ct_sampledir)s data files %(ct_datadir)s""" % env if env['python_package'] == 'full': print """ Python package %(python_module_loc)s""" % env elif warnNoPython: print """ ################################################################# WARNING: the Cantera Python package was not installed because a suitable array package (e.g. numpy) could not be found. #################################################################""" if env['matlab_toolbox'] == 'y': print """ Matlab toolbox %(ct_matlab_dir)s Matlab samples %(ct_sampledir)s/matlab An m-file to set the correct matlab path for Cantera is at: %(prefix)s/matlab/ctpath.m """ % env if os.name != 'nt': print """ setup script %(ct_bindir)s/setup_cantera The setup script configures the environment for Cantera. It is recommended that you run this script by typing: source %(ct_bindir)s/setup_cantera before using Cantera, or else include its contents in your shell login script. """ % env finish_install = env.Command('finish_install', [], postInstallMessage) env.Depends(finish_install, installTargets) install_cantera = Alias('install', finish_install) if 'msi' in COMMAND_LINE_TARGETS: def build_wxs(target, source, env): import wxsgen wxs = wxsgen.WxsGenerator(env['stage_dir'], x64=env['TARGET_ARCH']=='amd64', includeMatlab=env['matlab_toolbox']=='y') wxs.make_wxs(str(target[0])) wxs_target = env.Command(pjoin('build', 'wix', 'cantera.wxs'), [], build_wxs) env.AlwaysBuild(wxs_target) env.Append(WIXLIGHTFLAGS=['-ext', 'WixUIExtension']) msi_target = env.WiX('cantera.msi', [pjoin('build', 'wix', 'cantera.wxs')]) env.Depends(wxs_target, installTargets) env.Depends(msi_target, wxs_target) build_msi = Alias('msi', msi_target) ### Tests ### if any(target.startswith('test') for target in COMMAND_LINE_TARGETS): SConscript('test_problems/SConscript') # Tests written using the gtest framework if any(target.startswith('newtest') for target in COMMAND_LINE_TARGETS): VariantDir('build/test', 'test', duplicate=0) SConscript('build/test/SConscript')