matlab.py

Go to the documentation of this file.

#  This file is part of repro, a Python package for automating 
#  reproducible research in scientific computing.
#
#  Copyright (C) 2008  Gilles Hennenfent, Sean Ross-Ross
#
#  This program is free software: you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with this program.  If not, see <http://www.gnu.org/licenses/>.

##
# 
# @package matlab
# Provide one builder, Matlab, to call Matlab in a convenient manner.
# 
# @page pg_procblds Process data
# 
# @section sec_matlabbld Matlab
# 
# Defined in the matlab tool. Builder to call Matlab in a convenient manner.
# 
# \verbinclude examples/Matlab/SparseLabPaper/src/SConstruct
# 

from os.path import isfile, join,abspath
from repro.functions.RushFunctions import sfbin_method
from SCons.Tool import Tool

import re

##
# 
#     @brief Generate command to run Matlab.
#     
def matlab_gen( source, target, env, for_signature ):
    
    matfuncs = env['matfuncs']
    
    paths = env.Split( env.get('matpath',[]) )
    
    if isinstance(matfuncs, str):
        matfuncs = matfuncs.split(';')
        
    if paths:
        env['MATPATH'] = "addpath('%s');" %("','".join(paths))
    env['MATFUNCS'] = ";".join( matfuncs )
    
    if env.get('DATAPATH'):
        env['ENV']['DATAPATH'] = env['DATAPATH']

    MATLABSTR = '$MATLAB $MATLABOPTS -r "$MATPATH$MATFUNCS; quit"'
    
    return MATLABSTR
    

##
# 
#     @brief Add m-files as dependencies.
#     
def matlab_emitter( target, source, env ):
    
    re_mat_func = re.compile("^(.*)\(.*\)$")
    
    matfuncs = env['matfuncs']
    
    paths = env.Split( env.get('matpath',[]) )
    paths.append('.')    
    env['MATPATH'] = "addpath('%s');" %("','".join([abspath(p) for p in paths]))
    
    if isinstance(matfuncs, str):
        matfuncs = matfuncs.split(';')
       
    for func in matfuncs:
        funcs = re_mat_func.findall(func)
        if not funcs:
            continue
        func = funcs[0]
        for path in ['.'] + paths:
            mfile = join(path,"%(func)s.m" %vars())
            if isfile( mfile ):
                source.append(mfile)
    
    env['MATFUNCS'] = ";".join( matfuncs )
    
    sfbin_method( env, target )
    
    return target, source
    
##
# 
#     @brief Add Matlab builder to the environment.
#     
def generate(env):
    
    env['MATLAB']     = 'matlab'
    env['MATLABOPTS'] = '-nojvm -nosplash'
        
    mb = env.Builder( generator=matlab_gen,
                      emitter=matlab_emitter,
                      suffix='.mat',
                      src_suffix='.mat' 
                      )
    
    env['BUILDERS']['Matlab'] = mb

##
# 
#     @brief Check whether Matlab is properly installed and configured or not.
#     
def exists( env ):
    return env.Detect('matlab')

---