/[escript]/branches/diaplayground/SConstruct
ViewVC logotype

Diff of /branches/diaplayground/SConstruct

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 685 by gross, Mon Mar 27 22:16:33 2006 UTC revision 4820 by sshaw, Tue Apr 1 04:55:49 2014 UTC
# Line 1  Line 1 
1  #          Copyright 2006 by ACcESS MNRF                    ##############################################################################
 #                                                            
 #              http://www.access.edu.au                      
 #       Primary Business: Queensland, Australia              
 #  Licensed under the Open Software License version 3.0      
 #     http://www.opensource.org/licenses/osl-3.0.php        
 #                                                            
2  #  #
3    # Copyright (c) 2003-2014 by University of Queensland
4    # http://www.uq.edu.au
5  #  #
6    # Primary Business: Queensland, Australia
7    # Licensed under the Open Software License version 3.0
8    # http://www.opensource.org/licenses/osl-3.0.php
9    #
10    # Development until 2012 by Earth Systems Science Computational Center (ESSCC)
11    # Development 2012-2013 by School of Earth Sciences
12    # Development from 2014 by Centre for Geoscience Computing (GeoComp)
13    #
14    ##############################################################################
15    
16  # top-level Scons configuration file for all esys13 modules  EnsureSConsVersion(0,98,1)
17  # Begin initialisation Section  EnsurePythonVersion(2,5)
18  # all of this section just intialises default environments and helper  
19  # scripts. You shouldn't need to modify this section.  import atexit, sys, os, platform, re
20  EnsureSConsVersion(0,96,91)  from distutils import sysconfig
21  EnsurePythonVersion(2,3)  from dependencies import *
22    from site_init import *
23  import sys, os  
24  # Add our extensions  # Version number to check for in options file. Increment when new features are
25  if sys.path.count('scons')==0: sys.path.append('scons')  # added or existing options changed.
26  import scons_extensions  REQUIRED_OPTS_VERSION=201
27    
28  # Default options and options help text  # MS Windows support, many thanks to PH
29  # These are defaults and can be overridden using command line arguments or an options file.  IS_WINDOWS = (os.name == 'nt')
30  # if the options_file or ARGUMENTS do not exist then the ones listed as default here are used  
31  # DO NOT CHANGE THEM HERE  IS_OSX = (os.uname()[0] == 'Darwin')
32  if ARGUMENTS.get('options_file',0):  
33     options_file = ARGUMENTS.get('options_file',0)  ########################## Determine options file ############################
34  else:  # 1. command line
35     import socket  # 2. scons/<hostname>_options.py
36     from string import ascii_letters,digits  # 3. name as part of a cluster
37     hostname=""  options_file=ARGUMENTS.get('options_file', None)
38     for s in socket.gethostname().split('.')[0]:  if not options_file:
39        if s in ascii_letters+digits:      ext_dir = os.path.join(os.getcwd(), 'scons')
40           hostname+=s      hostname = platform.node().split('.')[0]
41        else:      for name in hostname, effectiveName(hostname):
42           hostname+="_"          mangledhostname = re.sub('[^0-9a-zA-Z]', '_', hostname)
43     options_file = "scons/"+hostname+"_options.py"          options_file = os.path.join(ext_dir, mangledhostname+'_options.py')
44            if os.path.isfile(options_file): break
45  opts = Options(options_file, ARGUMENTS)  
46  opts.AddOptions(  if not os.path.isfile(options_file):
47  # Where to install esys stuff      print("\nWARNING:\nOptions file %s" % options_file)
48    ('incinstall', 'where the esys headers will be installed', Dir('#.').abspath+'/include'),      print("not found! Default options will be used which is most likely suboptimal.")
49    ('libinstall', 'where the esys libraries will be installed', Dir('#.').abspath+'/lib'),      print("We recommend that you copy one of the TEMPLATE files in the scons/")
50    ('pyinstall', 'where the esys python modules will be installed', Dir('#.').abspath),      print("subdirectory and customize it to your needs.\n")
51  # Compilation options      options_file = None
52    BoolOption('dodebug', 'Do you want a debug build?', 'yes'),  
53    ('options_file', "Optional file containing preferred options. Ignored if it doesn't exist (default: scons/hostname_options.py)", options_file),  ############################### Build options ################################
54    ('cc_defines','C/C++ defines to use', None),  
55    ('cc_flags','C compiler flags to use (Release build)', None),  default_prefix='/usr'
56    ('cc_flags_debug', 'C compiler flags to use (Debug build)', None),  mpi_flavours=('no', 'none', 'MPT', 'MPICH', 'MPICH2', 'OPENMPI', 'INTELMPI')
57    ('cxx_flags', 'C++ compiler flags to use (Release build)', None),  lapack_flavours=('none', 'clapack', 'mkl')
58    ('cxx_flags_debug', 'C++ compiler flags to use (Debug build)', None),  
59    ('ar_flags', 'Static library archiver flags to use', None),  vars = Variables(options_file, ARGUMENTS)
60    ('sys_libs', 'System libraries to link with', None),  vars.AddVariables(
61  # MKL    PathVariable('options_file', 'Path to options file', options_file, PathVariable.PathIsFile),
62    PathOption('mkl_path', 'Path to MKL includes', None),    PathVariable('prefix', 'Installation prefix', Dir('#.').abspath, PathVariable.PathIsDirCreate),
63    PathOption('mkl_lib_path', 'Path to MKL libs', None),    PathVariable('build_dir', 'Top-level build directory', Dir('#/build').abspath, PathVariable.PathIsDirCreate),
64    ('mkl_libs', 'MKL libraries to link with', None),    BoolVariable('verbose', 'Output full compile/link lines', False),
65  # SCSL  # Compiler/Linker options
66    PathOption('scsl_path', 'Path to SCSL includes', None),    ('cxx', 'Path to C++ compiler', 'default'),
67    PathOption('scsl_lib_path', 'Path to SCSL libs', None),    ('cc_flags', 'Base C++ compiler flags', 'default'),
68    ('scsl_libs', 'SCSL libraries to link with', None),    ('cc_optim', 'Additional C++ flags for a non-debug build', 'default'),
69  # UMFPACK    ('cc_debug', 'Additional C++ flags for a debug build', 'default'),
70    PathOption('umf_path', 'Path to UMF includes', None),    ('cxx_extra', 'Extra C++ compiler flags', ''),
71    PathOption('umf_lib_path', 'Path to UMF libs', None),    ('ld_extra', 'Extra linker flags', ''),
72    ('umf_libs', 'UMF libraries to link with', None),    BoolVariable('werror','Treat compiler warnings as errors', True),
73  # Python    BoolVariable('debug', 'Compile with debug flags', False),
74  # locations of include files for python    BoolVariable('openmp', 'Compile parallel version using OpenMP', False),
75    PathOption('python_path', 'Path to Python includes', '/usr/include/python%s.%s'%(sys.version_info[0],sys.version_info[1])),    ('omp_flags', 'OpenMP compiler flags', 'default'),
76    PathOption('python_lib_path', 'Path to Python libs', '/usr/lib'),    ('omp_ldflags', 'OpenMP linker flags', 'default'),
77    ('python_lib', 'Python libraries to link with', ["python%s.%s"%(sys.version_info[0],sys.version_info[1]),]),  # Mandatory libraries
78  # Boost    ('boost_prefix', 'Prefix/Paths of boost installation', default_prefix),
79    PathOption('boost_path', 'Path to Boost includes', '/usr/include'),    ('boost_libs', 'Boost libraries to link with', ['boost_python-mt']),
80    PathOption('boost_lib_path', 'Path to Boost libs', '/usr/lib'),  # Mandatory for tests
81    ('boost_lib', 'Boost libraries to link with', ['boost_python',]),    ('cppunit_prefix', 'Prefix/Paths of CppUnit installation', default_prefix),
82  # CppUnit    ('cppunit_libs', 'CppUnit libraries to link with', ['cppunit']),
83    PathOption('cppunit_path', 'Path to CppUnit includes', Dir('#.').abspath+'/tools/CppUnitTest/inc'),  # Optional libraries and options
84    PathOption('cppunit_lib_path', 'Path to CppUnit libs', Dir('#.').abspath+'/lib'),    EnumVariable('mpi', 'Compile parallel version using MPI flavour', 'none', allowed_values=mpi_flavours),
85    ('cppunit_lib', 'CppUnit libraries to link with', ['CppUnitTest',]),    ('mpi_prefix', 'Prefix/Paths of MPI installation', default_prefix),
86  # Doc building    ('mpi_libs', 'MPI shared libraries to link with', ['mpi']),
87    PathOption('doxygen_path', 'Path to Doxygen executable', None),    BoolVariable('netcdf', 'Enable netCDF file support', False),
88    PathOption('epydoc_path', 'Path to Epydoc executable', None),    ('netcdf_prefix', 'Prefix/Paths of netCDF installation', default_prefix),
89    PathOption('epydoc_pythonpath', 'Path to Epydoc python files', None),    ('netcdf_libs', 'netCDF libraries to link with', ['netcdf_c++', 'netcdf']),
90  # PAPI    BoolVariable('parmetis', 'Enable ParMETIS (requires MPI)', False),
91    PathOption('papi_path', 'Path to PAPI includes', None),    ('parmetis_prefix', 'Prefix/Paths of ParMETIS installation', default_prefix),
92    PathOption('papi_lib_path', 'Path to PAPI libs', None),    ('parmetis_libs', 'ParMETIS libraries to link with', ['parmetis', 'metis']),
93    ('papi_libs', 'PAPI libraries to link with', None),    BoolVariable('papi', 'Enable PAPI', False),
94      ('papi_prefix', 'Prefix/Paths to PAPI installation', default_prefix),
95      ('papi_libs', 'PAPI libraries to link with', ['papi']),
96      BoolVariable('papi_instrument_solver', 'Use PAPI to instrument each iteration of the solver', False),
97      BoolVariable('mkl', 'Enable the Math Kernel Library', False),
98      ('mkl_prefix', 'Prefix/Paths to MKL installation', default_prefix),
99      ('mkl_libs', 'MKL libraries to link with', ['mkl_solver','mkl_em64t','guide','pthread']),
100      BoolVariable('umfpack', 'Enable UMFPACK', False),
101      ('umfpack_prefix', 'Prefix/Paths to UMFPACK installation', default_prefix),
102      ('umfpack_libs', 'UMFPACK libraries to link with', ['umfpack']),
103      BoolVariable('boomeramg', 'Enable BoomerAMG', False),
104      ('boomeramg_prefix', 'Prefix/Paths to BoomerAMG installation', default_prefix),
105      ('boomeramg_libs', 'BoomerAMG libraries to link with', ['boomeramg']),
106      EnumVariable('lapack', 'Set LAPACK flavour', 'none', allowed_values=lapack_flavours),
107      ('lapack_prefix', 'Prefix/Paths to LAPACK installation', default_prefix),
108      ('lapack_libs', 'LAPACK libraries to link with', []),
109      BoolVariable('silo', 'Enable the Silo file format in weipa', False),
110      ('silo_prefix', 'Prefix/Paths to Silo installation', default_prefix),
111      ('silo_libs', 'Silo libraries to link with', ['siloh5', 'hdf5']),
112      BoolVariable('visit', 'Enable the VisIt simulation interface', False),
113      ('visit_prefix', 'Prefix/Paths to VisIt installation', default_prefix),
114      ('visit_libs', 'VisIt libraries to link with', ['simV2']),
115      BoolVariable('vsl_random', 'Use VSL from intel for random data', False),
116    # Advanced settings
117      #dudley_assemble_flags = -funroll-loops      to actually do something
118      ('dudley_assemble_flags', 'compiler flags for some dudley optimisations', ''),
119      # To enable passing function pointers through python
120      BoolVariable('iknowwhatimdoing', 'Allow non-standard C', False),
121      # An option for specifying the compiler tools (see windows branch)
122      ('tools_names', 'Compiler tools to use', ['default']),
123      ('env_export', 'Environment variables to be passed to tools',[]),
124      EnumVariable('forcelazy', 'For testing use only - set the default value for autolazy', 'leave_alone', allowed_values=('leave_alone', 'on', 'off')),
125      EnumVariable('forcecollres', 'For testing use only - set the default value for force resolving collective ops', 'leave_alone', allowed_values=('leave_alone', 'on', 'off')),
126      # finer control over library building, intel aggressive global optimisation
127      # works with dynamic libraries on windows.
128      ('build_shared', 'Build dynamic libraries only', False),
129      ('sys_libs', 'Extra libraries to link with', []),
130      ('escript_opts_version', 'Version of options file (do not specify on command line)'),
131      ('SVN_VERSION', 'Do not use from options file', -2),
132      ('pythoncmd', 'which python to compile with','python'),
133      ('usepython3', 'Is this a python3 build? (experimental)', False),
134      ('pythonlibname', 'Name of the python library to link. (This is found automatically for python2.X.)', ''),
135      ('pythonlibpath', 'Path to the python library. (You should not need to set this unless your python has moved)',''),
136      ('pythonincpath','Path to python include files. (You should not need to set this unless your python has moved',''),
137      BoolVariable('BADPYTHONMACROS','Extra \#include to get around a python bug.', True),
138      BoolVariable('compressed_files','Enables reading from compressed binary files', True),
139      ('compression_libs', 'Compression libraries to link with', ['boost_iostreams'])
140  )  )
141    
142  # Initialise Scons Build Environment  ##################### Create environment and help text #######################
 # check for user environment variables we are interested in  
 try:  
    python_path = os.environ['PYTHONPATH']  
 except KeyError:  
    python_path = ''  
 try:  
    path = os.environ['PATH']  
 except KeyError:  
    path = ''  
 try:  
    ld_library_path = os.environ['LD_LIBRARY_PATH']  
 except KeyError:  
    ld_library_path = ''  
143    
144  # Note: On the Altix the intel compilers are not automatically  # Intel's compiler uses regular expressions improperly and emits a warning
145  # detected by scons intelc.py script. The Altix has a different directory  # about failing to find the compilers. This warning can be safely ignored.
 # path and in some locations the "modules" facility is used to support  
 # multiple compiler versions. This forces the need to import the users PATH  
 # environment which isn't the "scons way"  
 # This doesn't impact linux and windows which will use the default compiler (g++ or msvc, or the intel compiler if it is installed on both platforms)  
 # FIXME: Perhaps a modification to intelc.py will allow better support for ia64 on altix  
   
 if os.name != "nt" and os.uname()[4]=='ia64':  
    env = Environment(tools = ['default', 'intelc'], options = opts)  
    env['ENV']['PATH'] = path  
    env['ENV']['LD_LIBRARY_PATH'] = ld_library_path  
    env['ENV']['PYTHONPATH'] = python_path  
    if env['CXX'] == 'icpc':  
       env['LINK'] = env['CXX'] # version >=9 of intel c++ compiler requires use of icpc to link in C++ runtimes (icc does not). FIXME: this behaviour could be directly incorporated into scons intelc.py  
 elif os.name == "nt":  
    # FIXME: Need to implement equivalent of ld library path for windoze  
    env = Environment(tools = ['default', 'intelc'], options = opts)  
    env['ENV']['PYTHONPATH'] = python_path  
 else:  
    env = Environment(tools = ['default'], options = opts)  
    env['ENV']['PATH'] = path  
    env['ENV']['LD_LIBRARY_PATH'] = ld_library_path  
    env['ENV']['PYTHONPATH'] = python_path  
146    
147  # Setup help for options  # PATH is needed so the compiler, linker and tools are found if they are not
148  Help(opts.GenerateHelpText(env))  # in default locations.
149    env = Environment(tools = ['default'], options = vars,
150                      ENV = {'PATH': os.environ['PATH']})
151    
152    # set the vars for clang
153    def mkclang(env):
154        env['CXX']='clang++'
155    
156    if env['tools_names'] != 'default':
157        zz=env['tools_names']
158        if 'clang' in zz:
159            zz.remove('clang')
160            zz.insert(0, mkclang)
161        env = Environment(tools = ['default'] + env['tools_names'], options = vars,
162                          ENV = {'PATH' : os.environ['PATH']})
163    
164    if options_file:
165        opts_valid=False
166        if 'escript_opts_version' in env.Dictionary() and \
167            int(env['escript_opts_version']) >= REQUIRED_OPTS_VERSION:
168                opts_valid=True
169        if opts_valid:
170            print("Using options in %s." % options_file)
171        else:
172            print("\nOptions file %s" % options_file)
173            print("is outdated! Please update the file by examining one of the TEMPLATE")
174            print("files in the scons/ subdirectory and setting escript_opts_version to %d.\n"%REQUIRED_OPTS_VERSION)
175            Exit(1)
176    
177    # Generate help text (scons -h)
178    Help(vars.GenerateHelpText(env))
179    
180    # Check for superfluous options
181    if len(vars.UnknownVariables())>0:
182        for k in vars.UnknownVariables():
183            print("Unknown option '%s'" % k)
184        Exit(1)
185    
186    # create dictionary which will be populated with info for buildvars file
187    env['buildvars']={}
188    # create list which will be populated with warnings if there are any
189    env['warnings']=[]
190    
191    #################### Make sure install directories exist #####################
192    
193    env['BUILD_DIR']=Dir(env['build_dir']).abspath
194    prefix=Dir(env['prefix']).abspath
195    env['buildvars']['prefix']=prefix
196    env['incinstall'] = os.path.join(prefix, 'include')
197    env['bininstall'] = os.path.join(prefix, 'bin')
198    env['libinstall'] = os.path.join(prefix, 'lib')
199    env['pyinstall']  = os.path.join(prefix, 'esys')
200    if not os.path.isdir(env['bininstall']):
201        os.makedirs(env['bininstall'])
202    if not os.path.isdir(env['libinstall']):
203        os.makedirs(env['libinstall'])
204    if not os.path.isdir(env['pyinstall']):
205        os.makedirs(env['pyinstall'])
206    
207    env.Append(CPPPATH = [env['incinstall']])
208    env.Append(LIBPATH = [env['libinstall']])
209    
210    ################# Fill in compiler options if not set above ##################
211    
212    if env['cxx'] != 'default': env['CXX']=env['cxx']
213    
214    # version >=9 of intel C++ compiler requires use of icpc to link in C++
215    # runtimes (icc does not)
216    if not IS_WINDOWS and os.uname()[4]=='ia64' and env['CXX']=='icpc':
217        env['LINK'] = env['CXX']
218    
219    # default compiler/linker options
220    cc_flags = ''
221    cc_optim = ''
222    cc_debug = ''
223    omp_flags = ''
224    omp_ldflags = ''
225    fatalwarning = '' # switch to turn warnings into errors
226    sysheaderopt = '' # how to indicate that a header is a system header
227    
228    # env['CC'] might be a full path
229    cc_name=os.path.basename(env['CXX'])
230    
231    if cc_name == 'icpc':
232        # Intel compiler
233        # #1875: offsetof applied to non-POD types is nonstandard (in boost)
234        # removed -std=c99 because icpc doesn't like it and we aren't using c anymore
235        cc_flags    = "-fPIC -w2 -wd1875 -Wno-unknown-pragmas"
236        cc_optim    = "-O3 -ftz -fno-alias -ipo -xHost"
237        cc_debug    = "-g -O0 -DDOASSERT -DDOPROF -DBOUNDS_CHECK"
238        omp_flags   = "-openmp"
239        omp_ldflags = "-openmp -openmp_report=1"
240        fatalwarning = "-Werror"
241    elif cc_name[:3] == 'g++':
242        # GNU C on any system
243        # note that -ffast-math is not used because it breaks isnan(),
244        # see mantis #691
245        cc_flags     = "-pedantic -Wall -fPIC -Wno-unknown-pragmas -Wno-sign-compare -Wno-system-headers -Wno-long-long -Wno-strict-aliasing -finline-functions"
246        cc_optim     = "-O3"
247        cc_debug     = "-g -O0 -DDOASSERT -DDOPROF -DBOUNDS_CHECK --param=max-vartrack-size=90000000" #avoids vartrack limit being exceeded with escriptcpp.cpp
248        omp_flags    = "-fopenmp"
249        omp_ldflags  = "-fopenmp"
250        fatalwarning = "-Werror"
251        sysheaderopt = "-isystem"
252    elif cc_name == 'cl':
253        # Microsoft Visual C on Windows
254        cc_flags     = "/EHsc /MD /GR /wd4068 /D_USE_MATH_DEFINES /DDLL_NETCDF"
255        cc_optim     = "/O2 /Op /W3"
256        cc_debug     = "/Od /RTCcsu /ZI /DBOUNDS_CHECK"
257        fatalwarning = "/WX"
258    elif cc_name == 'icl':
259        # Intel C on Windows
260        cc_flags     = '/EHsc /GR /MD'
261        cc_optim     = '/fast /Oi /W3 /Qssp /Qinline-factor- /Qinline-min-size=0 /Qunroll'
262        cc_debug     = '/Od /RTCcsu /Zi /Y- /debug:all /Qtrapuv'
263        omp_flags    = '/Qvec-report0 /Qopenmp /Qopenmp-report0 /Qparallel'
264        omp_ldflags  = '/Qvec-report0 /Qopenmp /Qopenmp-report0 /Qparallel'
265    
266    env['sysheaderopt']=sysheaderopt
267    
268    # set defaults if not otherwise specified
269    if env['cc_flags']    == 'default': env['cc_flags'] = cc_flags
270    if env['cc_optim']    == 'default': env['cc_optim'] = cc_optim
271    if env['cc_debug']    == 'default': env['cc_debug'] = cc_debug
272    if env['omp_flags']   == 'default': env['omp_flags'] = omp_flags
273    if env['omp_ldflags'] == 'default': env['omp_ldflags'] = omp_ldflags
274    if env['cxx_extra'] != '': env.Append(CXXFLAGS = env['cxx_extra'])
275    if env['ld_extra']  != '': env.Append(LINKFLAGS = env['ld_extra'])
276    
277    if env['BADPYTHONMACROS']: env.Append(CXXFLAGS = ' -DBADPYTHONMACROS')
278    
279    if env['usepython3']:
280        env.Append(CPPDEFINES=['ESPYTHON3'])
281    
282    # set up the autolazy values
283    if env['forcelazy'] == 'on':
284        env.Append(CPPDEFINES=['FAUTOLAZYON'])
285    elif env['forcelazy'] == 'off':
286        env.Append(CPPDEFINES=['FAUTOLAZYOFF'])
287    
288    # set up the collective resolve values
289    if env['forcecollres'] == 'on':
290        env.Append(CPPDEFINES=['FRESCOLLECTON'])
291    elif env['forcecollres'] == 'off':
292        env.Append(CPPDEFINES=['FRESCOLLECTOFF'])
293    
294    # allow non-standard C if requested
295    if env['iknowwhatimdoing']:
296        env.Append(CPPDEFINES=['IKNOWWHATIMDOING'])
297    
298    # Disable OpenMP if no flags provided
299    if env['openmp'] and env['omp_flags'] == '':
300       env['warnings'].append("OpenMP requested but no flags provided - disabling OpenMP!")
301       env['openmp'] = False
302    
303    if env['openmp']:
304        env.Append(CCFLAGS = env['omp_flags'])
305        if env['omp_ldflags'] != '': env.Append(LINKFLAGS = env['omp_ldflags'])
306    else:
307        env['omp_flags']=''
308        env['omp_ldflags']=''
309    
310  # Add some customer builders  env['buildvars']['openmp']=int(env['openmp'])
 py_builder = Builder(action = scons_extensions.build_py, suffix = '.pyc', src_suffix = '.py', single_source=True)  
 env.Append(BUILDERS = {'PyCompile' : py_builder});  
311    
312  if env['PLATFORM'] == "win32":  # add debug/non-debug compiler flags
313     runUnitTest_builder = Builder(action = scons_extensions.runUnitTest, suffix = '.passed', src_suffix='.exe', single_source=True)  env['buildvars']['debug']=int(env['debug'])
314    if env['debug']:
315        env.Append(CCFLAGS = env['cc_debug'])
316  else:  else:
317     runUnitTest_builder = Builder(action = scons_extensions.runUnitTest, suffix = '.passed', single_source=True)      env.Append(CCFLAGS = env['cc_optim'])
 env.Append(BUILDERS = {'RunUnitTest' : runUnitTest_builder});  
318    
319  runPyUnitTest_builder = Builder(action = scons_extensions.runPyUnitTest, suffix = '.passed', src_suffic='.py', single_source=True)  # always add cc_flags
320  env.Append(BUILDERS = {'RunPyUnitTest' : runPyUnitTest_builder});  env.Append(CCFLAGS = env['cc_flags'])
321    
322  # Convert the options which are held in environment variable into python variables for ease of handling and configure compilation options  # add system libraries
323  try:  env.AppendUnique(LIBS = env['sys_libs'])
324     incinstall = env['incinstall']  
325     env.Append(CPPPATH = [incinstall,])  # determine svn revision
326  except KeyError:  global_revision=ARGUMENTS.get('SVN_VERSION', None)
327     incinstall = None    if global_revision:
328  try:      global_revision = re.sub(':.*', '', global_revision)
329     libinstall = env['libinstall']      global_revision = re.sub('[^0-9]', '', global_revision)
330     env.Append(LIBPATH = [libinstall,])      if global_revision == '': global_revision='-2'
    env.PrependENVPath('LD_LIBRARY_PATH', libinstall)  
 except KeyError:  
    libinstall = None    
 try:  
    pyinstall = env['pyinstall']+'/esys' # all targets will install into pyinstall/esys but PYTHONPATH points at straight pyinstall so you go import esys.escript etc  
    env.PrependENVPath('PYTHONPATH', env['pyinstall'])  
 except KeyError:  
    pyinstall = None    
 try:  
    dodebug = env['dodebug']  
 except KeyError:  
    dodebug = None    
 try:  
    cc_defines = env['cc_defines']  
    env.Append(CPPDEFINES = [cc_defines,])  
 except KeyError:  
    pass  
 if dodebug:  
    try:  
       flags = env['cc_flags_debug']  
       env.Append(CCFLAGS = flags)  
    except KeyError:  
       pass  
331  else:  else:
332     try:    # Get the global Subversion revision number for the getVersion() method
333        flags = env['cc_flags']    try:
334        env.Append(CCFLAGS = flags)      global_revision = os.popen('svnversion -n .').read()
335     except KeyError:      global_revision = re.sub(':.*', '', global_revision)
336        pass      global_revision = re.sub('[^0-9]', '', global_revision)
337        if global_revision == '': global_revision='-2'
338  if dodebug:    except:
339     try:      global_revision = '-1'
340        flags = env['cxx_flags_debug']  env['svn_revision']=global_revision
341        env.Append(CXXFLAGS = flags)  env['buildvars']['svn_revision']=global_revision
342     except KeyError:  env.Append(CPPDEFINES=['SVN_VERSION='+global_revision])
343        pass  
344    if IS_WINDOWS:
345        if not env['build_shared']:
346            env.Append(CPPDEFINES = ['ESYSUTILS_STATIC_LIB'])
347            env.Append(CPPDEFINES = ['PASO_STATIC_LIB'])
348    
349    # VSL random numbers
350    env['buildvars']['vsl_random']=int(env['vsl_random'])
351    if env['vsl_random']:
352        env.Append(CPPDEFINES = ['MKLRANDOM'])
353    
354    env['IS_WINDOWS']=IS_WINDOWS
355    
356    ###################### Copy required environment vars ########################
357    
358    # Windows doesn't use LD_LIBRARY_PATH but PATH instead
359    if IS_WINDOWS:
360        LD_LIBRARY_PATH_KEY='PATH'
361        env['ENV']['LD_LIBRARY_PATH']=''
362  else:  else:
363     try:      LD_LIBRARY_PATH_KEY='LD_LIBRARY_PATH'
       flags = env['cxx_flags']  
       env.Append(CXXFLAGS = flags)  
    except KeyError:  
       pass  
364    
365  try:  env['LD_LIBRARY_PATH_KEY']=LD_LIBRARY_PATH_KEY
366     flags = env['ar_flags']  
367     env.Append(ARFLAGS = flags)  # the following env variables are exported for the unit tests
368  except KeyError:  
369     ar_flags = None    for key in 'OMP_NUM_THREADS', 'ESCRIPT_NUM_PROCS', 'ESCRIPT_NUM_NODES':
370  try:      try:
371     sys_libs = env['sys_libs']          env['ENV'][key] = os.environ[key]
372  except KeyError:      except KeyError:
373     sys_libs = ''          env['ENV'][key] = 1
374    
375    env_export=env['env_export']
376    env_export.extend(['ESCRIPT_NUM_THREADS','ESCRIPT_HOSTFILE','DISPLAY','XAUTHORITY','PATH','HOME','KMP_MONITOR_STACKSIZE','TMPDIR','TEMP','TMP'])
377    
378    for key in set(env_export):
379        try:
380            env['ENV'][key] = os.environ[key]
381        except KeyError:
382            pass
383    
384  try:  try:
385     includes = env['mkl_path']      env.PrependENVPath(LD_LIBRARY_PATH_KEY, os.environ[LD_LIBRARY_PATH_KEY])
    env.Append(CPPPATH = [includes,])  
 except KeyError:  
    pass  
 try:  
    lib_path = env['mkl_lib_path']  
    env.Append(LIBPATH = [lib_path,])  
 except KeyError:  
    pass  
 try:  
    mkl_libs = env['mkl_libs']  
 except KeyError:  
    mkl_libs = ''  
 try:  
    includes = env['scsl_path']  
    env.Append(CPPPATH = [includes,])  
 except KeyError:  
    pass  
 try:  
    lib_path = env['scsl_lib_path']  
    env.Append(LIBPATH = [lib_path,])  
 except KeyError:  
    pass  
 try:  
    scsl_libs = env['scsl_libs']  
 except KeyError:  
    scsl_libs = ''  
 try:  
    includes = env['umf_path']  
    env.Append(CPPPATH = [includes,])  
 except KeyError:  
    pass  
 try:  
    lib_path = env['umf_lib_path']  
    env.Append(LIBPATH = [lib_path,])  
 except KeyError:  
    pass  
 try:  
    umf_libs = env['umf_libs']  
 except KeyError:  
    umf_libs = ''  
 try:  
    includes = env['boost_path']  
    env.Append(CPPPATH = [includes,])  
 except KeyError:  
    pass  
 try:  
    lib_path = env['boost_lib_path']  
    env.Append(LIBPATH = [lib_path,])  
 except KeyError:  
    pass  
 try:  
    boost_lib = env['boost_lib']  
 except KeyError:  
    boost_lib = None    
 try:  
    includes = env['cppunit_path']  
    env.Append(CPPPATH = [includes,])  
 except KeyError:  
    pass  
 try:  
    lib_path = env['cppunit_lib_path']  
    env.Append(LIBPATH = [lib_path,])  
 except KeyError:  
    pass  
 try:  
    cppunit_lib = env['cppunit_lib']  
 except KeyError:  
    boost_lib = None    
 try:  
    includes = env['python_path']  
    env.Append(CPPPATH = [includes,])  
 except KeyError:  
    pass  
 try:  
    lib_path = env['python_lib_path']  
    env.Append(LIBPATH = [lib_path,])  
 except KeyError:  
    pass  
 try:  
    python_lib = env['python_lib']  
 except KeyError:  
    python_lib = None    
 try:  
    doxygen_path = env['doxygen_path']  
 except KeyError:  
    doxygen_path = None    
 try:  
    epydoc_path = env['epydoc_path']  
 except KeyError:  
    epydoc_path = None    
 try:  
    epydoc_pythonpath = env['epydoc_pythonpath']  
 except KeyError:  
    epydoc_pythonpath = None    
 try:  
    includes = env['papi_path']  
    env.Append(CPPPATH = [includes,])  
 except KeyError:  
    pass  
 try:  
    lib_path = env['papi_lib_path']  
    env.Append(LIBPATH = [lib_path,])  
386  except KeyError:  except KeyError:
387     pass      pass
388    
389    if IS_OSX:
390      try:
391        env.PrependENVPath('DYLD_LIBRARY_PATH', os.environ['DYLD_LIBRARY_PATH'])
392      except KeyError:
393        pass
394    
395    
396    # these shouldn't be needed
397    #for key in 'C_INCLUDE_PATH','CPLUS_INCLUDE_PATH','LIBRARY_PATH':
398    #    try:
399    #        env['ENV'][key] = os.environ[key]
400    #    except KeyError:
401    #        pass
402    
403  try:  try:
404     papi_libs = env['papi_libs']      env['ENV']['PYTHONPATH'] = os.environ['PYTHONPATH']
405  except KeyError:  except KeyError:
406     papi_libs = None        pass
407    
408    ######################## Add some custom builders ############################
409    
410    if env['pythoncmd']=='python':
411        py_builder = Builder(action = build_py, suffix = '.pyc', src_suffix = '.py', single_source=True)
412    else:
413        py_builder = Builder(action = env['pythoncmd']+" scripts/py_comp.py $SOURCE $TARGET", suffix = '.pyc', src_suffix = '.py', single_source=True)
414    env.Append(BUILDERS = {'PyCompile' : py_builder});
415    
416    runUnitTest_builder = Builder(action = runUnitTest, suffix = '.passed', src_suffix=env['PROGSUFFIX'], single_source=True)
417    env.Append(BUILDERS = {'RunUnitTest' : runUnitTest_builder});
418    
419    runPyUnitTest_builder = Builder(action = runPyUnitTest, suffix = '.passed', src_suffic='.py', single_source=True)
420    env.Append(BUILDERS = {'RunPyUnitTest' : runPyUnitTest_builder});
421    
422    epstopdfbuilder = Builder(action = eps2pdf, suffix='.pdf', src_suffix='.eps', single_source=True)
423    env.Append(BUILDERS = {'EpsToPDF' : epstopdfbuilder});
424    
425    ############################ Dependency checks ###############################
426    
427    ######## Compiler
428    env=checkCompiler(env)
429    
430    ######## Python headers & library (required)
431    env=checkPython(env)
432    
433    ######## boost & boost-python (required)
434    env=checkBoost(env)
435    
436    ######## numpy (required) and numpy headers (optional)
437    env=checkNumpy(env)
438    
439    ######## CppUnit (required for tests)
440    env=checkCppUnit(env)
441    
442    ######## optional python modules (sympy, pyproj)
443    env=checkOptionalModules(env)
444    
445    ######## optional dependencies (netCDF, PAPI, MKL, UMFPACK, Lapack, Silo, ...)
446    env=checkOptionalLibraries(env)
447    
448    ######## PDFLaTeX (for documentation)
449    env=checkPDFLatex(env)
450    
451    # keep some of our install paths first in the list for the unit tests
452    env.PrependENVPath(LD_LIBRARY_PATH_KEY, env['libinstall'])
453    env.PrependENVPath('PYTHONPATH', prefix)
454    env['ENV']['ESCRIPT_ROOT'] = prefix
455    
456    if not env['verbose']:
457        env['CXXCOMSTR'] = "Compiling $TARGET"
458        env['SHCXXCOMSTR'] = "Compiling $TARGET"
459        env['ARCOMSTR'] = "Linking $TARGET"
460        env['LINKCOMSTR'] = "Linking $TARGET"
461        env['SHLINKCOMSTR'] = "Linking $TARGET"
462        env['PDFLATEXCOMSTR'] = "Building $TARGET from LaTeX input $SOURCES"
463        env['BIBTEXCOMSTR'] = "Generating bibliography $TARGET"
464        env['MAKEINDEXCOMSTR'] = "Generating index $TARGET"
465        env['PDFLATEXCOMSTR'] = "Building $TARGET from LaTeX input $SOURCES"
466        #Progress(['Checking -\r', 'Checking \\\r', 'Checking |\r', 'Checking /\r'], interval=17)
467    
468    ####################### Configure the subdirectories #########################
469    
470    # remove obsolete files
471    if not env['usempi']:
472        Execute(Delete(os.path.join(env['libinstall'], 'pythonMPI')))
473        Execute(Delete(os.path.join(env['libinstall'], 'pythonMPIredirect')))
474    
475    from grouptest import *
476    TestGroups=[]
477    
478    # keep an environment without warnings-as-errors
479    dodgy_env=env.Clone()
480    
481    # now add warnings-as-errors flags. This needs to be done after configuration
482    # because the scons test files have warnings in them
483    if ((fatalwarning != '') and (env['werror'])):
484        env.Append(CCFLAGS = fatalwarning)
485    
486    Export(
487      ['env',
488       'dodgy_env',
489       'IS_WINDOWS',
490       'TestGroups'
491      ]
492    )
493    
494    env.SConscript(dirs = ['tools/escriptconvert'], variant_dir='$BUILD_DIR/$PLATFORM/tools/escriptconvert', duplicate=0)
495    env.SConscript(dirs = ['paso/src'], variant_dir='$BUILD_DIR/$PLATFORM/paso', duplicate=0)
496    env.SConscript(dirs = ['weipa/src'], variant_dir='$BUILD_DIR/$PLATFORM/weipa', duplicate=0)
497    env.SConscript(dirs = ['escript/py_src'], variant_dir='$BUILD_DIR/$PLATFORM/escript', duplicate=0)
498    
499    #This will pull in the escriptcore/py_src and escriptcore/test
500    env.SConscript(dirs = ['escriptcore/src'], variant_dir='$BUILD_DIR/$PLATFORM/escriptcore', duplicate=0)
501    #env.SConscript(dirs = ['escript/test'], variant_dir='$BUILD_DIR/$PLATFORM/escript/test', duplicate=0)
502    env.SConscript(dirs = ['esysUtils/src'], variant_dir='$BUILD_DIR/$PLATFORM/esysUtils', duplicate=0)
503    env.SConscript(dirs = ['pasowrap/src'], variant_dir='$BUILD_DIR/$PLATFORM/pasowrap', duplicate=0)
504    env.SConscript(dirs = ['dudley/src'], variant_dir='$BUILD_DIR/$PLATFORM/dudley', duplicate=0)
505    env.SConscript(dirs = ['finley/src'], variant_dir='$BUILD_DIR/$PLATFORM/finley', duplicate=0)
506    env.SConscript(dirs = ['ripley/src'], variant_dir='$BUILD_DIR/$PLATFORM/ripley', duplicate=0)
507    env.SConscript(dirs = ['downunder/py_src'], variant_dir='$BUILD_DIR/$PLATFORM/downunder', duplicate=0)
508    env.SConscript(dirs = ['modellib/py_src'], variant_dir='$BUILD_DIR/$PLATFORM/modellib', duplicate=0)
509    env.SConscript(dirs = ['pycad/py_src'], variant_dir='$BUILD_DIR/$PLATFORM/pycad', duplicate=0)
510    env.SConscript(dirs = ['pythonMPI/src'], variant_dir='$BUILD_DIR/$PLATFORM/pythonMPI', duplicate=0)
511    env.SConscript(dirs = ['doc'], variant_dir='$BUILD_DIR/$PLATFORM/doc', duplicate=0)
512    env.SConscript(dirs = ['paso/profiling'], variant_dir='$BUILD_DIR/$PLATFORM/paso/profiling', duplicate=0)
513    
514    
515    ######################## Populate the buildvars file #########################
516    
517    write_buildvars(env)
518    
519    ################### Targets to build and install libraries ###################
520    
521    target_init = env.Command(os.path.join(env['pyinstall'],'__init__.py'), None, Touch('$TARGET'))
522    env.Alias('target_init', [target_init])
523    # delete buildvars upon cleanup
524    env.Clean('target_init', os.path.join(env['libinstall'], 'buildvars'))
525    
526    # The headers have to be installed prior to build in order to satisfy
527    # #include <paso/Common.h>
528    env.Alias('build_esysUtils', ['install_esysUtils_headers', 'build_esysUtils_lib'])
529    env.Alias('install_esysUtils', ['build_esysUtils', 'install_esysUtils_lib'])
530    
531    env.Alias('build_paso', ['install_paso_headers', 'build_paso_lib'])
532    env.Alias('install_paso', ['build_paso', 'install_paso_lib'])
533    
534    env.Alias('build_escript', ['install_escript_headers', 'build_escript_lib', 'build_escriptcpp_lib'])
535    env.Alias('install_escript', ['build_escript', 'install_escript_lib', 'install_escriptcpp_lib', 'install_escriptcore_py', 'install_escript_py'])
536    
537    env.Alias('build_pasowrap', ['install_pasowrap_headers', 'build_pasowrap_lib', 'build_pasowrapcpp_lib'])
538    env.Alias('install_pasowrap', ['build_pasowrap', 'install_pasowrap_lib', 'install_pasowrapcpp_lib', 'install_pasowrap_py'])
539    
540    env.Alias('build_dudley', ['install_dudley_headers', 'build_dudley_lib', 'build_dudleycpp_lib'])
541    env.Alias('install_dudley', ['build_dudley', 'install_dudley_lib', 'install_dudleycpp_lib', 'install_dudley_py'])
542    
543    env.Alias('build_finley', ['install_finley_headers', 'build_finley_lib', 'build_finleycpp_lib'])
544    env.Alias('install_finley', ['build_finley', 'install_finley_lib', 'install_finleycpp_lib', 'install_finley_py'])
545    
546    env.Alias('build_ripley', ['install_ripley_headers', 'build_ripley_lib', 'build_ripleycpp_lib'])
547    env.Alias('install_ripley', ['build_ripley', 'install_ripley_lib', 'install_ripleycpp_lib', 'install_ripley_py'])
548    
549    env.Alias('build_weipa', ['install_weipa_headers', 'build_weipa_lib', 'build_weipacpp_lib'])
550    env.Alias('install_weipa', ['build_weipa', 'install_weipa_lib', 'install_weipacpp_lib', 'install_weipa_py'])
551    
552    env.Alias('build_escriptreader', ['install_weipa_headers', 'build_escriptreader_lib'])
553    env.Alias('install_escriptreader', ['build_escriptreader', 'install_escriptreader_lib'])
554    
555    # Now gather all the above into some easy targets: build_all and install_all
556    build_all_list = []
557    build_all_list += ['build_esysUtils']
558    build_all_list += ['build_paso']
559    build_all_list += ['build_escript']
560    build_all_list += ['build_pasowrap']
561    build_all_list += ['build_dudley']
562    build_all_list += ['build_finley']
563    build_all_list += ['build_ripley']
564    build_all_list += ['build_weipa']
565    if not IS_WINDOWS: build_all_list += ['build_escriptreader']
566    if env['usempi']:   build_all_list += ['build_pythonMPI']
567    build_all_list += ['build_escriptconvert']
568    env.Alias('build_all', build_all_list)
569    
570    install_all_list = []
571    install_all_list += ['target_init']
572    install_all_list += ['install_esysUtils']
573    install_all_list += ['install_paso']
574    install_all_list += ['install_escript']
575    install_all_list += ['install_pasowrap']
576    install_all_list += ['install_dudley']
577    install_all_list += ['install_finley']
578    install_all_list += ['install_ripley']
579    install_all_list += ['install_weipa']
580    if not IS_WINDOWS: install_all_list += ['install_escriptreader']
581    install_all_list += ['install_downunder_py']
582    install_all_list += ['install_modellib_py']
583    install_all_list += ['install_pycad_py']
584    if env['usempi']:   install_all_list += ['install_pythonMPI']
585    install_all_list += ['install_escriptconvert']
586    env.Alias('install_all', install_all_list)
587    
588    # Default target is install
589    env.Default('install_all')
590    
591    ################## Targets to build and run the test suite ###################
592    
593    if not env['cppunit']:
594        test_msg = env.Command('.dummy.', None, '@echo "Cannot run C++ unit tests, CppUnit not found!";exit 1')
595        env.Alias('run_tests', test_msg)
596        env.Alias('build_tests', '')
597    env.Alias('run_tests', ['install_all'])
598    env.Alias('all_tests', ['install_all', 'run_tests', 'py_tests'])
599    env.Alias('build_full',['install_all','build_tests','build_py_tests'])
600    env.Alias('build_PasoTests','$BUILD_DIR/$PLATFORM/paso/profiling/PasoTests')
601    
602    ##################### Targets to build the documentation #####################
603    
604    env.Alias('pdfdocs',['user_pdf', 'install_pdf', 'cookbook_pdf', 'inversion_pdf'])
605    env.Alias('basedocs', ['pdfdocs','examples_tarfile', 'examples_zipfile', 'api_doxygen'])
606    env.Alias('docs', ['basedocs', 'sphinxdoc'])
607    env.Alias('release_prep', ['docs', 'install_all'])
608    env.Alias('release_prep_old', ['basedocs', 'api_epydoc', 'install_all'])
609    
610    # The test scripts are always generated, this target allows us to
611    # generate the testscripts without doing a full build
612    env.Alias('testscripts',[])
613    
614    if not IS_WINDOWS:
615        generateTestScripts(env, TestGroups)
616    
617    
618    
619    ######################## Summarize our environment ###########################
620    def print_summary():
621        print("")
622        print("*** Config Summary (see config.log and <prefix>/lib/buildvars for details) ***")
623        print("Escript/Finley revision %s"%global_revision)
624        print("  Install prefix:  %s"%env['prefix'])
625        print("          Python:  %s"%sysconfig.PREFIX)
626        print("           boost:  %s"%env['boost_prefix'])
627        if env['numpy_h']:
628            print("           numpy:  YES (with headers)")
629        else:
630            print("           numpy:  YES (without headers)")
631        if env['usempi']:
632            print("             MPI:  YES (flavour: %s)"%env['mpi'])
633        else:
634            print("             MPI:  DISABLED")
635        if env['uselapack']:
636            print("          LAPACK:  YES (flavour: %s)"%env['lapack'])
637        else:
638            print("          LAPACK:  DISABLED")
639        d_list=[]
640        e_list=[]
641        for i in 'debug','openmp','boomeramg','gdal','mkl','netcdf','papi','parmetis','pyproj','scipy','silo','sympy','umfpack','visit','vsl_random':
642            if env[i]: e_list.append(i)
643            else: d_list.append(i)
644        for i in e_list:
645            print("%16s:  YES"%i)
646        for i in d_list:
647            print("%16s:  DISABLED"%i)
648        if env['cppunit']:
649            print("         CppUnit:  FOUND")
650        else:
651            print("         CppUnit:  NOT FOUND")
652        if env['gmsh']=='m':
653            print("            gmsh:  FOUND, MPI-ENABLED")
654        elif env['gmsh']=='s':
655            print("            gmsh:  FOUND")
656        else:
657            print("            gmsh:  NOT FOUND")
658        print(    "            gzip:  " + ("YES" if env['compressed_files'] else "NO"))
659    
660        if ((fatalwarning != '') and (env['werror'])):
661            print("  Treating warnings as errors")
662        else:
663            print("  NOT treating warnings as errors")
664        print("")
665        for w in env['warnings']:
666            print("WARNING: %s"%w)
667        if len(GetBuildFailures()):
668            print("\nERROR: build stopped due to errors\n")
669        else:
670            print("\nSUCCESS: build complete\n")
671    
672    atexit.register(print_summary)
673    
 # Targets  
 env.Default(libinstall)  
 env.Default(incinstall)  
 env.Default(pyinstall)  
 env.Alias('build_tests')  
 env.Alias('run_tests')  
 env.Alias('py_tests')  
 env.Alias('all_tests', ['run_tests', 'py_tests'])  
   
 # Python install - esys __init__.py  
 # This is just an empty file but stills need to be touched so add a special target and Command. Note you can't use the scons Touch() function as it will not  
 # create the file if it doesn't exist  
 env.Command('esys/__init__.py', None, 'touch $TARGET')  
   
 # Allow sconscripts to see the env  
 Export(["env", "incinstall", "libinstall", "pyinstall", "dodebug", "mkl_libs", "scsl_libs", "umf_libs",  
     "boost_lib", "python_lib", "doxygen_path", "epydoc_path", "epydoc_pythonpath", "papi_libs", "cppunit_lib", "sys_libs" ])  
   
 # End initialisation section  
 # Begin configuration section  
 # Insert new components to be build here  
 # FIXME: might be nice to replace this verbosity with a list of targets and some  
 # FIXME: nifty python to create the lengthy but very similar env.Sconscript lines  
 # Third Party libraries  
 env.SConscript(dirs = ['tools/CppUnitTest/src'], build_dir='build/$PLATFORM/tools/CppUnitTest', duplicate=0)  
 # C/C++ Libraries  
 env.SConscript(dirs = ['paso/src'], build_dir='build/$PLATFORM/paso', duplicate=0)  
 env.SConscript(dirs = ['bruce/src'], build_dir='build/$PLATFORM/bruce', duplicate=0)  
 env.SConscript(dirs = ['escript/src'], build_dir='build/$PLATFORM/escript', duplicate=0)  
 env.SConscript(dirs = ['esysUtils/src'], build_dir='build/$PLATFORM/esysUtils', duplicate=0)  
 env.SConscript(dirs = ['finley/src'], build_dir='build/$PLATFORM/finley', duplicate=0)  
 env.SConscript(dirs = ['modellib/py_src'], build_dir='build/$PLATFORM/modellib', duplicate=0)  
   
 # FIXME:need to be incorporated into build system  
 # FIXME: 'pyvisi/SConstruct']  
 # FIXME: 'doc/SConstruct']  
 # FIXME: 'doc/SConstruct']  

Legend:
Removed from v.685  
changed lines
  Added in v.4820

  ViewVC Help
Powered by ViewVC 1.1.26