/[escript]/trunk/SConstruct
ViewVC logotype

Contents of /trunk/SConstruct

Parent Directory Parent Directory | Revision Log Revision Log

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