doc/anatomy.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html40/strict.dtd">
   2
   3 <html><head>
   4 <title>MO Eval - Anatomy</title>
   5 <link rev=made href="mailto:mj@ucw.cz">
   6 <link rel=stylesheet title=Default href="mo-eval.css" type="text/css" media=all>
   7 </head><body>
   8
   9 <h1>The Anatomy of MO-Eval</h1>
  10
  11 <p>MO-Eval lives in the following directory structure:
  12
  13 <ul>
  14 <li><code>bin/</code> &ndash; all programs (usually shell scripts)
  15 <li><code>box/</code> &ndash; temporary files used by the sandbox module
  16 <li><code>doc</code> &ndash; this documentation
  17 <li><code>examples</code> &ndash; example problems
  18 <li><code>misc</code> &ndash; various currently undocumented stuff
  19 <li><code>problems/</code> &ndash; definitions of problems (tasks)
  20 <li><code>public</code> &ndash; data available publicly to the contestants
  21 <li><code>solutions</code> &ndash; solutions of problems (both by contestants and authors)
  22 <li><code>src</code> &ndash; source of parts of the evaluator written in C
  23 <li><code>template</code> &ndash; templates of contestants' home directories
  24 <li><code>testing</code> &ndash; results of testing of solutions
  25 <li><code>tmp</code> &ndash; various temporary files
  26 <li><code>Makefile</code> &ndash; as usually
  27 <li><code>config</code> &ndash; the main configuration file
  28 </ul>
  29
  30 <p>When installed, it will create the following hierarchy:
  31
  32 <ul>
  33 <li><code>eval</code> &ndash; all data belonging to the evaluator, inaccessible to contestants
  34 <li><code>public</code> &ndash; public data made available to the contestants
  35 <li><code>users</code> &ndash; home directories of the contestants
  36 </ul>
  37
  38 <p>We have tried to make the whole system as flexible as possible, which has lead to writing
  39 almost everything as simple shell scripts, building on  a library of shell functions contained
  40 in <code>bin/lib</code>. The config files are also shell scripts, making it possible to do lots
  41 of fancy (and also confusing, to be honest :) ) things there, the most useful being variable
  42 substitutions.
  43
  44 </body></html>