doc/index.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>The Moe Contest Environment</title>
   5 <link rev=made href="mailto:mj@ucw.cz">
   6 <link rel=stylesheet title=Default href="moe.css" type="text/css" media=all>
   7 </head><body>
   8
   9 <h1>The Moe Contest Environment</h1>
  10
  11 <p>The Moe Contest Environment (formerly Moe) is a system for conducting
  12 programming competitions similar in spirit to the
  13 <a href="http://www.ioinformatics.org/">International Olympiad in Informatics</a> &ndash;
  14 contestants solve programming tasks, submit the source code of their solutions,
  15 which is then automatically tested on a set of test inputs.
  16
  17 <p>Moe is built in a modular way, making it easy to adapt it to the specifics
  18 of a particular contest, to other types of tasks, or other programming languages.
  19
  20 <p>A brief description of the system and of the ideas behind it can be found in the following series
  21 of papers published in <a href="http://www.mii.lt/olympiads_in_informatics/">Olympiads in Informatics</a>:
  22
  23 <ul>
  24 <li><a href="http://mj.ucw.cz/papers/eval.pdf">M. Mare&scaron;: Perspectives on grading systems</a>
  25 <li><a href="http://mj.ucw.cz/papers/eval2.pdf">M. Mare&scaron;: Moe &ndash; Design of a Modular Grading System</a>
  26 <li><a href="http://mj.ucw.cz/papers/fairness.pdf">M. Mare&scaron;: Fairness of Time Constraints</a>
  27 <li><a href="http://mj.ucw.cz/papers/isolate.pdf">B. Blackham, M. Mare&scaron;: A New Contest Sandbox</a>
  28 </ul>
  29
  30 <b>News (2012-09-24):</b> A new sandbox module (<code>isolate</code>) is available.
  31 It has very low overhead (it uses Linux kernel containers) and it is able to cope with
  32 multi-threaded programs. For more details, see the "New Contest Sandbox" paper above
  33 or the <a href="isolate.1.html">isolate's man page</a>.
  34
  35 <h2>Modules</h2>
  36
  37 <table class=modules>
  38 <tr><th>module
  39     <th>description
  40     <th>status
  41 <tr><td>sandbox
  42     <td>Runs the contestant's solution in a controlled and secure environment,
  43         limiting its execution time, memory consumption and system calls.
  44         We have a stable implementation (<code>box</code>) based on ptrace
  45         and a new one (<code>isolate</code>) based on Linux kernel containers.
  46     <td class=statedone>works
  47 <tr><td>judges
  48     <td>A set of utilities for comparing the solution's output with the correct
  49         answer at a given level of strictness.
  50     <td class=statedone>works
  51 <tr><td>evaluator<br>(a.k.a. grader)
  52     <td>This module controls the whole process of grading the solution. It runs
  53         the compilers, the sandbox and the judges as described in configuration
  54         files.
  55     <td class=statedone>works
  56 <tr><td>evaluator v2
  57     <td>We have decided to rewrite the evaluator from scratch in Python for greater
  58         flexibility. It will however need some more time to finish.
  59     <td class=statewip>in progress
  60 <tr><td>queue manager
  61     <td>Distributes grading between a cluster of computers, each of them running
  62         the evaluator.
  63     <td class=statepart>works, but needs revision
  64 <tr><td>submitter
  65     <td>Handles submitting of solutions by contestants and passing them to the
  66         evaluation system. Contains a server daemon and a front-end for contestants.
  67         (If your contest uses a web-based contestant interface, you probably do not
  68         need this, although it can serve as a clean interface between your web services
  69         and the evaluator.)
  70     <td class=statepart>works, but needs revision
  71 </table>
  72
  73 <h2>Download</h2>
  74
  75 <p>Moe is still under heavy development, so the best way to obtain the latest
  76 version is directly from our <a href="http://git.or.cz/">Git</a> repository at git://git.ucw.cz/moe.git.
  77 The master branch of the repository is kept in a stable state, new development
  78 is done on other branches and then merged to the master. You can also <a href="http://www.ucw.cz/gitweb/?p=moe.git;a=summary">browse
  79 the repository online</a>.
  80
  81 <p>We occasionally publish snapshot tarballs in our <a href="ftp://ftp.ucw.cz/pub/mj/eval/">FTP archive</a>.
  82
  83 <h2>Documentation</h2>
  84
  85 <p><span class="statewip">Warning:</span> Most parts of this documentation are outdated. Please consult the papers above
  86 to get a more up-to-date picture.
  87
  88 <ul>
  89 <li><a href="anatomy.html">Anatomy of Moe</a>
  90 <li><a href="install.html">Installation</a>
  91 <li><a href="tasks.html">Tasks and their types</a>
  92 <li><a href="eval.html">Evaluating solutions</a>
  93 <li><a href="public.html">Utilities for contestants</a>
  94 </ul>
  95
  96 <h2>Contests</h2>
  97
  98 <p>Moe (or some of its modules) are used at the following contests:
  99
 100 <ul>
 101 <li><a href="http://mo.mff.cuni.cz/p/index.html.en">Czech Olympiad in programming</a> since 2002
 102 <li><a href="http://mo.mff.cuni.cz/cpspc/">CPSPC</a> (Czech-Polish-Slovak Preparation Camp) on some years
 103 <li><a href="http://www.fi.muni.cz/ceoi/">CEOI 2007</a> (Central-European Olympiad in Informatics)
 104 <li><a href="http://www.ioinformatics.org/">IOI<a> since 2009 (used the sandbox module)
 105 <li><a href="http://codex2.ms.mff.cuni.cz/project/">CodEx</a> (a web-based system, originally
 106         designed for evaluation of students' homeworks, but also used for several programming
 107         contests)
 108 </ul>
 109
 110 <h2>Languages</h2>
 111
 112 <p>Moe is known to work with these programming languages:
 113
 114 <ul>
 115 <li>Pascal (<a href="http://www.freepascal.org">Free Pascal Compiler</a>)
 116 <li>C and C++ (<a href="http://gcc.gnu.org/">GCC</a>)
 117 <li>C# (<a href="http://www.mono-project.com/">Mono</a> with some hacks)
 118 <li>Haskell (<a href="http://www.haskell.org/ghc/">GHC</a>)
 119 </ul>
 120
 121 <p>Adding a new language should be easy, as long as the language behaves in a sane
 122 way (e.g., if it does not need to use a zillion threads for a trivial program
 123 as Java does).
 124
 125 <h2>Portability</h2>
 126
 127 <p>Moe is developed and tested on Linux, but all modules except the sandbox should
 128 happily work on any UNIX-like system providing a reasonable set of GNU
 129 utilities (especially bash) and Perl. This probably includes MinGW or Cygwin
 130 on Windows, but we have not tested that.
 131
 132 <p>The sandbox heavily depends on the target OS. The current version works
 133 only on Linux with kernel version 2.6 or newer and only on the i386 and amd64
 134 architectures. Porting to other architectures should require only minor changes,
 135 porting to other systems is likely to be hard.
 136
 137 <p>The <code>isolate</code> sandbox does not depend on CPU architecture,
 138 but it requires a recent Linux kernel in a configuration which might be different
 139 from your distribution's default.
 140
 141 <h2>Authors</h2>
 142
 143 <p>Moe has been written by the following people:
 144
 145 <ul>
 146 <li><a href="http://mj.ucw.cz/">Martin Mare&scaron;</a>, <a href="mailto:mj@ucw.cz">mj@ucw.cz</a>
 147 <li>Tom&aacute;&scaron; Gaven&#269;iak (the queue manager module and parts of the new evaluator)
 148 <li>Bernard Blackham (parts of <code>isolate</code>)
 149 </ul>
 150
 151 <p>We are also thankful to Jan K&aacute;ra and Milan Straka for their help and for
 152 many fine ideas.
 153
 154 <h2>License</h2>
 155
 156 <p>Moe can be used and distributed under the terms of the <a
 157 href="http://www.gnu.org/copyleft/gpl.html">GNU General Public License version 2.</a>
 158
 159 <h2>Feedback</h2>
 160
 161 <p>All bug reports, suggestions and patches are welcome. Please mail them to our mailing
 162 list <a href="mailto:moe@ucw.cz">moe@ucw.cz</a>. You can <a href="http://www.ucw.cz/mailman/listinfo/moe">ask
 163 the list server</a> to subscribe to this list.
 164
 165 </body></html>