wscript 10.7 KB
Newer Older
1
2
#!/usr/bin/env python
# encoding: utf-8
3
4
5
6
#| Copyright Inria May 2015
#| This project has received funding from the European Research Council (ERC) under
#| the European Union's Horizon 2020 research and innovation programme (grant
#| agreement No 637972) - see http://www.resibots.eu
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
7
#|
8
9
10
11
12
13
#| Contributor(s):
#|   - Jean-Baptiste Mouret (jean-baptiste.mouret@inria.fr)
#|   - Antoine Cully (antoinecully@gmail.com)
#|   - Kontantinos Chatzilygeroudis (konstantinos.chatzilygeroudis@inria.fr)
#|   - Federico Allocati (fede.allocati@gmail.com)
#|   - Vaios Papaspyros (b.papaspyros@gmail.com)
Konstantinos Chatzilygeroudis's avatar
Konstantinos Chatzilygeroudis committed
14
#|   - Roberto Rama (bertoski@gmail.com)
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
15
#|
16
17
18
19
20
#| This software is a computer library whose purpose is to optimize continuous,
#| black-box functions. It mainly implements Gaussian processes and Bayesian
#| optimization.
#| Main repository: http://github.com/resibots/limbo
#| Documentation: http://www.resibots.eu/limbo
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
21
#|
22
23
24
25
26
#| This software is governed by the CeCILL-C license under French law and
#| abiding by the rules of distribution of free software.  You can  use,
#| modify and/ or redistribute the software under the terms of the CeCILL-C
#| license as circulated by CEA, CNRS and INRIA at the following URL
#| "http://www.cecill.info".
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
27
#|
28
29
30
31
32
#| As a counterpart to the access to the source code and  rights to copy,
#| modify and redistribute granted by the license, users are provided only
#| with a limited warranty  and the software's author,  the holder of the
#| economic rights,  and the successive licensors  have only  limited
#| liability.
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
33
#|
34
35
36
37
38
39
40
41
42
43
#| In this respect, the user's attention is drawn to the risks associated
#| with loading,  using,  modifying and/or developing or reproducing the
#| software by the user in light of its specific status of free software,
#| that may mean  that it is complicated to manipulate,  and  that  also
#| therefore means  that it is reserved for developers  and  experienced
#| professionals having in-depth computer knowledge. Users are therefore
#| encouraged to load and test the software's suitability as regards their
#| requirements in conditions enabling the security of their systems and/or
#| data to be ensured and,  more generally, to use and operate it in the
#| same conditions as regards security.
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
44
#|
45
46
#| The fact that you are presently reading this means that you have had
#| knowledge of the CeCILL-C license and that you accept its terms.
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
47
#|
48
49
import sys
sys.path.insert(0, './waf_tools')
50

51
52
VERSION = '0.0.1'
APPNAME = 'limbo'
53
54
55
56

srcdir = '.'
blddir = 'build'

57
import glob
58
59
import os
import subprocess
60
import limbo, benchmarks
Federico Allocati's avatar
Federico Allocati committed
61
import inspect
62
from waflib import Logs
63
from waflib.Build import BuildContext
64

65
66
67
68
69
def options(opt):
        opt.load('compiler_cxx boost waf_unit_test')
        opt.load('compiler_c')
        opt.load('eigen')
        opt.load('tbb')
70
        opt.load('mkl')
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
71
        opt.load('sferes')
72
        opt.load('limbo')
73
        opt.load('openmp')
74
        opt.load('nlopt')
75
        opt.load('libcmaes')
76
        opt.load('xcode')
77

Vaios Papaspyros's avatar
Vaios Papaspyros committed
78
        opt.add_option('--create', type='string', help='create a new exp', dest='create_exp')
79
        limbo.add_create_options(opt)
80
        opt.add_option('--exp', type='string', help='exp(s) to build, separate by comma', dest='exp')
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
81
82
        opt.add_option('--qsub', type='string', help='config file (json) to submit to torque', dest='qsub')
        opt.add_option('--oar', type='string', help='config file (json) to submit to oar', dest='oar')
83
        opt.add_option('--local', type='string', help='config file (json) to run local', dest='local')
84
        opt.add_option('--local_serial', type='string', help='config file (json) to run local', dest='local_serial')
85
        opt.add_option('--experimental', action='store_true', help='specify to compile the experimental examples', dest='experimental')
86
        opt.add_option('--nb_replicates', type='int', help='number of replicates performed during the benchmark', dest='nb_rep')
87
        opt.add_option('--tests', action='store_true', help='compile tests or not', dest='tests')
88
        opt.add_option('--write_params', type='string', help='write all the default values of parameters in a file (used by the documentation system)', dest='write_params')
89
        opt.add_option('--regression_benchmarks', type='string', help='config file (json) to compile benchmark for regression', dest='regression_benchmarks')
90

91
        for i in glob.glob('exp/*'):
Federico Allocati's avatar
Federico Allocati committed
92
93
                if os.path.isdir(i):
                    opt.recurse(i)
94

95
        opt.recurse('src/benchmarks')
96

97
def configure(conf):
98
        conf.load('compiler_cxx boost waf_unit_test')
99
100
101
        conf.load('compiler_c')
        conf.load('eigen')
        conf.load('tbb')
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
102
        conf.load('sferes')
103
        conf.load('openmp')
104
        conf.load('mkl')
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
105
        conf.load('xcode')
106
        conf.load('nlopt')
107
        conf.load('libcmaes')
108

Konstantinos Chatzilygeroudis's avatar
Konstantinos Chatzilygeroudis committed
109
        native_flags = "-march=native"
110
111
        if conf.env.CXX_NAME in ["icc", "icpc"]:
            common_flags = "-Wall -std=c++11"
112
113
            opt_flags = " -O3 -xHost -g"
            native_flags = "-mtune=native -unroll -fma"
114
        else:
115
            if conf.env.CXX_NAME in ["gcc", "g++"] and int(conf.env['CC_VERSION'][0]+conf.env['CC_VERSION'][1]) < 47:
116
117
118
                common_flags = "-Wall -std=c++0x"
            else:
                common_flags = "-Wall -std=c++11"
119
120
            if conf.env.CXX_NAME in ["clang", "llvm"]:
                common_flags += " -fdiagnostics-color"
121
122
123
124
125
126
127
            opt_flags = " -O3 -g"

        native = conf.check_cxx(cxxflags=native_flags, mandatory=False, msg='Checking for compiler flags \"'+native_flags+'\"')
        if native:
            opt_flags = opt_flags + ' ' + native_flags
        else:
            Logs.pprint('YELLOW', 'WARNING: Native flags not supported. The performance might be a bit deteriorated.')
128

129
        conf.check_boost(lib='serialization filesystem \
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
130
            system unit_test_framework program_options \
131
            thread', min_version='1.39')
132
133
        conf.check_eigen()
        conf.check_tbb()
134
        conf.check_sferes()
135
136
        conf.check_openmp()
        conf.check_mkl()
137
        conf.check_nlopt()
138
        conf.check_libcmaes()
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
139

Federico Allocati's avatar
Federico Allocati committed
140
141
        conf.env.INCLUDES_LIMBO = os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe()))) + "/src"

142
143
        all_flags = common_flags + opt_flags
        conf.env['CXXFLAGS'] = conf.env['CXXFLAGS'] + all_flags.split(' ')
144
        Logs.pprint('NORMAL', 'CXXFLAGS: %s' % conf.env['CXXFLAGS'])
145

Jean-Baptiste Mouret's avatar
misc    
Jean-Baptiste Mouret committed
146
147
        if conf.options.exp:
                for i in conf.options.exp.split(','):
148
                        Logs.pprint('NORMAL', 'configuring for exp: %s' % i)
Jean-Baptiste Mouret's avatar
misc    
Jean-Baptiste Mouret committed
149
                        conf.recurse('exp/' + i)
150
        conf.recurse('src/benchmarks')
151
152
153
154
155
156
157
        Logs.pprint('NORMAL', '')
        Logs.pprint('NORMAL', 'WHAT TO DO NOW?')
        Logs.pprint('NORMAL', '---------------')
        Logs.pprint('NORMAL', '[users] To compile Limbo: ./waf build')
        Logs.pprint('NORMAL', '[users] To compile and run unit tests: ./waf --tests')
        Logs.pprint('NORMAL', '[users] Read the documentation (inc. tutorials) on http://www.resibots.eu/limbo')
        Logs.pprint('NORMAL', '[developers] To compile the HTML documentation (this requires sphinx and the resibots theme): ./waf docs')
158
159
160
        Logs.pprint('NORMAL', '[developers] To compile the BO benchmarks: ./waf build_bo_benchmarks')
        Logs.pprint('NORMAL', '[developers] To run the BO benchmarks: ./waf run_bo_benchmarks')
        Logs.pprint('NORMAL', '[developers] To compile the regression benchmarks (requires a json file with the setup): ./waf --regression_benchmarks file.json')
161
        Logs.pprint('NORMAL', '[developers] To run the regression benchmarks: ./waf run_regression_benchmarks --regression_benchmarks file.json')
162
        Logs.pprint('NORMAL', '[developers] To compile the extensive tests: ./waf build_extensive_tests')
163

Jean-Baptiste Mouret's avatar
misc    
Jean-Baptiste Mouret committed
164

165
def build(bld):
166
167
    if bld.options.write_params:
        limbo.write_default_params(bld.options.write_params)
168
        Logs.pprint('NORMAL', 'default parameters written in %s' % bld.options.write_params)
169
170
171
    bld.recurse('src/')
    if bld.options.exp:
        for i in bld.options.exp.split(','):
172
            Logs.pprint('NORMAL', 'Building exp: %s' % i)
173
            bld.recurse('exp/' + i)
174
            limbo.output_params('exp/'+i)
175
    if bld.options.regression_benchmarks:
176
        benchmarks.compile_regression_benchmarks(bld, bld.options.regression_benchmarks)
177
    bld.add_post_fun(limbo.summary)
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
178

179
def build_extensive_tests(ctx):
180
    ctx.recurse('src/')
181
182
    ctx.recurse('src/tests')

183
def build_bo_benchmarks(ctx):
184
185
    ctx.recurse('src/benchmarks')

186
187
188
189
def run_extensive_tests(ctx):
    for fullname in glob.glob('build/src/tests/combinations/*'):
        if os.path.isfile(fullname) and os.access(fullname, os.X_OK):
            fpath, fname = os.path.split(fullname)
190
            Logs.pprint('NORMAL', 'Running: %s' % fname)
191
192
            s = "cd " + fpath + "; ./" + fname
            retcode = subprocess.call(s, shell=True, env=None)
193

194
195
196
197
def submit_extensive_tests(ctx):
    for fullname in glob.glob('build/src/tests/combinations/*'):
        if os.path.isfile(fullname) and os.access(fullname, os.X_OK):
            fpath, fname = os.path.split(fullname)
198
            s = "cd " + fpath + ";oarsub -l /nodes=1/core=2,walltime=00:15:00 -n " + fname + " -O " + fname + ".stdout.%jobid%.log -E " + fname + ".stderr.%jobid%.log ./" + fname
199
            retcode = subprocess.call(s, shell=True, env=None)
200
            Logs.pprint('NORMAL', 'oarsub returned: %s' % str(retcode))
201

202
def run_bo_benchmarks(ctx):
203
    benchmarks.run_bo_benchmarks(ctx)
204

205
def run_regression_benchmarks(ctx):
206
    benchmarks.run_regression_benchmarks(ctx)
207

208
def shutdown(ctx):
Vaios Papaspyros's avatar
Vaios Papaspyros committed
209
    if ctx.options.create_exp:
210
        limbo.create_exp(ctx.options.create_exp, ctx.options)
211
212
    if ctx.options.qsub:
        limbo.qsub(ctx.options.qsub)
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
213
214
    if ctx.options.oar:
        limbo.oar(ctx.options.oar)
215
    if ctx.options.local:
216
217
218
        limbo.run_local(ctx.options.local, False)
    if ctx.options.local_serial:
        limbo.run_local(ctx.options.local_serial)
219

220
221
222
def insert_license(ctx):
    limbo.insert_license()

223
def write_default_params(ctx):
224
    Logs.pprint('NORMAL', 'extracting default params to docs/defaults.rst')
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
225
    limbo.write_default_params('docs/defaults.rst')
226

227
def build_docs(ctx):
228
    Logs.pprint('NORMAL', "generating HTML doc with versioning...")
229
    s = 'sphinx-versioning -v build -f docs/pre_script.sh --whitelist-branches "(master|release-*)" docs docs/_build/html'
230
231
    retcode = subprocess.call(s, shell=True, env=None)

232
233
234
class BuildExtensiveTestsContext(BuildContext):
    cmd = 'build_extensive_tests'
    fun = 'build_extensive_tests'
235
236

class BuildBenchmark(BuildContext):
237
238
    cmd = 'build_bo_benchmarks'
    fun = 'build_bo_benchmarks'
239

240
241
242
class InsertLicense(BuildContext):
    cmd = 'insert_license'
    fun = 'insert_license'
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
243

244
245
246
class BuildDoc(BuildContext):
    cmd = 'docs'
    fun = 'build_docs'
247
248
249

class BuildDoc(BuildContext):
    cmd = 'default_params'
250
    fun = 'write_default_params'