/[escript]/trunk/SConstruct
ViewVC logotype

Annotation of /trunk/SConstruct

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3343 - (hide annotations)
Wed Nov 10 02:01:29 2010 UTC (8 years, 10 months ago) by jfenwick
File size: 32405 byte(s)
Rename users guide to user.pdf from guide.pdf to match the conventions 
we follow with the other files.

Corrected the description of Einstein convention from "convenient"
to "compact". 

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

  ViewVC Help
Powered by ViewVC 1.1.26