Back to files

SEP's laboratory-wide standard rules
for reproducible electronic documents

These rules are adapted to SEP's compute environment. docs/Rules contains a more generic version.

(matt@sep.stanford.edu)

SUMMARY

To organize computational scientific research and hence to conveniently transfer our technology, we impose a simple filing discipline on the authors in our laboratory. A document's makefile includes laboratory-wide standard rules that offer readers these four standard commands:

make burn removes the document's result figures, make build recomputes them,
make tube displays the figures, and make clean removes any intermediate files. Although we developed these standards to aid readers we discovered that authors are often the principal beneficiaries.

Contents

• Doc files: implements SEP's make rules and variable definitions

  for SEP's electronic reproducible documents.

• Prg files: implements SEP's make rules and variable definitions for

  compiling, linking, and installation of executables.

• SEP files: organizes the inclusion of the various make source code.
• Adm dir: contains administrative files
• docs dir: contains the documentation for SEP's reproducible research

  system.

• docs/cip dir: contains our white paper on reproducible electronic

  documents (if you want to find out what it is all about start here).

• docs/Rules dir: contains a generic set of rules for reproducible

  electronic documents.

• docs/Frog dir: contains a generic example of a reproducible

  electronic document.

• docs/index file: offers our reproducible research software on the

  World Wide Web.

• docs/sephelp dir: describes the SEP specific rules for reproducible

  document (not yet in great shape).

• docs/cake.ps: discusses an earlier implementation of our reproducible

  electronic document.

• docs/seg92.html: reports on our first reproducible electronic document

  efforts to the Society of Exploration Geophysicists.

• docs/blurb.html: reports to SEP's sponsors on our progress in various

  technology areas, such as reproducible electronic documents.

• docs/cdvswww.html: expresses SEP's disappointment delivering reproducible

  research using CD-ROM technology for UNIX workstations.

To Do List:

• Matt: we need SEP.shell.rules that implements

  cross platform installations (as in our/word/Adm/Src ...)

• Matt: {\it every} document level (book, chapter, figure level) should

  offer the same standard commands (clean,burn,build, tube). Book level is missing. Chapter level should be automatically up dated.

• Matt: How to extract single chapters (for web distribution)?