annotate trunk/carfac/SConstruct @ 673:afb42b8ea499

Scons cleanup to make it easier only run tests, expand docs.
author ronw@google.com
date Thu, 23 May 2013 19:29:00 +0000
parents a9694d0bb55a
children 7f424c1a8b78
rev   line source
ronw@666 1 # CARFAC Open Source C++ Library
ronw@666 2 #
ronw@666 3 # This C++ file is part of an implementation of Lyon's cochlear model:
ronw@666 4 # "Cascade of Asymmetric Resonators with Fast-Acting Compression"
ronw@666 5 # to supplement Lyon's upcoming book "Human and Machine Hearing"
ronw@666 6 #
ronw@666 7 # Licensed under the Apache License, Version 2.0 (the "License");
ronw@666 8 # you may not use this file except in compliance with the License.
ronw@666 9 # You may obtain a copy of the License at
ronw@666 10 #
ronw@666 11 # http://www.apache.org/licenses/LICENSE-2.0
ronw@666 12 #
ronw@666 13 # Unless required by applicable law or agreed to in writing, software
ronw@666 14 # distributed under the License is distributed on an "AS IS" BASIS,
ronw@666 15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ronw@666 16 # See the License for the specific language governing permissions and
ronw@666 17 # limitations under the License.
ronw@666 18
ronw@666 19 ## @author Ron Weiss <ronw@google.com>
ronw@666 20 # @date created 2013/05/21
ronw@666 21 # @version \$Id$
ronw@666 22
ronw@666 23 """@package SConstruct
ronw@666 24 SConstruct file for the CARFAC Open Source C++ Library.
ronw@666 25
ronw@673 26 To install dependencies on Ubuntu, run:
ronw@666 27
ronw@673 28 sudo apt-get install libeigen3-dev scons \
ronw@673 29 cmake libgtest-dev libsndfile-dev # For testing.
ronw@673 30 export EIGEN_PATH=/usr/include/eigen3
ronw@673 31 export GTEST_SOURCE=/usr/src/gtest
ronw@673 32
ronw@673 33 To build all libraries, run:
ronw@666 34 scons
ronw@673 35
ronw@673 36 To run unit tests, run:
ronw@673 37 scons test
ronw@673 38
ronw@673 39 To clean up binaries, run:
ronw@673 40 scons --clean
ronw@666 41 """
ronw@666 42
ronw@666 43 import os
ronw@666 44
ronw@666 45 carfac_sources = [
ronw@672 46 'agc_coeffs.cc',
ronw@666 47 'agc_params.cc',
ronw@672 48 'car_coeffs.cc',
ronw@666 49 'carfac.cc',
ronw@666 50 'carfac_common.cc',
ronw@666 51 'carfac_output.cc',
ronw@666 52 'car_params.cc',
ronw@666 53 'ear.cc',
ronw@666 54 'ear_output.cc',
ronw@672 55 'ihc_coeffs.cc',
ronw@666 56 'ihc_params.cc',
ronw@666 57 ]
ronw@666 58
ronw@666 59 env = Environment(CPPPATH=[os.environ['EIGEN_PATH']])
ronw@666 60 # Needed to support std::vector initialization lists.
ronw@666 61 env.MergeFlags(['-std=c++0x'])
ronw@666 62 env.Library(target = 'carfac', source = carfac_sources)
ronw@667 63
ronw@667 64 env.Command('tmp/libgtest.a', [],
ronw@667 65 [
ronw@667 66 Delete('tmp'),
ronw@667 67 Copy('tmp', os.environ['GTEST_SOURCE']),
ronw@667 68 'cd tmp && cmake . && make',
ronw@667 69 ])
ronw@667 70
ronw@673 71 test_program = env.Program(target = 'carfac_test',
ronw@673 72 source = ['carfac_test.cc'],
ronw@673 73 LIBS = ['carfac', 'gtest', 'gtest_main', 'pthread'],
ronw@673 74 LIBPATH = ['.', 'tmp'])
ronw@673 75 test_alias = Alias('test', [test_program], test_program[0].abspath)
ronw@673 76 AlwaysBuild(test_alias)