The Wiki Sandbox contains links to:
- useful documentation bits from the blog, mailing lists and forums. These bits may coagulate into documentation pages when a critical mass on a topic is attained;
- pages under construction that may not be ready to go into the navbar (the navbar = the vertical list of links on the left of this page).
- obsolete pages that have been unlinked from the navbar
The intent is to provide a middle ground between "fragment of useful information stranded in a forum post/in author's head" and "finished page ready for being posted to the world with pride". This sort of information benefits much more from collaborative editing than finished pages that are incrementally improved after creation.
For being handed over at conferences, displayed at booths of institutions using it and contributing to it if they will, etc.
Purpose: Giving the users reasons why they should use Madagascar
The brochure is handled by the reader in two ways: most often, closed (so pages 1 and 6 are the most important), or opened and read in a manner similar to that of a book, in which case the order of pages is the one below:
An example we can learn from – the SU brochure. It looks a bit dry though -- A brochure needs more graphics than that. Graphics may need to be in uniform tones, so as to not increase the cost of printing (glossy paper, photographic quality costs).
Info from the blog/mailing lists/forums
- Hidden parameters in Madagascar programs
- How to make RSF files easy to fetch from FTP servers
- Plotting a function defined in polar coordinates
- Tools complementary to vplot2eps
- Checking parameters -- from rsf-user: "At the compile time, a special database is constructed, which contains all information about each module and its parameters. The parameter information is extracted automatically from the source code. This puts minimal requirements on the developers and prevents documentation from getting out of sync with the code. The database is stored as a Python module rsfprog.py and becomes instantly available to any Python script that uses import rsfprog. The immediate use is for self-documentation with sfdoc. The other use is to optionally check parameters for sanity when running processing flows through scons".
- Demo on reproducibile Matlab and Mathematica figures
- Unit keywords in headers, sfunits example
- How to use information from sfattr or sfget in SConstruct Flows
- Why does Plot/Result in SConstruct files sometimes have two parameters instead of three?
- How to plot 1-D irregular data with sfdots?
- How to zero a portion of a dataset based on a header mask
- scalebar in sfgrey3
- Plotting irregular data
- Timing execution of SCons targets
- The algorithm behind sfnoise
- Demo of color schemes in sfgrey and sfgrey3
Configuration, install, testing, etc
- How to generate local documentation with sfdoc
- latex2wiki example
- Screenshot of Madagascar running under MS Services for Unix
- The origin of Madagascar's name
- How to perform unit testing
- How to make the VERSION line of the self-doc work correctly
- Subscribing to the RSF blog with a RSS/Atom reader
- SCons and packed RSF files
- From SCons rules to shell scripts
- How to test Madagascar programs
- SCons macros are found in book/packages
- How to set up a mirror for the Madagascar public datasets
- Madagascar file bundles
- Byteswapping option for sfdd
- Google bombing for Madagascar; interface to industry
- Parallelization API
- Using XML in RSF headers;
- Later: Author's own repudiation of the AJAX part of the previous proposal (other parts still stand).
- From the Sergey-Reg Beardsley email exchange on rsfuser in Jul 2006: add to each history record Madagascar, OS versions
- To have a consistent user interface, certain types of inputs and outputs should be standardized. A small beginning has been made by giving the verbosity option the same name everywhere. More meaningful issues would involve:
- having all frequencies in Hertz
- deciding whether all offsets should be half offsets or full offsets
- FFT sign conventions (- for FFT forward in time, + for FFT forward in space, like in BEI)
- Deciding whether programs should work with velocities or slownesses, and the standard axis order for a velocity model file.
- Standard axis order for inputs to programs that do similar things, i.e. switching a migration program for another in a SCons rule should be as simple as just changing the name of the program, without having to scratch one's head to determine how should the data and velocity be set up. Create Python metaprograms that add transparently to the user dimensions of length 1 to 2-D datasets when needed by programs that deal with 3-D data.
ASCII art – possibly useful for error messages, text UIs with ncurses, etc. Standard font:
__ __ _ | \/ | __ _ __| | __ _ __ _ __ _ ___ ___ __ _ _ __ | |\/| |/ _` |/ _` |/ _` |/ _` |/ _` / __|/ __/ _` | '__| | | | | (_| | (_| | (_| | (_| | (_| \__ \ (_| (_| | | |_| |_|\__,_|\__,_|\__,_|\__, |\__,_|___/\___\__,_|_| |___/
__ __ _ | \/ | | | | \ / | __ _ __| | __ _ __ _ __ _ ___ ___ __ _ _ __ | |\/| |/ _` |/ _` |/ _` |/ _` |/ _` / __|/ __/ _` | '__| | | | | (_| | (_| | (_| | (_| | (_| \__ \ (_| (_| | | |_| |_|\__,_|\__,_|\__,_|\__, |\__,_|___/\___\__,_|_| __/ | |___/