rush.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 rush
# Provide two builders, Rush and GetPar, to process data using 
# RSF/Madagascar command line programs.
# 
# @page pg_procblds Process data
# 
# @section sec_rushbld Rush
# 
# Defined in the rush tool. Builder to process data using 
# RSF/Madagascar command line programs.
# 
# @section sec_getparbld GetPar
# 
# Defined in the rush tool. Builder to process data using 
# RSF/Madagascar command line programs.
# 
from os import environ
from os.path import join
from repro.functions.GetParBuilder import get_par_act
from repro.functions.GetParBuilder import get_par_emitter
from repro.functions.GetParBuilder import get_par_method
from repro.functions.RushFunctions import RUSH_EMITTER
from repro.functions.RushFunctions import flow_join
from repro.functions.RushFunctions import gen_suffix
from repro.functions.RushFunctions import rsf_emitter
from repro.functions.RushFunctions import rsf_program_prefix
from repro.functions.RushFunctions import rush_gen
from repro.functions.RushFunctions import rush_method
from repro.functions.RushFunctions import sfbin_method


RUSH_EMITTERS = {'.rsf':rsf_emitter}

STDIN = "${stdin and SOURCES and '< ' + SOURCES[0].path or ''}"
STDOUT = "${stdout and TARGETS and '> ' + TARGETS[0].path or ''}"
stdin = True
stdout = True

REPROEXPORTS= ['RSFROOT','DATAPATH','TMPDATAPATH','RSFDOC','RSFFIGS']

CMDLIST = "${flow_join(_flow_command)}"
RUSHSTR = "$STDIN $CMDLIST $STDOUT"

SF = {}

##
# 
#     @brief Add Rush builder to the environment and do many other things...
#     
def generate(env):
    
    REPROROOT = environ.get('REPROROOT')
    if REPROROOT:
        
        REPROBIN = join( REPROROOT,"bin" )
        REPROLIB = join( REPROROOT,"lib" )
        
        env.PrependENVPath( 'PYTHONPATH', REPROLIB )
        env.PrependENVPath( 'PATH', REPROBIN )
        
    else:
        REPROBIN = None
        REPROLIB = None
    
    env.AppendENVPath( 'PATH', environ['PATH'] )
    env['REPROROOT'] = REPROROOT
    env['REPROBIN'] = REPROBIN
    env['REPROLIB'] = REPROLIB
    
    RSFROOT = environ.get('RSFROOT')
    if RSFROOT:
        RSFBIN = join( RSFROOT,"bin" )
        RSFLIB = join( RSFROOT,"lib" )
        env.PrependENVPath( 'PYTHONPATH', RSFLIB )
        env.PrependENVPath( 'PATH', RSFBIN )
    else:
        RSFBIN = None
        RSFLIB = None
    
    env.Append( REPROEXPORTS= REPROEXPORTS )
    
    env.AppendENVPath( 'PATH', environ['PATH'] )
    
    env['RSFROOT'] = RSFROOT
    env['RSFBIN'] = RSFBIN
    env['RSFLIB'] = RSFLIB
    env['DATAPATH'] = environ.get('DATAPATH','.')
    
    env['GETPAR'] = {'.rsf': "sfget parform=n $par < $SOURCE" }
    GetParBuilder = env.Builder( action={'.rsf':get_par_act},
                              emitter={'.rsf':get_par_emitter},
                              varlist=['GETPAR'],
                              single_source=1,
                            )

    env['RUSH_EMITTERS'] = RUSH_EMITTERS
    env['stdin'] = stdin
    env['STDIN'] = STDIN
    env['stdout'] = stdout
    env['STDOUT'] = STDOUT
    
    env['flow_join'] = flow_join
    
    env['CMDLIST'] = CMDLIST
    env['RUSHSTR'] = RUSHSTR
     
    rush_bldr = env.Builder( generator=rush_gen,
                      emitter=RUSH_EMITTER,
                      suffix=gen_suffix,
#                      chdir=1,
            )
    
    env['BUILDERS']['_Rush'] = rush_bldr
    env["BUILDERS"]['_GetPar'] = GetParBuilder
    
    env.AddMethod( sfbin_method,'sfbin')
    
    
    env.AddMethod( rush_method, 'Rush')
    env.AddMethod( get_par_method,'GetPar')
    
    env['SF'] = SF
    env['SF']['.rsf'] = rsf_program_prefix
     
##
# 
#     @brief Return True (this tool always exists).
#     
def exists(env):
    return 1

---