/[escript]/trunk/SConstruct
ViewVC logotype

Contents of /trunk/SConstruct

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3597 - (show annotations)
Thu Sep 15 06:03:17 2011 UTC (7 years, 7 months ago) by caltinay
File size: 34766 byte(s)
Switching to external cppunit:
-removed tools/CppUnitTest
-updated scons script and files
-updated tests to changed API
-updated readme

Bumped scons options file version to 201. Additions:
-cppunit*
-boomeramg*
-vsl_random


1 ########################################################
2 #
3 # Copyright (c) 2003-2010 by University of Queensland
4 # Earth Systems Science Computational Center (ESSCC)
5 # http://www.uq.edu.au/esscc
6 #
7 # Primary Business: Queensland, Australia
8 # Licensed under the Open Software License version 3.0
9 # http://www.opensource.org/licenses/osl-3.0.php
10 #
11 ########################################################
12
13 EnsureSConsVersion(0,98,1)
14 EnsurePythonVersion(2,5)
15
16 import sys, os, platform, re
17 from distutils import sysconfig
18 from site_init import *
19
20 # Version number to check for in options file. Increment when new features are
21 # added or existing options changed.
22 REQUIRED_OPTS_VERSION=201
23
24 # MS Windows support, many thanks to PH
25 IS_WINDOWS = (os.name == 'nt')
26
27 ########################## Determine options file ############################
28 # 1. command line
29 # 2. scons/<hostname>_options.py
30 # 3. name as part of a cluster
31 options_file=ARGUMENTS.get('options_file', None)
32 if not options_file:
33 ext_dir = os.path.join(os.getcwd(), 'scons')
34 hostname = platform.node().split('.')[0]
35 for name in hostname, effectiveName(hostname):
36 mangledhostname = re.sub('[^0-9a-zA-Z]', '_', hostname)
37 options_file = os.path.join(ext_dir, mangledhostname+'_options.py')
38 if os.path.isfile(options_file): break
39
40 if not os.path.isfile(options_file):
41 print("\nWARNING:\nOptions file %s" % options_file)
42 print("not found! Default options will be used which is most likely suboptimal.")
43 print("It is recommended that you copy one of the TEMPLATE files in the scons/")
44 print("subdirectory and customize it to your needs.\n")
45 options_file = None
46
47 ############################### Build options ################################
48
49 default_prefix='/usr'
50 mpi_flavours=('none', 'MPT', 'MPICH', 'MPICH2', 'OPENMPI', 'INTELMPI')
51 lapack_flavours=('none', 'clapack', 'mkl')
52
53 vars = Variables(options_file, ARGUMENTS)
54 vars.AddVariables(
55 PathVariable('options_file', 'Path to options file', options_file, PathVariable.PathIsFile),
56 PathVariable('prefix', 'Installation prefix', Dir('#.').abspath, PathVariable.PathIsDirCreate),
57 PathVariable('build_dir', 'Top-level build directory', Dir('#/build').abspath, PathVariable.PathIsDirCreate),
58 BoolVariable('verbose', 'Output full compile/link lines', False),
59 # Compiler/Linker options
60 ('cc', 'Path to C compiler', 'default'),
61 ('cxx', 'Path to C++ compiler', 'default'),
62 ('cc_flags', 'Base C/C++ compiler flags', 'default'),
63 ('cc_optim', 'Additional C/C++ flags for a non-debug build', 'default'),
64 ('cc_debug', 'Additional C/C++ flags for a debug build', 'default'),
65 ('cc_extra', 'Extra C compiler flags', ''),
66 ('cxx_extra', 'Extra C++ compiler flags', ''),
67 ('ld_extra', 'Extra linker flags', ''),
68 BoolVariable('werror','Treat compiler warnings as errors', True),
69 BoolVariable('debug', 'Compile with debug flags', False),
70 BoolVariable('openmp', 'Compile parallel version using OpenMP', False),
71 ('omp_flags', 'OpenMP compiler flags', 'default'),
72 ('omp_ldflags', 'OpenMP linker flags', 'default'),
73 # Mandatory libraries
74 ('boost_prefix', 'Prefix/Paths of boost installation', default_prefix),
75 ('boost_libs', 'Boost libraries to link with', ['boost_python-mt']),
76 # Mandatory for tests
77 ('cppunit_prefix', 'Prefix/Paths of CppUnit installation', default_prefix),
78 ('cppunit_libs', 'CppUnit libraries to link with', ['cppunit']),
79 # Optional libraries and options
80 EnumVariable('mpi', 'Compile parallel version using MPI flavour', 'none', allowed_values=mpi_flavours),
81 ('mpi_prefix', 'Prefix/Paths of MPI installation', default_prefix),
82 ('mpi_libs', 'MPI shared libraries to link with', ['mpi']),
83 BoolVariable('netcdf', 'Enable netCDF file support', False),
84 ('netcdf_prefix', 'Prefix/Paths of netCDF installation', default_prefix),
85 ('netcdf_libs', 'netCDF libraries to link with', ['netcdf_c++', 'netcdf']),
86 BoolVariable('parmetis', 'Enable ParMETIS (requires MPI)', False),
87 ('parmetis_prefix', 'Prefix/Paths of ParMETIS installation', default_prefix),
88 ('parmetis_libs', 'ParMETIS libraries to link with', ['parmetis', 'metis']),
89 BoolVariable('papi', 'Enable PAPI', False),
90 ('papi_prefix', 'Prefix/Paths to PAPI installation', default_prefix),
91 ('papi_libs', 'PAPI libraries to link with', ['papi']),
92 BoolVariable('papi_instrument_solver', 'Use PAPI to instrument each iteration of the solver', False),
93 BoolVariable('mkl', 'Enable the Math Kernel Library', False),
94 ('mkl_prefix', 'Prefix/Paths to MKL installation', default_prefix),
95 ('mkl_libs', 'MKL libraries to link with', ['mkl_solver','mkl_em64t','guide','pthread']),
96 BoolVariable('umfpack', 'Enable UMFPACK', False),
97 ('umfpack_prefix', 'Prefix/Paths to UMFPACK installation', default_prefix),
98 ('umfpack_libs', 'UMFPACK libraries to link with', ['umfpack']),
99 BoolVariable('boomeramg', 'Enable BoomerAMG', False),
100 ('boomeramg_prefix', 'Prefix/Paths to BoomerAMG installation', default_prefix),
101 ('boomeramg_libs', 'BoomerAMG libraries to link with', ['boomeramg']),
102 EnumVariable('lapack', 'Set LAPACK flavour', 'none', allowed_values=lapack_flavours),
103 ('lapack_prefix', 'Prefix/Paths to LAPACK installation', default_prefix),
104 ('lapack_libs', 'LAPACK libraries to link with', []),
105 BoolVariable('silo', 'Enable the Silo file format in weipa', False),
106 ('silo_prefix', 'Prefix/Paths to Silo installation', default_prefix),
107 ('silo_libs', 'Silo libraries to link with', ['siloh5', 'hdf5']),
108 BoolVariable('visit', 'Enable the VisIt simulation interface', False),
109 ('visit_prefix', 'Prefix/Paths to VisIt installation', default_prefix),
110 ('visit_libs', 'VisIt libraries to link with', ['simV2']),
111 BoolVariable('pyvisi', 'Enable pyvisi (deprecated, requires VTK module)', False),
112 BoolVariable('vsl_random', 'Use VSL from intel for random data', False),
113 # Advanced settings
114 #dudley_assemble_flags = -funroll-loops to actually do something
115 ('dudley_assemble_flags', 'compiler flags for some dudley optimisations', ''),
116 # To enable passing function pointers through python
117 BoolVariable('iknowwhatimdoing', 'Allow non-standard C', False),
118 # An option for specifying the compiler tools (see windows branch)
119 ('tools_names', 'Compiler tools to use', ['default']),
120 ('env_export', 'Environment variables to be passed to tools',[]),
121 EnumVariable('forcelazy', 'For testing use only - set the default value for autolazy', 'leave_alone', allowed_values=('leave_alone', 'on', 'off')),
122 EnumVariable('forcecollres', 'For testing use only - set the default value for force resolving collective ops', 'leave_alone', allowed_values=('leave_alone', 'on', 'off')),
123 # finer control over library building, intel aggressive global optimisation
124 # works with dynamic libraries on windows.
125 ('share_esysutils', 'Build a dynamic esysUtils library', False),
126 ('share_paso', 'Build a dynamic paso library', False),
127 ('sys_libs', 'Extra libraries to link with', []),
128 ('escript_opts_version', 'Version of options file (do not specify on command line)'),
129 )
130
131 ##################### Create environment and help text #######################
132
133 # Intel's compiler uses regular expressions improperly and emits a warning
134 # about failing to find the compilers. This warning can be safely ignored.
135
136 # PATH is needed so the compiler, linker and tools are found if they are not
137 # in default locations.
138 env = Environment(tools = ['default'], options = vars,
139 ENV = {'PATH': os.environ['PATH']})
140 if env['tools_names'] != 'default':
141 env = Environment(tools = ['default'] + env['tools_names'], options = vars,
142 ENV = {'PATH' : os.environ['PATH']})
143
144 if options_file:
145 opts_valid=False
146 if 'escript_opts_version' in env.Dictionary() and \
147 int(env['escript_opts_version']) >= REQUIRED_OPTS_VERSION:
148 opts_valid=True
149 if opts_valid:
150 print("Using options in %s." % options_file)
151 else:
152 print("\nOptions file %s" % options_file)
153 print("is outdated! Please update the file by examining one of the TEMPLATE")
154 print("files in the scons/ subdirectory and setting escript_opts_version to %d.\n"%REQUIRED_OPTS_VERSION)
155 Exit(1)
156
157 # Generate help text (scons -h)
158 Help(vars.GenerateHelpText(env))
159
160 # Check for superfluous options
161 if len(vars.UnknownVariables())>0:
162 for k in vars.UnknownVariables():
163 print("Unknown option '%s'" % k)
164 Exit(1)
165
166 #################### Make sure install directories exist #####################
167
168 env['BUILD_DIR']=env['build_dir']
169 prefix=Dir(env['prefix']).abspath
170 env['incinstall'] = os.path.join(prefix, 'include')
171 env['bininstall'] = os.path.join(prefix, 'bin')
172 env['libinstall'] = os.path.join(prefix, 'lib')
173 env['pyinstall'] = os.path.join(prefix, 'esys')
174 if not os.path.isdir(env['bininstall']):
175 os.makedirs(env['bininstall'])
176 if not os.path.isdir(env['libinstall']):
177 os.makedirs(env['libinstall'])
178 if not os.path.isdir(env['pyinstall']):
179 os.makedirs(env['pyinstall'])
180
181 env.Append(CPPPATH = [env['incinstall']])
182 env.Append(LIBPATH = [env['libinstall']])
183
184 ################# Fill in compiler options if not set above ##################
185
186 if env['cc'] != 'default': env['CC']=env['cc']
187 if env['cxx'] != 'default': env['CXX']=env['cxx']
188
189 # version >=9 of intel C++ compiler requires use of icpc to link in C++
190 # runtimes (icc does not)
191 if not IS_WINDOWS and os.uname()[4]=='ia64' and env['CXX']=='icpc':
192 env['LINK'] = env['CXX']
193
194 # default compiler/linker options
195 cc_flags = ''
196 cc_optim = ''
197 cc_debug = ''
198 omp_flags = ''
199 omp_ldflags = ''
200 fatalwarning = '' # switch to turn warnings into errors
201 sysheaderopt = '' # how to indicate that a header is a system header
202
203 # env['CC'] might be a full path
204 cc_name=os.path.basename(env['CC'])
205
206 if cc_name == 'icc':
207 # Intel compiler
208 cc_flags = "-std=c99 -fPIC -wd161 -w1 -vec-report0 -DBLOCKTIMER -DCORE_ID1"
209 cc_optim = "-O3 -ftz -IPF_ftlacc- -IPF_fma -fno-alias -ip"
210 cc_debug = "-g -O0 -DDOASSERT -DDOPROF -DBOUNDS_CHECK"
211 omp_flags = "-openmp -openmp_report0"
212 omp_ldflags = "-openmp -openmp_report0 -lguide -lpthread"
213 fatalwarning = "-Werror"
214 elif cc_name[:3] == 'gcc':
215 # GNU C on any system
216 cc_flags = "-pedantic -Wall -fPIC -ffast-math -Wno-unknown-pragmas -DBLOCKTIMER -Wno-sign-compare -Wno-system-headers -Wno-long-long -Wno-strict-aliasing -finline-functions"
217 cc_optim = "-O3"
218 cc_debug = "-g -O0 -DDOASSERT -DDOPROF -DBOUNDS_CHECK"
219 omp_flags = "-fopenmp"
220 omp_ldflags = "-fopenmp"
221 fatalwarning = "-Werror"
222 sysheaderopt = "-isystem"
223 elif cc_name == 'cl':
224 # Microsoft Visual C on Windows
225 cc_flags = "/EHsc /MD /GR /wd4068 /D_USE_MATH_DEFINES /DDLL_NETCDF"
226 cc_optim = "/O2 /Op /W3"
227 cc_debug = "/Od /RTCcsu /ZI /DBOUNDS_CHECK"
228 fatalwarning = "/WX"
229 elif cc_name == 'icl':
230 # Intel C on Windows
231 cc_flags = '/EHsc /GR /MD'
232 cc_optim = '/fast /Oi /W3 /Qssp /Qinline-factor- /Qinline-min-size=0 /Qunroll'
233 cc_debug = '/Od /RTCcsu /Zi /Y- /debug:all /Qtrapuv'
234 omp_flags = '/Qvec-report0 /Qopenmp /Qopenmp-report0 /Qparallel'
235 omp_ldflags = '/Qvec-report0 /Qopenmp /Qopenmp-report0 /Qparallel'
236
237 # set defaults if not otherwise specified
238 if env['cc_flags'] == 'default': env['cc_flags'] = cc_flags
239 if env['cc_optim'] == 'default': env['cc_optim'] = cc_optim
240 if env['cc_debug'] == 'default': env['cc_debug'] = cc_debug
241 if env['omp_flags'] == 'default': env['omp_flags'] = omp_flags
242 if env['omp_ldflags'] == 'default': env['omp_ldflags'] = omp_ldflags
243 if env['cc_extra'] != '': env.Append(CFLAGS = env['cc_extra'])
244 if env['cxx_extra'] != '': env.Append(CXXFLAGS = env['cxx_extra'])
245 if env['ld_extra'] != '': env.Append(LINKFLAGS = env['ld_extra'])
246
247 # set up the autolazy values
248 if env['forcelazy'] == 'on':
249 env.Append(CPPDEFINES=['FAUTOLAZYON'])
250 elif env['forcelazy'] == 'off':
251 env.Append(CPPDEFINES=['FAUTOLAZYOFF'])
252
253 # set up the collective resolve values
254 if env['forcecollres'] == 'on':
255 env.Append(CPPDEFINES=['FRESCOLLECTON'])
256 elif env['forcecollres'] == 'off':
257 env.Append(CPPDEFINES=['FRESCOLLECTOFF'])
258
259 # allow non-standard C if requested
260 if env['iknowwhatimdoing']:
261 env.Append(CPPDEFINES=['IKNOWWHATIMDOING'])
262
263 # Disable OpenMP if no flags provided
264 if env['openmp'] and env['omp_flags'] == '':
265 print("OpenMP requested but no flags provided - disabling OpenMP!")
266 env['openmp'] = False
267
268 if env['openmp']:
269 env.Append(CCFLAGS = env['omp_flags'])
270 if env['omp_ldflags'] != '': env.Append(LINKFLAGS = env['omp_ldflags'])
271 else:
272 env['omp_flags']=''
273 env['omp_ldflags']=''
274
275 # add debug/non-debug compiler flags
276 if env['debug']:
277 env.Append(CCFLAGS = env['cc_debug'])
278 else:
279 env.Append(CCFLAGS = env['cc_optim'])
280
281 # always add cc_flags
282 env.Append(CCFLAGS = env['cc_flags'])
283
284 # add system libraries
285 env.AppendUnique(LIBS = env['sys_libs'])
286
287 # Get the global Subversion revision number for the getVersion() method
288 try:
289 global_revision = os.popen('svnversion -n .').read()
290 global_revision = re.sub(':.*', '', global_revision)
291 global_revision = re.sub('[^0-9]', '', global_revision)
292 if global_revision == '': global_revision='-2'
293 except:
294 global_revision = '-1'
295 env['svn_revision']=global_revision
296 env.Append(CPPDEFINES=['SVN_VERSION='+global_revision])
297
298 if IS_WINDOWS:
299 if not env['share_esysutils']:
300 env.Append(CPPDEFINES = ['ESYSUTILS_STATIC_LIB'])
301 if not env['share_paso']:
302 env.Append(CPPDEFINES = ['PASO_STATIC_LIB'])
303
304 ###################### Copy required environment vars ########################
305
306 # Windows doesn't use LD_LIBRARY_PATH but PATH instead
307 if IS_WINDOWS:
308 LD_LIBRARY_PATH_KEY='PATH'
309 env['ENV']['LD_LIBRARY_PATH']=''
310 else:
311 LD_LIBRARY_PATH_KEY='LD_LIBRARY_PATH'
312
313 # the following env variables are exported for the unit tests
314
315 for key in 'OMP_NUM_THREADS', 'ESCRIPT_NUM_PROCS', 'ESCRIPT_NUM_NODES':
316 try:
317 env['ENV'][key] = os.environ[key]
318 except KeyError:
319 env['ENV'][key] = 1
320
321 env_export=env['env_export']
322 env_export.extend(['ESCRIPT_NUM_THREADS','ESCRIPT_HOSTFILE','DISPLAY','XAUTHORITY','PATH','HOME','TMPDIR','TEMP','TMP'])
323
324 for key in set(env_export):
325 try:
326 env['ENV'][key] = os.environ[key]
327 except KeyError:
328 pass
329
330 try:
331 env.PrependENVPath(LD_LIBRARY_PATH_KEY, os.environ[LD_LIBRARY_PATH_KEY])
332 except KeyError:
333 pass
334
335 # these shouldn't be needed
336 #for key in 'C_INCLUDE_PATH','CPLUS_INCLUDE_PATH','LIBRARY_PATH':
337 # try:
338 # env['ENV'][key] = os.environ[key]
339 # except KeyError:
340 # pass
341
342 try:
343 env['ENV']['PYTHONPATH'] = os.environ['PYTHONPATH']
344 except KeyError:
345 pass
346
347 ######################## Add some custom builders ############################
348
349 py_builder = Builder(action = build_py, suffix = '.pyc', src_suffix = '.py', single_source=True)
350 env.Append(BUILDERS = {'PyCompile' : py_builder});
351
352 runUnitTest_builder = Builder(action = runUnitTest, suffix = '.passed', src_suffix=env['PROGSUFFIX'], single_source=True)
353 env.Append(BUILDERS = {'RunUnitTest' : runUnitTest_builder});
354
355 runPyUnitTest_builder = Builder(action = runPyUnitTest, suffix = '.passed', src_suffic='.py', single_source=True)
356 env.Append(BUILDERS = {'RunPyUnitTest' : runPyUnitTest_builder});
357
358 epstopdfbuilder = Builder(action = eps2pdf, suffix='.pdf', src_suffix='.eps', single_source=True)
359 env.Append(BUILDERS = {'EpsToPDF' : epstopdfbuilder});
360
361 ############################ Dependency checks ###############################
362
363 # Create a Configure() environment to check for compilers and python
364 conf = Configure(env.Clone())
365
366 ######## Test that the compilers work
367
368 if 'CheckCC' in dir(conf): # exists since scons 1.1.0
369 if not conf.CheckCC():
370 print("Cannot run C compiler '%s' (check config.log)" % (env['CC']))
371 Exit(1)
372 if not conf.CheckCXX():
373 print("Cannot run C++ compiler '%s' (check config.log)" % (env['CXX']))
374 Exit(1)
375 else:
376 if not conf.CheckFunc('printf', language='c'):
377 print("Cannot run C compiler '%s' (check config.log)" % (env['CC']))
378 Exit(1)
379 if not conf.CheckFunc('printf', language='c++'):
380 print("Cannot run C++ compiler '%s' (check config.log)" % (env['CXX']))
381 Exit(1)
382
383 if conf.CheckFunc('gethostname'):
384 conf.env.Append(CPPDEFINES = ['HAVE_GETHOSTNAME'])
385
386 ######## Python headers & library (required)
387
388 python_inc_path=sysconfig.get_python_inc()
389 if IS_WINDOWS:
390 python_lib_path=os.path.join(sysconfig.get_config_var('prefix'), 'libs')
391 elif env['PLATFORM']=='darwin':
392 python_lib_path=sysconfig.get_config_var('LIBPL')
393 else:
394 python_lib_path=sysconfig.get_config_var('LIBDIR')
395 #python_libs=[sysconfig.get_config_var('LDLIBRARY')] # only on linux
396 if IS_WINDOWS:
397 python_libs=['python%s%s'%(sys.version_info[0], sys.version_info[1])]
398 else:
399 python_libs=['python'+sysconfig.get_python_version()]
400
401 if sysheaderopt == '':
402 conf.env.AppendUnique(CPPPATH = [python_inc_path])
403 else:
404 conf.env.Append(CCFLAGS = [sysheaderopt, python_inc_path])
405
406 conf.env.AppendUnique(LIBPATH = [python_lib_path])
407 conf.env.AppendUnique(LIBS = python_libs)
408 # The wrapper script needs to find the libs
409 conf.env.PrependENVPath(LD_LIBRARY_PATH_KEY, python_lib_path)
410
411 if not conf.CheckCHeader('Python.h'):
412 print("Cannot find python include files (tried 'Python.h' in directory %s)" % (python_inc_path))
413 Exit(1)
414 if not conf.CheckFunc('Py_Exit'):
415 print("Cannot find python library method Py_Main (tried %s in directory %s)" % (python_libs, python_lib_path))
416 Exit(1)
417
418 # Commit changes to environment
419 env = conf.Finish()
420
421 ######## boost (required)
422
423 boost_inc_path,boost_lib_path=findLibWithHeader(env, env['boost_libs'], 'boost/python.hpp', env['boost_prefix'], lang='c++')
424 if sysheaderopt == '':
425 env.AppendUnique(CPPPATH = [boost_inc_path])
426 else:
427 # This is required because we can't -isystem /usr/include since it breaks
428 # std includes
429 if os.path.normpath(boost_inc_path) == '/usr/include':
430 conf.env.Append(CCFLAGS=[sysheaderopt, os.path.join(boost_inc_path,'boost')])
431 else:
432 env.Append(CCFLAGS=[sysheaderopt, boost_inc_path])
433
434 env.AppendUnique(LIBPATH = [boost_lib_path])
435 env.AppendUnique(LIBS = env['boost_libs'])
436 env.PrependENVPath(LD_LIBRARY_PATH_KEY, boost_lib_path)
437
438 ######## numpy (required)
439
440 try:
441 from numpy import identity
442 except ImportError:
443 print("Cannot import numpy, you need to set your PYTHONPATH and probably %s"%LD_LIBRARY_PATH_KEY)
444 Exit(1)
445
446 ######## CppUnit (required for tests)
447
448 try:
449 cppunit_inc_path,cppunit_lib_path=findLibWithHeader(env, env['cppunit_libs'], 'cppunit/TestFixture.h', env['cppunit_prefix'], lang='c++')
450 env.AppendUnique(CPPPATH = [cppunit_inc_path])
451 env.AppendUnique(LIBPATH = [cppunit_lib_path])
452 env.PrependENVPath(LD_LIBRARY_PATH_KEY, cppunit_lib_path)
453 env['cppunit']=True
454 except:
455 env['cppunit']=False
456
457 ######## VTK (optional)
458
459 if env['pyvisi']:
460 try:
461 import vtk
462 env['pyvisi'] = True
463 except ImportError:
464 print("Cannot import vtk, disabling pyvisi.")
465 env['pyvisi'] = False
466
467 ######## netCDF (optional)
468
469 netcdf_inc_path=''
470 netcdf_lib_path=''
471 if env['netcdf']:
472 netcdf_inc_path,netcdf_lib_path=findLibWithHeader(env, env['netcdf_libs'], 'netcdf.h', env['netcdf_prefix'], lang='c++')
473 env.AppendUnique(CPPPATH = [netcdf_inc_path])
474 env.AppendUnique(LIBPATH = [netcdf_lib_path])
475 env.AppendUnique(LIBS = env['netcdf_libs'])
476 env.PrependENVPath(LD_LIBRARY_PATH_KEY, netcdf_lib_path)
477 env.Append(CPPDEFINES = ['USE_NETCDF'])
478
479 ######## PAPI (optional)
480
481 papi_inc_path=''
482 papi_lib_path=''
483 if env['papi']:
484 papi_inc_path,papi_lib_path=findLibWithHeader(env, env['papi_libs'], 'papi.h', env['papi_prefix'], lang='c')
485 env.AppendUnique(CPPPATH = [papi_inc_path])
486 env.AppendUnique(LIBPATH = [papi_lib_path])
487 env.AppendUnique(LIBS = env['papi_libs'])
488 env.PrependENVPath(LD_LIBRARY_PATH_KEY, papi_lib_path)
489 env.Append(CPPDEFINES = ['BLOCKPAPI'])
490
491 ######## MKL (optional)
492
493 mkl_inc_path=''
494 mkl_lib_path=''
495 if env['mkl']:
496 mkl_inc_path,mkl_lib_path=findLibWithHeader(env, env['mkl_libs'], 'mkl_solver.h', env['mkl_prefix'], lang='c')
497 env.AppendUnique(CPPPATH = [mkl_inc_path])
498 env.AppendUnique(LIBPATH = [mkl_lib_path])
499 env.AppendUnique(LIBS = env['mkl_libs'])
500 env.PrependENVPath(LD_LIBRARY_PATH_KEY, mkl_lib_path)
501 env.Append(CPPDEFINES = ['MKL'])
502
503 ######## UMFPACK (optional)
504
505 umfpack_inc_path=''
506 umfpack_lib_path=''
507 if env['umfpack']:
508 umfpack_inc_path,umfpack_lib_path=findLibWithHeader(env, env['umfpack_libs'], 'umfpack.h', env['umfpack_prefix'], lang='c')
509 env.AppendUnique(CPPPATH = [umfpack_inc_path])
510 env.AppendUnique(LIBPATH = [umfpack_lib_path])
511 env.AppendUnique(LIBS = env['umfpack_libs'])
512 env.PrependENVPath(LD_LIBRARY_PATH_KEY, umfpack_lib_path)
513 env.Append(CPPDEFINES = ['UMFPACK'])
514
515 ######## LAPACK (optional)
516
517 if env['lapack']=='mkl' and not env['mkl']:
518 print("mkl_lapack requires MKL!")
519 Exit(1)
520
521 env['uselapack'] = env['lapack']!='none'
522 lapack_inc_path=''
523 lapack_lib_path=''
524 if env['uselapack']:
525 header='clapack.h'
526 if env['lapack']=='mkl':
527 env.AppendUnique(CPPDEFINES = ['MKL_LAPACK'])
528 header='mkl_lapack.h'
529 lapack_inc_path,lapack_lib_path=findLibWithHeader(env, env['lapack_libs'], header, env['lapack_prefix'], lang='c')
530 env.AppendUnique(CPPPATH = [lapack_inc_path])
531 env.AppendUnique(LIBPATH = [lapack_lib_path])
532 env.AppendUnique(LIBS = env['lapack_libs'])
533 env.Append(CPPDEFINES = ['USE_LAPACK'])
534
535 ######## Silo (optional)
536
537 silo_inc_path=''
538 silo_lib_path=''
539 if env['silo']:
540 silo_inc_path,silo_lib_path=findLibWithHeader(env, env['silo_libs'], 'silo.h', env['silo_prefix'], lang='c')
541 env.AppendUnique(CPPPATH = [silo_inc_path])
542 env.AppendUnique(LIBPATH = [silo_lib_path])
543 # Note that we do not add the libs since they are only needed for the
544 # weipa library and tools.
545 #env.AppendUnique(LIBS = [env['silo_libs']])
546
547 ######## VSL random numbers (optional)
548 if env['vsl_random']:
549 env.Append(CPPDEFINES = ['MKLRANDOM'])
550
551 ######## VisIt (optional)
552
553 visit_inc_path=''
554 visit_lib_path=''
555 if env['visit']:
556 visit_inc_path,visit_lib_path=findLibWithHeader(env, env['visit_libs'], 'VisItControlInterface_V2.h', env['visit_prefix'], lang='c')
557 env.AppendUnique(CPPPATH = [visit_inc_path])
558 env.AppendUnique(LIBPATH = [visit_lib_path])
559
560 ######## MPI (optional)
561
562 env['usempi'] = env['mpi']!='none'
563 mpi_inc_path=''
564 mpi_lib_path=''
565 if env['usempi']:
566 mpi_inc_path,mpi_lib_path=findLibWithHeader(env, env['mpi_libs'], 'mpi.h', env['mpi_prefix'], lang='c')
567 env.AppendUnique(CPPPATH = [mpi_inc_path])
568 env.AppendUnique(LIBPATH = [mpi_lib_path])
569 env.AppendUnique(LIBS = env['mpi_libs'])
570 env.PrependENVPath(LD_LIBRARY_PATH_KEY, mpi_lib_path)
571 env.Append(CPPDEFINES = ['ESYS_MPI', 'MPI_NO_CPPBIND', 'MPICH_IGNORE_CXX_SEEK'])
572 # NetCDF 4.1 defines MPI_Comm et al. if MPI_INCLUDED is not defined!
573 # On the other hand MPT and OpenMPI don't define the latter so we have to
574 # do that here
575 if env['netcdf'] and env['mpi'] in ['MPT','OPENMPI']:
576 env.Append(CPPDEFINES = ['MPI_INCLUDED'])
577
578 ######## BOOMERAMG (optional)
579
580 if env['mpi'] == 'none': env['boomeramg'] = False
581
582 boomeramg_inc_path=''
583 boomeramg_lib_path=''
584 if env['boomeramg']:
585 boomeramg_inc_path,boomeramg_lib_path=findLibWithHeader(env, env['boomeramg_libs'], 'HYPRE.h', env['boomeramg_prefix'], lang='c')
586 env.AppendUnique(CPPPATH = [boomeramg_inc_path])
587 env.AppendUnique(LIBPATH = [boomeramg_lib_path])
588 env.AppendUnique(LIBS = env['boomeramg_libs'])
589 env.PrependENVPath(LD_LIBRARY_PATH_KEY, boomeramg_lib_path)
590 env.Append(CPPDEFINES = ['BOOMERAMG'])
591
592 ######## ParMETIS (optional)
593
594 if not env['usempi']: env['parmetis'] = False
595
596 parmetis_inc_path=''
597 parmetis_lib_path=''
598 if env['parmetis']:
599 parmetis_inc_path,parmetis_lib_path=findLibWithHeader(env, env['parmetis_libs'], 'parmetis.h', env['parmetis_prefix'], lang='c')
600 env.AppendUnique(CPPPATH = [parmetis_inc_path])
601 env.AppendUnique(LIBPATH = [parmetis_lib_path])
602 env.AppendUnique(LIBS = env['parmetis_libs'])
603 env.PrependENVPath(LD_LIBRARY_PATH_KEY, parmetis_lib_path)
604 env.Append(CPPDEFINES = ['USE_PARMETIS'])
605
606 ######## gmsh (optional, for tests)
607
608 try:
609 import subprocess
610 p=subprocess.Popen(['gmsh', '-info'], stderr=subprocess.PIPE)
611 _,e=p.communicate()
612 if e.split().count("MPI"):
613 env['gmsh']='m'
614 else:
615 env['gmsh']='s'
616 except OSError:
617 env['gmsh']=False
618
619 ######################## Summarize our environment ###########################
620
621 # keep some of our install paths first in the list for the unit tests
622 env.PrependENVPath(LD_LIBRARY_PATH_KEY, env['libinstall'])
623 env.PrependENVPath('PYTHONPATH', prefix)
624 env['ENV']['ESCRIPT_ROOT'] = prefix
625
626 if not env['verbose']:
627 env['CCCOMSTR'] = "Compiling $TARGET"
628 env['CXXCOMSTR'] = "Compiling $TARGET"
629 env['SHCCCOMSTR'] = "Compiling $TARGET"
630 env['SHCXXCOMSTR'] = "Compiling $TARGET"
631 env['ARCOMSTR'] = "Linking $TARGET"
632 env['LINKCOMSTR'] = "Linking $TARGET"
633 env['SHLINKCOMSTR'] = "Linking $TARGET"
634 env['PDFLATEXCOMSTR'] = "Building $TARGET from LaTeX input $SOURCES"
635 env['BIBTEXCOMSTR'] = "Generating bibliography $TARGET"
636 env['MAKEINDEXCOMSTR'] = "Generating index $TARGET"
637 env['PDFLATEXCOMSTR'] = "Building $TARGET from LaTeX input $SOURCES"
638 #Progress(['Checking -\r', 'Checking \\\r', 'Checking |\r', 'Checking /\r'], interval=17)
639
640 print("")
641 print("*** Config Summary (see config.log and lib/buildvars for details) ***")
642 print("Escript/Finley revision %s"%global_revision)
643 print(" Install prefix: %s"%env['prefix'])
644 print(" Python: %s"%sysconfig.PREFIX)
645 print(" boost: %s"%env['boost_prefix'])
646 print(" numpy: YES")
647 if env['usempi']:
648 print(" MPI: YES (flavour: %s)"%env['mpi'])
649 else:
650 print(" MPI: DISABLED")
651 if env['uselapack']:
652 print(" LAPACK: YES (flavour: %s)"%env['lapack'])
653 else:
654 print(" LAPACK: DISABLED")
655 d_list=[]
656 e_list=[]
657 for i in 'debug','openmp','netcdf','parmetis','papi','mkl','umfpack','boomeramg','silo','visit':
658 if env[i]: e_list.append(i)
659 else: d_list.append(i)
660 for i in e_list:
661 print("%16s: YES"%i)
662 for i in d_list:
663 print("%16s: DISABLED"%i)
664 if env['cppunit']:
665 print(" CppUnit: FOUND")
666 else:
667 print(" CppUnit: NOT FOUND")
668 if env['gmsh']=='m':
669 print(" gmsh: FOUND, MPI-ENABLED")
670 elif env['gmsh']=='s':
671 print(" gmsh: FOUND")
672 else:
673 print(" gmsh: NOT FOUND")
674 print(" vsl_random: %s"%env['vsl_random'])
675
676 if ((fatalwarning != '') and (env['werror'])):
677 print(" Treating warnings as errors")
678 else:
679 print(" NOT treating warnings as errors")
680 print("")
681
682 ####################### Configure the subdirectories #########################
683
684 from grouptest import *
685
686 TestGroups=[]
687
688 # keep an environment without warnings-as-errors
689 dodgy_env=env.Clone()
690
691 # now add warnings-as-errors flags. This needs to be done after configuration
692 # because the scons test files have warnings in them
693 if ((fatalwarning != '') and (env['werror'])):
694 env.Append(CCFLAGS = fatalwarning)
695
696 Export(
697 ['env',
698 'dodgy_env',
699 'IS_WINDOWS',
700 'TestGroups'
701 ]
702 )
703
704 env.SConscript(dirs = ['tools/escriptconvert'], variant_dir='$BUILD_DIR/$PLATFORM/tools/escriptconvert', duplicate=0)
705 env.SConscript(dirs = ['paso/src'], variant_dir='$BUILD_DIR/$PLATFORM/paso', duplicate=0)
706 env.SConscript(dirs = ['weipa/src'], variant_dir='$BUILD_DIR/$PLATFORM/weipa', duplicate=0)
707 env.SConscript(dirs = ['escript/src'], variant_dir='$BUILD_DIR/$PLATFORM/escript', duplicate=0)
708 env.SConscript(dirs = ['esysUtils/src'], variant_dir='$BUILD_DIR/$PLATFORM/esysUtils', duplicate=0)
709 env.SConscript(dirs = ['dudley/src'], variant_dir='$BUILD_DIR/$PLATFORM/dudley', duplicate=0)
710 env.SConscript(dirs = ['finley/src'], variant_dir='$BUILD_DIR/$PLATFORM/finley', duplicate=0)
711 env.SConscript(dirs = ['modellib/py_src'], variant_dir='$BUILD_DIR/$PLATFORM/modellib', duplicate=0)
712 env.SConscript(dirs = ['doc'], variant_dir='$BUILD_DIR/$PLATFORM/doc', duplicate=0)
713 env.SConscript(dirs = ['pyvisi/py_src'], variant_dir='$BUILD_DIR/$PLATFORM/pyvisi', duplicate=0)
714 env.SConscript(dirs = ['pycad/py_src'], variant_dir='$BUILD_DIR/$PLATFORM/pycad', duplicate=0)
715 env.SConscript(dirs = ['pythonMPI/src'], variant_dir='$BUILD_DIR/$PLATFORM/pythonMPI', duplicate=0)
716 env.SConscript(dirs = ['paso/profiling'], variant_dir='$BUILD_DIR/$PLATFORM/paso/profiling', duplicate=0)
717
718 ######################## Populate the buildvars file #########################
719
720 # remove obsolete file
721 if not env['usempi']:
722 Execute(Delete(os.path.join(env['libinstall'], 'pythonMPI')))
723 Execute(Delete(os.path.join(env['libinstall'], 'pythonMPIredirect')))
724
725 # Try to extract the boost version from version.hpp
726 boosthpp=open(os.path.join(boost_inc_path, 'boost', 'version.hpp'))
727 boostversion='unknown'
728 try:
729 for line in boosthpp:
730 ver=re.match(r'#define BOOST_VERSION (\d+)',line)
731 if ver:
732 boostversion=ver.group(1)
733 except StopIteration:
734 pass
735 boosthpp.close()
736
737 buildvars=open(os.path.join(env['libinstall'], 'buildvars'), 'w')
738 buildvars.write("svn_revision="+str(global_revision)+"\n")
739 buildvars.write("prefix="+prefix+"\n")
740 buildvars.write("cc="+env['CC']+"\n")
741 buildvars.write("cxx="+env['CXX']+"\n")
742 buildvars.write("python="+sys.executable+"\n")
743 buildvars.write("python_version="+str(sys.version_info[0])+"."+str(sys.version_info[1])+"."+str(sys.version_info[2])+"\n")
744 buildvars.write("boost_inc_path="+boost_inc_path+"\n")
745 buildvars.write("boost_lib_path="+boost_lib_path+"\n")
746 buildvars.write("boost_version="+boostversion+"\n")
747 buildvars.write("debug=%d\n"%int(env['debug']))
748 buildvars.write("openmp=%d\n"%int(env['openmp']))
749 buildvars.write("mpi=%s\n"%env['mpi'])
750 buildvars.write("mpi_inc_path=%s\n"%mpi_inc_path)
751 buildvars.write("mpi_lib_path=%s\n"%mpi_lib_path)
752 buildvars.write("lapack=%s\n"%env['lapack'])
753 buildvars.write("pyvisi=%d\n"%env['pyvisi'])
754 buildvars.write("vsl_random=%d\n"%int(env['vsl_random']))
755 for i in 'netcdf','parmetis','papi','mkl','umfpack','boomeramg','silo','visit':
756 buildvars.write("%s=%d\n"%(i, int(env[i])))
757 if env[i]:
758 buildvars.write("%s_inc_path=%s\n"%(i, eval(i+'_inc_path')))
759 buildvars.write("%s_lib_path=%s\n"%(i, eval(i+'_lib_path')))
760 buildvars.close()
761
762 ################### Targets to build and install libraries ###################
763
764 target_init = env.Command(env['pyinstall']+'/__init__.py', None, Touch('$TARGET'))
765 env.Alias('target_init', [target_init])
766
767 # The headers have to be installed prior to build in order to satisfy
768 # #include <paso/Common.h>
769 env.Alias('build_esysUtils', ['install_esysUtils_headers', 'build_esysUtils_lib'])
770 env.Alias('install_esysUtils', ['build_esysUtils', 'install_esysUtils_lib'])
771
772 env.Alias('build_paso', ['install_paso_headers', 'build_paso_lib'])
773 env.Alias('install_paso', ['build_paso', 'install_paso_lib'])
774
775 env.Alias('build_escript', ['install_escript_headers', 'build_escript_lib', 'build_escriptcpp_lib'])
776 env.Alias('install_escript', ['build_escript', 'install_escript_lib', 'install_escriptcpp_lib', 'install_escript_py'])
777
778 env.Alias('build_dudley', ['install_dudley_headers', 'build_dudley_lib', 'build_dudleycpp_lib'])
779 env.Alias('install_dudley', ['build_dudley', 'install_dudley_lib', 'install_dudleycpp_lib', 'install_dudley_py'])
780
781 env.Alias('build_finley', ['install_finley_headers', 'build_finley_lib', 'build_finleycpp_lib'])
782 env.Alias('install_finley', ['build_finley', 'install_finley_lib', 'install_finleycpp_lib', 'install_finley_py'])
783
784 env.Alias('build_weipa', ['install_weipa_headers', 'build_weipa_lib', 'build_weipacpp_lib'])
785 env.Alias('install_weipa', ['build_weipa', 'install_weipa_lib', 'install_weipacpp_lib', 'install_weipa_py'])
786
787 env.Alias('build_escriptreader', ['install_weipa_headers', 'build_escriptreader_lib'])
788 env.Alias('install_escriptreader', ['build_escriptreader', 'install_escriptreader_lib'])
789
790 # Now gather all the above into some easy targets: build_all and install_all
791 build_all_list = []
792 build_all_list += ['build_esysUtils']
793 build_all_list += ['build_paso']
794 build_all_list += ['build_escript']
795 build_all_list += ['build_dudley']
796 build_all_list += ['build_finley']
797 build_all_list += ['build_weipa']
798 if not IS_WINDOWS: build_all_list += ['build_escriptreader']
799 if env['usempi']: build_all_list += ['build_pythonMPI']
800 build_all_list += ['build_escriptconvert']
801 env.Alias('build_all', build_all_list)
802
803 install_all_list = []
804 install_all_list += ['target_init']
805 install_all_list += ['install_esysUtils']
806 install_all_list += ['install_paso']
807 install_all_list += ['install_escript']
808 install_all_list += ['install_dudley']
809 install_all_list += ['install_finley']
810 install_all_list += ['install_weipa']
811 if not IS_WINDOWS: install_all_list += ['install_escriptreader']
812 install_all_list += ['install_pyvisi_py']
813 install_all_list += ['install_modellib_py']
814 install_all_list += ['install_pycad_py']
815 if env['usempi']: install_all_list += ['install_pythonMPI']
816 install_all_list += ['install_escriptconvert']
817 env.Alias('install_all', install_all_list)
818
819 # Default target is install
820 env.Default('install_all')
821
822 ################## Targets to build and run the test suite ###################
823
824 test_msg = env.Command('.dummy.', None, '@echo "Cannot run C/C++ unit tests, CppUnit not found!";exit 1')
825 if not env['cppunit']:
826 env.Alias('run_tests', test_msg)
827 env.Alias('run_tests', ['install_all'])
828 env.Alias('all_tests', ['install_all', 'run_tests', 'py_tests'])
829 env.Alias('build_full',['install_all','build_tests','build_py_tests'])
830 env.Alias('build_PasoTests','$BUILD_DIR/$PLATFORM/paso/profiling/PasoTests')
831
832 ##################### Targets to build the documentation #####################
833
834 env.Alias('api_epydoc','install_all')
835 env.Alias('docs', ['examples_tarfile', 'examples_zipfile', 'api_epydoc', 'api_doxygen', 'user_pdf', 'install_pdf', 'cookbook_pdf'])
836 env.Alias('release_prep', ['docs', 'install_all'])
837
838 if not IS_WINDOWS:
839 try:
840 utest=open('utest.sh','w')
841 utest.write(GroupTest.makeHeader(env['PLATFORM']))
842 for tests in TestGroups:
843 utest.write(tests.makeString())
844 utest.close()
845 Execute(Chmod('utest.sh', 0755))
846 print("Generated utest.sh.")
847 except IOError:
848 print("Error attempting to write unittests file.")
849 Exit(1)
850
851 # Make sure that the escript wrapper is in place
852 if not os.path.isfile(os.path.join(env['bininstall'], 'run-escript')):
853 print("Copying escript wrapper.")
854 Execute(Copy(os.path.join(env['bininstall'],'run-escript'), 'bin/run-escript'))
855

  ViewVC Help
Powered by ViewVC 1.1.26