SCons: Difference between revisions
Line 1: | Line 1: | ||
[http://www.scons.org/ SCons] (from '''S'''oftware '''Cons'''truction) is a superior alternative to the classic '''make''' utility. | [http://www.scons.org/ SCons] (from '''S'''oftware '''Cons'''truction) is a superior alternative to the classic '''make''' utility. | ||
Line 6: | Line 4: | ||
* [http://www.scons.org/documentation.php SCons documentation] | * [http://www.scons.org/documentation.php SCons documentation] | ||
=== Useful SCons options === | |||
'''scons -h''' (help) displays a help message. | |||
'''scons -Q''' (quiet) suppresses progress messages. | |||
'''scons -n''' (no exec) outputs the commands required for building the specified target (or the default targets if no target is specified) without actually executing them. It can be used to generate a shell script out of <tt>SConstruct</tt> script, as follows: | |||
<bash> | |||
scons -nQ [target] > script.sh | |||
</bash> | |||
== Compilation == | == Compilation == |
Revision as of 23:13, 2 August 2010
SCons (from Software Construction) is a superior alternative to the classic make utility.
SCons is implemented as a Python script, its "configuration files" (SConstruct files) are also Python scripts. Madagascar uses SCons to compile software, to manage data processing flowing, and to assemble reproducible documents.
Useful SCons options
scons -h (help) displays a help message.
scons -Q (quiet) suppresses progress messages.
scons -n (no exec) outputs the commands required for building the specified target (or the default targets if no target is specified) without actually executing them. It can be used to generate a shell script out of SConstruct script, as follows: <bash> scons -nQ [target] > script.sh </bash>
Compilation
Data processing flows with rsf.proj
The rsf.proj module provides SCons rules for Madagascar data processing workflows. An example SConstruct file is shown below and can be found in bei/sg/denmark <python> from rsf.proj import *
Fetch('wz.35.H','wz')
Flow('wind','wz.35.H','dd form=native | window n1=400 j1=2 | smooth rect1=3') Plot('wind','pow pow1=2 | grey')
Flow('mute','wind','mutter v0=0.31 half=n') Plot('mute','pow pow1=2 | grey')
Result('denmark','wind mute','SideBySideAniso')
End() </python> Note that SConstruct by itself does not do any job other than setting rules for building different targets. The targets get built when one executes scons on the command line.
SCons commands
Fetch
Flow
Plot
Result
End
Default targets
Command-line options
Command-line options | |
---|---|
Name | Meaning |
TIMER | Whether to time execution |
CHECKPAR | Whether to check parameters |
ENVIRON | Additional environment settings |
CLUSTER | Nodes available on a cluster |
MPIRUN | mpirun command |