Contents of /trunk/doc/SConscript


##############################################################################
#
# Copyright (c) 2003-2018 by The University of Queensland
# http://www.uq.edu.au
#
# Primary Business: Queensland, Australia
# Licensed under the Apache License, version 2.0
# http://www.apache.org/licenses/LICENSE-2.0
#
# Development until 2012 by Earth Systems Science Computational Center (ESSCC)
# Development 2012-2013 by School of Earth Sciences
# Development from 2014 by Centre for Geoscience Computing (GeoComp)
#
##############################################################################

import os
Import('*')

from subprocess import PIPE, Popen

haveMPL=False   # do we have matplotlib?
haveGD=False    # does matplotlib have griddata?

mplmagicversion='0.98.5'

# check for matplotlib
if env['pythoncmd']=='python':
  try:
    import matplotlib
    haveMPL=True
    mplversion=matplotlib.__version__
    from matplotlib.mlab import griddata
    haveGD=True
  except ImportError:
    pass
else:
  # we need to fire up the external command
    p=Popen([env['pythoncmd'], '-c', 'from __future__ import print_function;import matplotlib;print(matplotlib.__version__);from matplotlib.mlab import griddata;print("1")'], stdout=PIPE)
    try:
        mplversion=p.stdout.readline().strip()
        if mplversion!='':
           haveMPL=True
           hgd=p.stdout.readline().strip()
           haveGD=True
    except IOError:
        pass
    p.wait()

if not haveMPL:
    env['warnings'].append("matplotlib not found, will skip some unit tests")
else:
    import sys
    if sys.version_info[0] == 3:
        mplversion = str(mplversion, 'utf-8')
    else:
        mplversion = str(mplversion)
    if mplversion<mplmagicversion:
        env['warnings'].append("matplotlib found, but version too early. Some unit tests will be skipped.")

example_files_allow_mpi = []
example_files_no_mpi = []
example_deps = []
skipped_tests = []

def sortOutExample(name, needsGMSH=False, needsMPL=False, needsMagicMPL=False, needsGD=False, allowsMPI=True):
    if needsMagicMPL: needsMPL=True
    if needsGD: needsMPL=True
    if needsGMSH: allowsMPI=False

    if needsGMSH and not env['gmsh']:
        skipped_tests.append(name)
        return

    if (not needsGMSH or env['gmsh']) and (not needsMPL or haveMPL) and (not needsMagicMPL or mplversion>=mplmagicversion) and (not needsGD or haveGD):
        if allowsMPI:
            example_files_allow_mpi.append(name)
        else:
            example_files_no_mpi.append(name)
    else:
        example_deps.append(name)

# these are the release examples in example subdirectory:
#
#_deps is for files which end in .py and are required for
# testing but should not be invoked directly themselves

sortOutExample('usersguide/lid_driven_cavity.py')
sortOutExample('usersguide/mount.py')
sortOutExample('usersguide/heatedblock.py')
sortOutExample('usersguide/helmholtz.py')
sortOutExample('usersguide/fluid.py')
sortOutExample('usersguide/poisson.py')
sortOutExample('usersguide/diffusion.py')
sortOutExample('usersguide/poisson_vtk.py')
sortOutExample('usersguide/darcy.py')
sortOutExample('usersguide/dirac.py')
sortOutExample('usersguide/slip.py')
sortOutExample('usersguide/int_save.py')
sortOutExample('usersguide/wave.py', needsMPL=True)
sortOutExample('usersguide/trapezoid.py', needsGMSH=True, allowsMPI=False)
sortOutExample('usersguide/quad.py', needsGMSH=True)
sortOutExample('usersguide/brick.py', needsGMSH=True)
sortOutExample('usersguide/refine.py', needsGMSH=True)
sortOutExample('usersguide/poisson_matplotlib.py', allowsMPI=False, needsGD=True)
sortOutExample('usersguide/voxet_reader.py')

sortOutExample('geotutorial/steadystate_variablek.py')
sortOutExample('geotutorial/steadystate.py')
sortOutExample('geotutorial/forward_euler.py')
sortOutExample('geotutorial/myfirstscript.py')
sortOutExample('geotutorial/backward_euler.py')

example_deps.append('cookbook/cblib.py')
sortOutExample('cookbook/example01a.py')
sortOutExample('cookbook/example01b.py', needsMPL=True)
sortOutExample('cookbook/example01c.py', needsMPL=True, allowsMPI=False)
sortOutExample('cookbook/example02.py', needsMPL=True, allowsMPI=False)
sortOutExample('cookbook/example03a.py', allowsMPI=False)
sortOutExample('cookbook/example03b.py')
sortOutExample('cookbook/example04a.py', needsGMSH=True)
sortOutExample('cookbook/example04b.py', needsGMSH=True, )
sortOutExample('cookbook/example05a.py', needsGMSH=True, )
sortOutExample('cookbook/example05b.py', needsGMSH=True)
sortOutExample('cookbook/example05c.py', needsGMSH=True, needsMagicMPL=True)
sortOutExample('cookbook/example06.py', needsGMSH=True, needsMagicMPL=True)
sortOutExample('cookbook/example07a.py', needsMagicMPL=True, allowsMPI=False)
sortOutExample('cookbook/example07b.py', needsMagicMPL=True, allowsMPI=False)
sortOutExample('cookbook/example08a.py', needsMagicMPL=True, allowsMPI=False)
sortOutExample('cookbook/example08b.py', needsMagicMPL=True, allowsMPI=False)
sortOutExample('cookbook/example08c.py', needsMagicMPL=True, needsGMSH=True, allowsMPI=False)
sortOutExample('cookbook/example09m.py', needsMagicMPL=True, needsGMSH=True, allowsMPI=False)
sortOutExample('cookbook/example09a.py', needsMagicMPL=True, needsGMSH=True, allowsMPI=False)
#sortOutExample('cookbook/example09b.py', needsMagicMPL=True, needsGMSH=True, allowsMPI=False)
sortOutExample('cookbook/example10a.py', needsMagicMPL=True, allowsMPI=False)
sortOutExample('cookbook/example10b.py', needsMagicMPL=True, allowsMPI=False)
sortOutExample('cookbook/example10m.py', needsMagicMPL=True, needsGMSH=True, allowsMPI=False)
#sortOutExample('cookbook/example10c_0.py', needsMagicMPL=True, needsGMSH=True, allowsMPI=False)
#sortOutExample('cookbook/example10c_1.py', needsMagicMPL=True, needsGMSH=True, allowsMPI=False)
sortOutExample('cookbook/example11a.py', needsMagicMPL=True, allowsMPI=False)
sortOutExample('cookbook/example11b.py', needsMagicMPL=True, allowsMPI=False)

sortOutExample('inversion/create_netcdf.py')
sortOutExample('inversion/grav_ermapper.py')
sortOutExample('inversion/grav_netcdf.py')
sortOutExample('inversion/gravmag_netcdf.py')
sortOutExample('inversion/gravmag_nodriver.py')
sortOutExample('inversion/mag_netcdf.py')
sortOutExample('inversion/plot_ermapper.py', needsMPL=True, allowsMPI=False)
sortOutExample('inversion/plot_netcdf.py', needsMPL=True, allowsMPI=False)
sortOutExample('inversion/dc_forward.py', needsGMSH=True)


sortOutExample('inversion/test_commemi1.py', needsMPL=True, allowsMPI=True)
sortOutExample('inversion/test_commemi4.py', needsMPL=True, allowsMPI=True)

example_deps.append('inversion/content.txt')
example_deps.append('inversion/data/GravitySmall')
example_deps.append('inversion/data/MagneticSmall')
example_deps.append('inversion/data/QLDWestGravity')
example_deps.append('inversion/data/QLDWestMagnetic')
example_deps.append('inversion/data/GravitySmall.ers')
example_deps.append('inversion/data/MagneticSmall.ers')
example_deps.append('inversion/data/QLDWestGravity.ers')
example_deps.append('inversion/data/QLDWestMagnetic.ers')
example_deps.append('inversion/data/GravitySmall.nc')
example_deps.append('inversion/data/MagneticSmall.nc')
example_deps.append('inversion/data/QLDWestGravity.nc')
example_deps.append('inversion/data/QLDWestMagnetic.nc')
example_deps.append('inversion/data/HalfSphere_v1.4.msh')


if len(skipped_tests)>0:
    env['warnings'].append("gmsh not available. Skipping tests %s!"%' '.join(skipped_tests))

example_files = example_files_allow_mpi + example_files_no_mpi + example_deps

# wave_examples = ['inversion/synthetic_HTI.py',
#     'inversion/synthetic_VTI.py',
#     'inversion/synthetic_TTI.py',
#     'inversion/synthetic_sonic.py',
#     'inversion/synthetic_sonicHTI.py']

wave_examples = []

for i in wave_examples:
    sortOutExample(i)

ex2=[os.path.join("examples", str(x)) for x in example_files]#+wave_examples]

#=============================================================================

local_env = env.Clone()
src_dir = local_env.Dir('.').srcnode().abspath
release_dir=os.path.join(env['prefix'],'release','doc')
Export('release_dir')

dir_cmd = "cd "+src_dir+" && "

# Need to use explicit tar/zip rather than the builder due to problems getting
# it not to put unwanted path components in the archive file
# --transform on tar is not supported on savanna
zip_path=os.path.join(release_dir, 'escript_examples.zip')
zip = local_env.Command(zip_path, None, dir_cmd+"zip "+zip_path+" "+" ".join(ex2))
env.Alias('examples_zipfile', zip)

tar_path=os.path.join(release_dir, 'escript_examples.tar')
targz_path=os.path.join(release_dir, 'escript_examples.tar.gz')
tar = local_env.Command(tar_path, None, dir_cmd+"tar -cf "+tar_path+" "+" ".join(ex2))
targz = local_env.Command(targz_path, tar, "gzip -n -9 "+tar_path)
env.Alias('examples_tarfile', targz)

#env=Environment(TARFLAGS = "-c -z",chdir=src_dir)
#if 'Tar' in dir(env):
# tar=env.Tar(tar_path, example_files, chdir=src_dir)
# env.Alias('examples_tarfile', tar)

local_env.SConscript(dirs = ['#/doc/cookbook'], variant_dir='cookbook', duplicate=1)
local_env.SConscript(dirs = ['#/doc/user'], variant_dir='user', duplicate=1)
local_env.SConscript(dirs = ['#/doc/inversion'], variant_dir='inversion', duplicate=1)
local_env.SConscript(dirs = ['#/doc/epydoc'], variant_dir='epydoc', duplicate=1)
local_env.SConscript(dirs = ['#/doc/sphinx_api'], variant_dir='sphinx_api', duplicate=1)
local_env.SConscript(dirs = ['#/doc/doxygen'], variant_dir='doxygen', duplicate=1)
local_env.SConscript(dirs = ['#/doc/install'], variant_dir='install', duplicate=1)
local_env.SConscript(dirs = ['#/doc/examples'], variant_dir='examples', duplicate=1, exports=['example_files_allow_mpi', 'example_files_no_mpi', 'example_deps'])
1
2	##############################################################################
3	#
4	# Copyright (c) 2003-2018 by The University of Queensland
5	# http://www.uq.edu.au
6	#
7	# Primary Business: Queensland, Australia
8	# Licensed under the Apache License, version 2.0
9	# http://www.apache.org/licenses/LICENSE-2.0
10	#
11	# Development until 2012 by Earth Systems Science Computational Center (ESSCC)
12	# Development 2012-2013 by School of Earth Sciences
13	# Development from 2014 by Centre for Geoscience Computing (GeoComp)
14	#
15	##############################################################################
16
17	import os
18	Import('*')
19
20	from subprocess import PIPE, Popen
21
22	haveMPL=False # do we have matplotlib?
23	haveGD=False # does matplotlib have griddata?
24
25	mplmagicversion='0.98.5'
26
27	# check for matplotlib
28	if env['pythoncmd']=='python':
29	try:
30	import matplotlib
31	haveMPL=True
32	mplversion=matplotlib.__version__
33	from matplotlib.mlab import griddata
34	haveGD=True
35	except ImportError:
36	pass
37	else:
38	# we need to fire up the external command
39	p=Popen([env['pythoncmd'], '-c', 'from __future__ import print_function;import matplotlib;print(matplotlib.__version__);from matplotlib.mlab import griddata;print("1")'], stdout=PIPE)
40	try:
41	mplversion=p.stdout.readline().strip()
42	if mplversion!='':
43	haveMPL=True
44	hgd=p.stdout.readline().strip()
45	haveGD=True
46	except IOError:
47	pass
48	p.wait()
49
50	if not haveMPL:
51	env['warnings'].append("matplotlib not found, will skip some unit tests")
52	else:
53	import sys
54	if sys.version_info[0] == 3:
55	mplversion = str(mplversion, 'utf-8')
56	else:
57	mplversion = str(mplversion)
58	if mplversion<mplmagicversion:
59	env['warnings'].append("matplotlib found, but version too early. Some unit tests will be skipped.")
60
61	example_files_allow_mpi = []
62	example_files_no_mpi = []
63	example_deps = []
64	skipped_tests = []
65
66	def sortOutExample(name, needsGMSH=False, needsMPL=False, needsMagicMPL=False, needsGD=False, allowsMPI=True):
67	if needsMagicMPL: needsMPL=True
68	if needsGD: needsMPL=True
69	if needsGMSH: allowsMPI=False
70
71	if needsGMSH and not env['gmsh']:
72	skipped_tests.append(name)
73	return
74
75	if (not needsGMSH or env['gmsh']) and (not needsMPL or haveMPL) and (not needsMagicMPL or mplversion>=mplmagicversion) and (not needsGD or haveGD):
76	if allowsMPI:
77	example_files_allow_mpi.append(name)
78	else:
79	example_files_no_mpi.append(name)
80	else:
81	example_deps.append(name)
82
83	# these are the release examples in example subdirectory:
84	#
85	#_deps is for files which end in .py and are required for
86	# testing but should not be invoked directly themselves
87
88	sortOutExample('usersguide/lid_driven_cavity.py')
89	sortOutExample('usersguide/mount.py')
90	sortOutExample('usersguide/heatedblock.py')
91	sortOutExample('usersguide/helmholtz.py')
92	sortOutExample('usersguide/fluid.py')
93	sortOutExample('usersguide/poisson.py')
94	sortOutExample('usersguide/diffusion.py')
95	sortOutExample('usersguide/poisson_vtk.py')
96	sortOutExample('usersguide/darcy.py')
97	sortOutExample('usersguide/dirac.py')
98	sortOutExample('usersguide/slip.py')
99	sortOutExample('usersguide/int_save.py')
100	sortOutExample('usersguide/wave.py', needsMPL=True)
101	sortOutExample('usersguide/trapezoid.py', needsGMSH=True, allowsMPI=False)
102	sortOutExample('usersguide/quad.py', needsGMSH=True)
103	sortOutExample('usersguide/brick.py', needsGMSH=True)
104	sortOutExample('usersguide/refine.py', needsGMSH=True)
105	sortOutExample('usersguide/poisson_matplotlib.py', allowsMPI=False, needsGD=True)
106	sortOutExample('usersguide/voxet_reader.py')
107
108	sortOutExample('geotutorial/steadystate_variablek.py')
109	sortOutExample('geotutorial/steadystate.py')
110	sortOutExample('geotutorial/forward_euler.py')
111	sortOutExample('geotutorial/myfirstscript.py')
112	sortOutExample('geotutorial/backward_euler.py')
113
114	example_deps.append('cookbook/cblib.py')
115	sortOutExample('cookbook/example01a.py')
116	sortOutExample('cookbook/example01b.py', needsMPL=True)
117	sortOutExample('cookbook/example01c.py', needsMPL=True, allowsMPI=False)
118	sortOutExample('cookbook/example02.py', needsMPL=True, allowsMPI=False)
119	sortOutExample('cookbook/example03a.py', allowsMPI=False)
120	sortOutExample('cookbook/example03b.py')
121	sortOutExample('cookbook/example04a.py', needsGMSH=True)
122	sortOutExample('cookbook/example04b.py', needsGMSH=True, )
123	sortOutExample('cookbook/example05a.py', needsGMSH=True, )
124	sortOutExample('cookbook/example05b.py', needsGMSH=True)
125	sortOutExample('cookbook/example05c.py', needsGMSH=True, needsMagicMPL=True)
126	sortOutExample('cookbook/example06.py', needsGMSH=True, needsMagicMPL=True)
127	sortOutExample('cookbook/example07a.py', needsMagicMPL=True, allowsMPI=False)
128	sortOutExample('cookbook/example07b.py', needsMagicMPL=True, allowsMPI=False)
129	sortOutExample('cookbook/example08a.py', needsMagicMPL=True, allowsMPI=False)
130	sortOutExample('cookbook/example08b.py', needsMagicMPL=True, allowsMPI=False)
131	sortOutExample('cookbook/example08c.py', needsMagicMPL=True, needsGMSH=True, allowsMPI=False)
132	sortOutExample('cookbook/example09m.py', needsMagicMPL=True, needsGMSH=True, allowsMPI=False)
133	sortOutExample('cookbook/example09a.py', needsMagicMPL=True, needsGMSH=True, allowsMPI=False)
134	#sortOutExample('cookbook/example09b.py', needsMagicMPL=True, needsGMSH=True, allowsMPI=False)
135	sortOutExample('cookbook/example10a.py', needsMagicMPL=True, allowsMPI=False)
136	sortOutExample('cookbook/example10b.py', needsMagicMPL=True, allowsMPI=False)
137	sortOutExample('cookbook/example10m.py', needsMagicMPL=True, needsGMSH=True, allowsMPI=False)
138	#sortOutExample('cookbook/example10c_0.py', needsMagicMPL=True, needsGMSH=True, allowsMPI=False)
139	#sortOutExample('cookbook/example10c_1.py', needsMagicMPL=True, needsGMSH=True, allowsMPI=False)
140	sortOutExample('cookbook/example11a.py', needsMagicMPL=True, allowsMPI=False)
141	sortOutExample('cookbook/example11b.py', needsMagicMPL=True, allowsMPI=False)
142
143	sortOutExample('inversion/create_netcdf.py')
144	sortOutExample('inversion/grav_ermapper.py')
145	sortOutExample('inversion/grav_netcdf.py')
146	sortOutExample('inversion/gravmag_netcdf.py')
147	sortOutExample('inversion/gravmag_nodriver.py')
148	sortOutExample('inversion/mag_netcdf.py')
149	sortOutExample('inversion/plot_ermapper.py', needsMPL=True, allowsMPI=False)
150	sortOutExample('inversion/plot_netcdf.py', needsMPL=True, allowsMPI=False)
151	sortOutExample('inversion/dc_forward.py', needsGMSH=True)
152
153
154	sortOutExample('inversion/test_commemi1.py', needsMPL=True, allowsMPI=True)
155	sortOutExample('inversion/test_commemi4.py', needsMPL=True, allowsMPI=True)
156
157	example_deps.append('inversion/content.txt')
158	example_deps.append('inversion/data/GravitySmall')
159	example_deps.append('inversion/data/MagneticSmall')
160	example_deps.append('inversion/data/QLDWestGravity')
161	example_deps.append('inversion/data/QLDWestMagnetic')
162	example_deps.append('inversion/data/GravitySmall.ers')
163	example_deps.append('inversion/data/MagneticSmall.ers')
164	example_deps.append('inversion/data/QLDWestGravity.ers')
165	example_deps.append('inversion/data/QLDWestMagnetic.ers')
166	example_deps.append('inversion/data/GravitySmall.nc')
167	example_deps.append('inversion/data/MagneticSmall.nc')
168	example_deps.append('inversion/data/QLDWestGravity.nc')
169	example_deps.append('inversion/data/QLDWestMagnetic.nc')
170	example_deps.append('inversion/data/HalfSphere_v1.4.msh')
171
172
173	if len(skipped_tests)>0:
174	env['warnings'].append("gmsh not available. Skipping tests %s!"%' '.join(skipped_tests))
175
176	example_files = example_files_allow_mpi + example_files_no_mpi + example_deps
177
178	# wave_examples = ['inversion/synthetic_HTI.py',
179	# 'inversion/synthetic_VTI.py',
180	# 'inversion/synthetic_TTI.py',
181	# 'inversion/synthetic_sonic.py',
182	# 'inversion/synthetic_sonicHTI.py']
183
184	wave_examples = []
185
186	for i in wave_examples:
187	sortOutExample(i)
188
189	ex2=[os.path.join("examples", str(x)) for x in example_files]#+wave_examples]
190
191	#=============================================================================
192
193	local_env = env.Clone()
194	src_dir = local_env.Dir('.').srcnode().abspath
195	release_dir=os.path.join(env['prefix'],'release','doc')
196	Export('release_dir')
197
198	dir_cmd = "cd "+src_dir+" && "
199
200	# Need to use explicit tar/zip rather than the builder due to problems getting
201	# it not to put unwanted path components in the archive file
202	# --transform on tar is not supported on savanna
203	zip_path=os.path.join(release_dir, 'escript_examples.zip')
204	zip = local_env.Command(zip_path, None, dir_cmd+"zip "+zip_path+" "+" ".join(ex2))
205	env.Alias('examples_zipfile', zip)
206
207	tar_path=os.path.join(release_dir, 'escript_examples.tar')
208	targz_path=os.path.join(release_dir, 'escript_examples.tar.gz')
209	tar = local_env.Command(tar_path, None, dir_cmd+"tar -cf "+tar_path+" "+" ".join(ex2))
210	targz = local_env.Command(targz_path, tar, "gzip -n -9 "+tar_path)
211	env.Alias('examples_tarfile', targz)
212
213	#env=Environment(TARFLAGS = "-c -z",chdir=src_dir)
214	#if 'Tar' in dir(env):
215	# tar=env.Tar(tar_path, example_files, chdir=src_dir)
216	# env.Alias('examples_tarfile', tar)
217
218	local_env.SConscript(dirs = ['#/doc/cookbook'], variant_dir='cookbook', duplicate=1)
219	local_env.SConscript(dirs = ['#/doc/user'], variant_dir='user', duplicate=1)
220	local_env.SConscript(dirs = ['#/doc/inversion'], variant_dir='inversion', duplicate=1)
221	local_env.SConscript(dirs = ['#/doc/epydoc'], variant_dir='epydoc', duplicate=1)
222	local_env.SConscript(dirs = ['#/doc/sphinx_api'], variant_dir='sphinx_api', duplicate=1)
223	local_env.SConscript(dirs = ['#/doc/doxygen'], variant_dir='doxygen', duplicate=1)
224	local_env.SConscript(dirs = ['#/doc/install'], variant_dir='install', duplicate=1)
225	local_env.SConscript(dirs = ['#/doc/examples'], variant_dir='examples', duplicate=1, exports=['example_files_allow_mpi', 'example_files_no_mpi', 'example_deps'])