wscript 10.4 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
Federico Allocati's avatar
Federico Allocati committed
61
import inspect
62
from waflib.Build import BuildContext
63

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

Vaios Papaspyros's avatar
Vaios Papaspyros committed
77
        opt.add_option('--create', type='string', help='create a new exp', dest='create_exp')
78
        limbo.add_create_options(opt)
79
        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
80
81
        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')
82
        opt.add_option('--local', type='string', help='config file (json) to run local', dest='local')
83
        opt.add_option('--local_serial', type='string', help='config file (json) to run local', dest='local_serial')
84
        opt.add_option('--experimental', action='store_true', help='specify to compile the experimental examples', dest='experimental')
85
        opt.add_option('--nb_replicates', type='int', help='number of replicates performed during the benchmark', dest='nb_rep')
86
        opt.add_option('--tests', action='store_true', help='compile tests or not', dest='tests')
87
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
        for i in glob.glob('exp/*'):
Federico Allocati's avatar
Federico Allocati committed
90
91
                if os.path.isdir(i):
                    opt.recurse(i)
92

93
        opt.recurse('src/benchmarks')
94

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

107
108
        if conf.env.CXX_NAME in ["icc", "icpc"]:
            common_flags = "-Wall -std=c++11"
109
            opt_flags = " -O3 -xHost -mtune=native -unroll -fma -g"
110
        else:
111
            if conf.env.CXX_NAME in ["gcc", "g++"] and int(conf.env['CC_VERSION'][0]+conf.env['CC_VERSION'][1]) < 47:
112
113
114
                common_flags = "-Wall -std=c++0x"
            else:
                common_flags = "-Wall -std=c++11"
115
116
            if conf.env.CXX_NAME in ["clang", "llvm"]:
                common_flags += " -fdiagnostics-color"
117
            opt_flags = " -O3 -g"
118

119
        conf.check_boost(lib='serialization filesystem \
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
120
            system unit_test_framework program_options \
121
            thread', min_version='1.39')
122
123
        conf.check_eigen()
        conf.check_tbb()
124
        conf.check_sferes()
125
126
        conf.check_openmp()
        conf.check_mkl()
127
        conf.check_nlopt()
128
        conf.check_libcmaes()
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
129

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

132
133
        all_flags = common_flags + opt_flags
        conf.env['CXXFLAGS'] = conf.env['CXXFLAGS'] + all_flags.split(' ')
134
        print 'CXXFLAGS:', conf.env['CXXFLAGS']
135

Jean-Baptiste Mouret's avatar
misc    
Jean-Baptiste Mouret committed
136
137
138
139
        if conf.options.exp:
                for i in conf.options.exp.split(','):
                        print 'configuring for exp: ' + i
                        conf.recurse('exp/' + i)
140
        conf.recurse('src/benchmarks')
141
142
143
144
145
        print ''
        print 'WHAT TO DO NOW?'
        print '---------------'
        print '[users] To compile Limbo (inc. unit tests): ./waf build'
        print '[users] Read the documentation (inc. tutorials) on http://www.resibots.eu/limbo'
146
147
148
        print '[developers] To compile the HTML documentation (this requires sphinx and the resibots theme): ./waf doc'
        print '[developers] To compile the benchmarks: ./waf build_benchmarks'
        print '[developers] To compile the extensive tests: ./waf build_extensive_tests'
149

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

151
def build(bld):
152
153
154
    if bld.options.write_params:
        limbo.write_default_params(bld.options.write_params)
        print 'default parameters written in ' + bld.options.write_params
155
156
157
158
159
    bld.recurse('src/')
    if bld.options.exp:
        for i in bld.options.exp.split(','):
            print 'Building exp: ' + i
            bld.recurse('exp/' + i)
160
            limbo.output_params('exp/'+i)
161
    bld.add_post_fun(limbo.summary)
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
162

163
def build_extensive_tests(ctx):
164
    ctx.recurse('src/')
165
166
    ctx.recurse('src/tests')

167
168
169
def build_benchmark(ctx):
    ctx.recurse('src/benchmarks')

170
171
172
173
174
175
176
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)
            print "Running: " + fname
            s = "cd " + fpath + "; ./" + fname
            retcode = subprocess.call(s, shell=True, env=None)
177

178
179
180
181
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)
182
            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
183
184
185
            retcode = subprocess.call(s, shell=True, env=None)
            print "oarsub returned:" + str(retcode)

186
def run_benchmark(ctx):
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
    HEADER='\033[95m'
    NC='\033[0m'
    res_dir=os.getcwd()+"/benchmark_results/"
    try:
        os.makedirs(res_dir)
    except:
        print "WARNING, dir:" + res_dir + " not be created"
    for fullname in glob.glob('build/src/benchmarks/*'):
        if os.path.isfile(fullname) and os.access(fullname, os.X_OK):
            fpath, fname = os.path.split(fullname)
            directory = res_dir + "/" + fname
            try:
                os.makedirs(directory)
            except:
                print "WARNING, dir:" + directory + " not be created, the new results will be concatenated to the old ones"
            s = "cp " + fullname + " " + directory
            retcode = subprocess.call(s, shell=True, env=None)
            if ctx.options.nb_rep:
                nb_rep = ctx.options.nb_rep
            else:
                nb_rep = 10
            for i in range(0,nb_rep):
                print HEADER+" Running: " + fname + " for the "+str(i)+"th time"+NC
                s="cd " + directory +";./" + fname
                retcode = subprocess.call(s, shell=True, env=None)
212

213
def shutdown(ctx):
Vaios Papaspyros's avatar
Vaios Papaspyros committed
214
    if ctx.options.create_exp:
215
        limbo.create_exp(ctx.options.create_exp, ctx.options)
216
217
    if ctx.options.qsub:
        limbo.qsub(ctx.options.qsub)
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
218
219
    if ctx.options.oar:
        limbo.oar(ctx.options.oar)
220
    if ctx.options.local:
221
222
223
        limbo.run_local(ctx.options.local, False)
    if ctx.options.local_serial:
        limbo.run_local(ctx.options.local_serial)
224

225
226
227
def insert_license(ctx):
    limbo.insert_license()

228
229
def write_default_params(ctx):
    print('extracting default params to docs/defaults.rst')
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
230
    limbo.write_default_params('docs/defaults.rst')
231
232
233
234

#print("to install sphinx-versioning: sudo pip3 install git+https://github.com/resibots/sphinxcontrib-versioning.git@resibots")

def build_docs(ctx): 
235
    print("generating HTML doc with versioning...")
236
237
    s = 'sphinx-versioning -v build -p docs/pre_script.sh --whitelist-branches "(master|doc_versioning|release-*)" docs docs/_build/html'
    print(s)
238
239
    retcode = subprocess.call(s, shell=True, env=None)

240
241
242
class BuildExtensiveTestsContext(BuildContext):
    cmd = 'build_extensive_tests'
    fun = 'build_extensive_tests'
243
244
245
246

class BuildBenchmark(BuildContext):
    cmd = 'build_benchmark'
    fun = 'build_benchmark'
247

248
249
250
class InsertLicense(BuildContext):
    cmd = 'insert_license'
    fun = 'insert_license'
Jean-Baptiste Mouret's avatar
Jean-Baptiste Mouret committed
251

252
253
254
class BuildDoc(BuildContext):
    cmd = 'docs'
    fun = 'build_docs'
255
256
257
258

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