# Introduction

## Current code evaluating solution

## Analysis of related projects

## ReCodEx goals

## Terminology
Official terminology of ReCodex which will be used in documentation and within code.

### Web Application (web-app)
Graphical frontend of the whole ReCodex. This part is used by teachers and students.

* **Exercise** - Exercise is basic point of all evaluation. Students are receiving assignment from their teacher, but firstly there has to be authors of exercises from which assignments are derived. Assignment is basically exercise which was assigned to some group of students for evaluation.

* **Assignment** - Teachers are creating assignments from exercises which are solved by students. When assignment is solved then students submit their solution, this solution with all other informations (needed by worker) is called submission.

* **Sample solution** - When authors create exercises, they should provide sample solution. This solution should pass all test cases in specified limits. It can be also used for auto-calibration of exercise.

* **Submission** - Submission is one solution of given exercise, it is sent by student to frontend of ReCodEx. To this term we can include all additional information about source code or submitter.

### Message Broker (ZeroMQ)
Handle incoming requests from php backend and forward them to actual workers, also handle answers from workers which has to be saved to the central database. (possibly files can be transfered through QM).

### Worker (recodex-worker)
Program which executes and evaluates tasks given by QM. Its internally divided into net part (communication with QM) and evaluation part which evaluates task itself.

* **Job** - Basically structure which is transfered from QM (Aka. one request from QM is job). Internally set of tasks. Job itself is transfered in form of configuration file written in YAML. Typicaly, job is one standard submission, but there could be also benchmarking submission for configuring limits of exercise or maybe submission for determining hardware and software configuration of given worker. This classification have no effect for evaluating the job. 

* **Task** - Atomic piece of work which can execute external program or some internal command.

* **Tests** - Tests are inputs to given student solution of exercise. On specified inputs program should have specified outputs, this is checked with judges. Test files can be send to standard input or just be there for the use from program.

* **Sample outputs** - Sample outputs are basically given results of tasks. Output from program is compared with this files through judge.

* **Judge** - Judge is a comparision program which compares sample outputs against output from program.

* **Limits** - Particular tasks are usually running in sandbox, these limits are forwarded to the sandbox.