Editing
Package overview
(section)
Jump to navigation
Jump to search
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
===Reproducibility and Project Management=== Madagascar uses and extends [http://www.scons.org/ SCons], an open-source software construction package to document and maintain data processing flows. Documented projects become computational recipes that can be easily exchanged among Madagascar users. SCons is a rule-based package in Python typically used as a build system analogous to <tt>make</tt>. Familiarity with any build system will help understand SCons. SCons statements, as Python statements, are invoked in the sequence in which they are written, but as such, they only define rules. The rules are invoked by a dependency graph, which SCons builds based on those rules. Components regarded as "up-to-date" are not rebuilt. SCons allows for user-contributed Builders (meta-rule categories), and Madagascar uses this capability extensively. The idea is that building an output file based on a workflow chain is analogous to building a software package based on a software toolchain. The calculation is seen simply as a build with dependencies. This setup greatly benefits developing alternative workflows using a given dataset. The system maintains an awareness of already completed calculations. Without user intervention, redundant calculations are avoided. Madagascar calculations are thus expressed as SCons scripts (<tt>SConstruct</tt> files). SCons extensions follow SCons conventions, beginning with an uppercase letter. The most common Madagascar extensions are <tt>Flow()</tt>, <tt>Result()</tt>, and <tt>End()</tt>. A <tt>Flow()</tt> invocation wraps Madagascar computational components. <tt>Result()</tt> is a version of <tt>Flow()</tt> with a graphical output. Finally an End() invokes the default rules for multiple results. Finally, Madagascar enables a collection of reproducible documents to be organized into living books. Each reproducible book contains a collection of Madagascar recipes (<tt>SConstruct</tt> files) used to generate book figures. The recipes cover a variety of data processing and imaging tasks described in the books. Figures and recipes serve a dual purpose concerning Madagascar maintenance. They provide demos to introduce new users to the functionality of the package and, at the same time, [[Automatic Testing|regression tests]] to assure the system's stability under change.
Summary:
Please note that all contributions to Madagascar are considered to be released under the GNU Free Documentation License 1.3 or later (see
My wiki:Copyrights
for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource.
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Navigation menu
Personal tools
English
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
Page
Discussion
English
Views
Read
Edit
View history
More
Search
Getting Madagascar
download
Installation
GitHub repository
SEGTeX
Introduction
Package overview
Tutorial
Hands-on tour
Reproducible documents
Hall of Fame
User Documentation
List of programs
Common programs
Popular programs
The RSF file format
Reproducibility with SCons
Developer documentation
Adding programs
Contributing programs
API demo: clipping data
API demo: explicit finite differences
Community
Conferences
User mailing list
Developer mailing list
GitHub organization
LinkedIn group
Development blog
Twitter
Slack
Tools
What links here
Related changes
Special pages
Page information