added some basic documentation

Dockerfile

@@ -16,6 +16,8 @@ RUN apt-get update -y && apt-get install -y \
 	r-base \
 	r-base-dev \
 	libudunits2-dev \
+	cowsay \
+	less \
 	--no-install-recommends \
 	&& apt-get clean \
 	&& rm -rf /var/lib/apt/lists/*
@@ -23,14 +25,18 @@ RUN apt-get update -y && apt-get install -y \
 COPY trainbenchmark-reporting/install.R /trainbenchmark/trainbenchmark-reporting/install.R
 RUN Rscript /trainbenchmark/trainbenchmark-reporting/install.R
 
+USER user
 WORKDIR /trainbenchmark
 
 COPY --chown=user:user . .
+COPY docker/bashrc /home/user/.bashrc
 
 RUN ./gradlew --no-daemon preprocess
 RUN ./gradlew --no-daemon build shadowJar -x test
 RUN ./gradlew --no-daemon initScripts
 
+
+
 # when benchmarking run:
 # RUN ./gradlew --no-daemon generate
 # RUN ./gradlew --no-daemon individualInjectBenchmark

docker/bashrc

+source /etc/bashrc
+
+function csv_viewer {
+ column -t -s, -n "$@" | less -F -S -X -K
+}
+alias doc_motd="bash /trainbenchmark/docs/motd"
+alias doc_basic="bash /trainbenchmark/docs/basic"
+alias doc_advanced="bash /trainbenchmark/docs/advanced"
+
+alias cowsay="cowsay -f /trainbenchmark/docker/frog.cow"
+alias cowsay_tip="shuf -n 1 /trainbenchmark/docker/tips | cowsay -f /trainbenchmark/docker/frog.cow"
+
+doc_motd

docker/frog.cow

+$the_cow =<<"EOC"
+  $thoughts
+     ___        _--_
+    /    -     /     \\
+   ( OOO   \\  ( @@  )
+   |  OOO _;\\-/| @@@_|
+    \\___/######\\___/\\
+      /##############\\
+     /  ######   ##  #|
+    /  ##@##@##       |
+   /    ######     ##  \\
+ <______-------___\\  . //_
+    |       ____  | | //# \\__~__
+     \\      $tongue    \\  //###  \\   \\
+      |             /\'  ##  ##  ##\\   __--~--_
+       \\_________- /\\ )    ^     ##|--########\\
+  /--~-_\\________/_  |          #@##|#######Y##|
+ | \\ `  /|       /O/ ( ###  \')    ##/######/###/
+ \\  \\  | |       --  |  ###        /LLLLL--###/
+  \\_ \\/  |            \\_   \\    ) /####_____--
+ ___ /    \\           /     |   _-####\\
+(___/     -\\_________/     / -- |#####@@@@@@\'_
+ (__\\_      __,) (.___     ,/    /#####      `@@
+      | -\\\\-          //-//      @@  @@@@@.
+      | | \\\\_       _// //      @\'       \'@@.
+      (.)   \\_)    / / //                   @@@
+                  (_) (_\'
+EOC

docker/tips

+Use "doc_motd" to display the login message
+Use "doc_basic" to display the basic commands to run the benchmark
+Use "doc_advanced" to see advanced configuration
+Use "csv_view" to get a nicely formatted output of csv files
+I am the Fog Frog
+What the Fog?

docs/advanced

+#!/bin/bash
+echo -e "\033[1;91mAdvanced Configuration:"
+echo -e ""
+echo -e "\033[1;91mGeneration of test-models"
+echo -e "\033[0mFor example to change the maxSize option. Can be configured inside:"
+echo -e "* trainbenchmark-scripts/src-template/GeneratorScript.groovy"
+echo -e "When you are finished, run:"
+echo -e "* ./gradlew initScripts"
+echo -e "* ./gradlew generate"
+echo -e ""
+echo -e "\033[1;91mBenchmarking"
+echo -e "\033[0mCan be configured inside:"
+echo -e "* trainbenchmark-scripts/src-template/IndividualBenchmarkInjectScript.groovy"
+echo -e "* trainbenchmark-scripts/src-template/IndividualBenchmarkRepairScript.groovy"
+echo -e "When you are finished, run:"
+echo -e "* ./gradlew initScripts"
+echo -e "* ./gradlew individualInjectBenchmark"
+echo -e "* ./gradlew individualRepairBenchmark"

docs/basic

+#!/bin/bash
+echo -e "\033[1;96mQuick Start"
+echo -e "\033[0m* ./gradlew generate # will generate the test-models in default settings takes ~40gb"
+echo -e "* ./gradlew individualInjectBenchmark"
+echo -e "* ./gradlew individualRepairBenchmark"
+echo -e ""
+echo -e "\033[1;96mReading the Benchmark results"
+echo -e "\033[0mResults of individualInjectBenchmark and individualRepairBenchmark are stored inside:"
+echo -e "* XXXX for graphs"
+echo -e "* XXXX for csv - use command: csv_viewer data.csv"

docs/motd

+#!/bin/bash
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
+# echo -e "                                                                                    "
+# echo -e "  *   )                          )                      )                        )  "
+# echo -e "  )  /( (       )  (          ( /(    (              ( /(     )       )  (    ( /(  "
+# echo -e " ( )(_)))(   ( /(  )\   (     )\())  ))\  (      (   )\())   (     ( /(  )(   )\()) "
+# echo -e "(_(_())(()\  )(_))((_)  )\ ) ((_)\  /((_) )\ )   )\ ((_)\    )\  ' )(_))(()\ ((_)\  "
+# echo -e "|_   _| ((_)((_)_  (_) _(_/( | |(_)(_))  _(_/(  ((_)| |(_) _((_)) ((_)_  ((_)| |(_) "
+# echo -e "  | |  | '_|/ _' | | || ' \))| '_ \/ -_)| ' \))/ _| | ' \ | '  \()/ _' || '_|| / /  "
+# echo -e "  |_|  |_|  \__,_| |_||_||_| |_.__/\___||_||_| \__| |_||_||_|_|_| \__,_||_|  |_\_\  "
+# echo -e "                                                                                    "
+cowsay_tip
+bash $DIR/basic
+echo -e ""
+echo -e "\033[1;96mDocumentation"
+echo -e "\033[0mRun the following commands"
+echo -e "* doc_motd      # displays this message"
+echo -e "* doc_basic     # displays the basic guide"
+echo -e "* doc_advanced  # displays the advanced guide"
+echo -e ""
+# bash $DIR/advanced