-
Notifications
You must be signed in to change notification settings - Fork 2
/
user_guide.tex
197 lines (140 loc) · 8 KB
/
user_guide.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
\documentclass[twoside,a4paper]{refart}
\usepackage{makeidx}
\usepackage{glossary}
\makeglossary
\usepackage{graphicx}
\usepackage{array}
\usepackage[unicode,a4paper]{hyperref}
%\usepackage[german]{babel}
\usepackage[latin1]{inputenc}
\usepackage{amsmath}
\usepackage{amsthm}
\usepackage{color}
\usepackage{comment}
%\usepackage[all,draft]{draftcopy}
\usepackage{graphicx}
\usepackage{type1cm}
\usepackage{eso-pic}
\usepackage{color}
\usepackage{xspace}
\makeatletter
%\AddToShipoutPicture{%
% \setlength{\@tempdimb}{.5\paperwidth}%
% \setlength{\@tempdimc}{.5\paperheight}%
% \setlength{\unitlength}{1pt}%
% \put(\strip@pt\@tempdimb,\strip@pt\@tempdimc){%
% \makebox(0,0){\rotatebox{45}{\textcolor[gray]{0.85}%
% {\fontsize{6cm}{6cm}\selectfont{DRAFT}}}}%
% }%
%}
\makeatother
\definecolor{edaccblue}{rgb}{0,0.2,0.6}
\definecolor{green}{rgb}{0,0.8,0.2}
\hypersetup{pdftex=true, colorlinks=true, breaklinks=true, linkcolor=edaccblue, menucolor=edaccblue,pagecolor=edaccblue, urlcolor=edaccblue}
\newtheoremstyle{dotless} % Name
{0.5em} % Space above
{0.5em} % Space below
{} % Body font
{} % Indent amount
{\bfseries}% Theorem head font
{:} % Punctuation after theorem head
{\newline} % Space after theorem head
{} % Theorem head spec (can be left empty, meaning 'normal')
\theoremstyle{dotless}
\newtheorem{definition}{Definition}[section]
\newcommand{\ie}{i.\,e.,}
\newcommand{\eg}{e.\,g..}
\newcommand{\edacc}{\textbf{\color{edaccblue}EDACC}\xspace}
\newcommand{\mysql}{MySQL\textsuperscript{\texttrademark}}
\newcommand{\todo}{\textbf{\color{red}TODO:}}
\newcommand{\ml}[1]{\marginlabel{#1}\index{#1}}
\newcounter{ex}
\setcounter{ex}{1}
\newcommand{\Eexample}{\color{green}Example \arabic{ex}: \addtocounter{ex}{1}}
\title{
\begin{tabular}{>{\raggedright}m{4cm}>{\raggedleft}m{10cm}}
%\begin{tabular}{|l|r|}
EDACC \\User Guide \\version 0.1\\ & \includegraphics[scale=0.3]{edacclogo.jpg}
\end{tabular}
}
\author{Copyright\copyright by Adrian Balint, Daniel Diepold, Daniel Gall, Simon Gerber, Gregor Kapler, Robert Retz, Melanie Handel}
\date{}
\pagestyle{myfootings}
\markboth{EDACC User Guide}%
{EDACC User Guide}
\makeindex
\setcounter{tocdepth}{2}
\begin{document}
\maketitle
\begin{abstract}
We present the main capabilities of EDACC and describe how to use EDACC for managing solvers and instances, create experiments with them, launch them on different computer clusters, monitor them and then analyze the results.
\end{abstract}
\tableofcontents
\newpage
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{comment}
\section*{User guide zum User Guide}
\color{red} Bevor Ihr etwas in diesem user guide was reinschreiben wollt/sollt bitte diesen Kapitel durchlesen.
\color{black}
Alle Autoren sollten versuchen die folgenden Richlinien zu folgen, sodass die Arbeit ein homogenes Erscheinen bekommt auch wenn viele Autoren dran arbeiten.
\subsection{Darstellungskonventionen}
Das ist ein User Guide, folglich sollten die wichtigen Informationen f�r den Benutzer sehr schnell auffindbar sein.
Dazu verhelfen folgende Konzepte:
\marginlabel{Index} Indexierung aller wichtigen W�rter; insbesondere Schl�sselw�rter. Der Index und die pdf-hyperreferenzen sollen ein schnelles suchen erm�glichen. Setzen von index w�rter mit \verb|\index{wort}|.
Um wichtige Dinge schnell zu finden sollen auch seitliche Hinweise helfen.
\marginlabel {seitlicher Hinweis auf} diese werden mit\\ \verb|\marginlabel{schl�sselwort}| gesetzt.
Auf Beispiele weist man am besten mit \verb|\marginlabel{\Eexample}| hin. \marginlabel{\Eexample}
\marginlabel{Verweise} Wenn man auf eine andere stelle im Text refenrenzueren will, was man so oft wie m�glich machen sollte dann erscheint die Referenz auch im linken Rand mit: \verb|\seealso{label}|. Wie zum Beispiel: Ein �berblick �ber diesen user-guide gibts in Kapitel \ref{outline} \seealso{Section \ref{outline}}.
\marginlabel{Hinweise} Falls etwas doch sehr wichtig sein sollt, im Regel Besonderheiten auf die man achten sollte so kann man den Leser mit \attention \verb|\attention| darauf aufmerksam machen!
\marginlabel{Glosareintr�ge} Wichtige Terme sollten am besten auch eine Definition haben, oder wenigstens eine Erkl�rung was damit gemeint ist. Das kann man am besten mit
\verb|\glossary{name={Glossareintrag}, description={Beschreibung}}| \glossary{name={Glossareintrag},description={Das ist ein Eintrag in dem Glossar des Dokumnets!}}.
\subsection{Inhaltliche Konventionen}
\marginlabel{Audienz identifizeren} Ich gehe davon aus, dass die meisten Leute die EDACC verwenden werden Informatiker sein werden, oder eine Unterart davon. Folglich k�nnen wir davon ausgehen, dass sie mit den g�ngisten Begriffe vertraut sind (Ein Glossareintrag zu diesen w�rde tortzdem nicht schaden). Der Benutzer wird immer als \textbf{user} im Text angesprochen.
\marginlabel{Verwendungsart des user-guides} Ich gehe auch davon aus, dass die meisten users diese Hilfe als Nachschlagewerk verwenden werden. Folglich soll auch der Inhalt task-orientiert sein. Das bedeutet dass man nicht das System an sich versucht zu beschreiben sondern die Aufgaben beschreibt und dadurch eher die Systembeschreibung entsteht. Es ist ungef�hr das Gegenteil von dem Paper, wo nur die abstrakten Konzepte des Systems beschrieben worden sind. Also wenn Eure Doku zu sehr nach paper klingt seid ihr auf dem falschen Weg.
\marginlabel{System definieren} Das System wenn es als Ganzes erw�hnt wird sollte mit \textbf{EDACC} erw�hnt werden. Allerdings sollte man vermeiden das Obersystem in Beschreibungen zu verwenden. Besser ist es wenn man sich immer auf dessen Teilkomponenten bezieht: \textbf{DB, GUI, client, WF}. \textbf{Monitor} wird nur als ein Teil des \textbf{WF} betrachtet.
\marginlabel{Workflow angelehnte Beschreibung} Die Beschreibung der einzelenen Aufgaben sollte an dem typischen Workflow von EDACC orientiert sein.
Die allgeinen Konzepte und Probleme werden in der Anleitung sehr gut beschrieben sein. Im Hauptteil des user-guides sollen die Aufgaben beschrieben werden die man mit EDACC l�sen kann. \marginlabel{Task-Beschreibung}Dabei achtet man auf:
\begin{enumerate}
\item Identifizierung der Aufgaben (z.B:''Solver hinzuf�gen'')
\item Aufteilung der Aufgabe in Unteraufgaben: (z.B: ``Solver binaries verwalten und die Parameter spezifizieren'')
\item Jede Aufgabe wird in Schritten beschrieben die durchnummeriert werden. (z.B: 1. name des solvers eintragen 2. Author eintragen 3. Version (name und verison m�ssen eindeutig sein))
\item Fallunterscheidungen sollen explizit beschrieben werden wenn der Benutzer eine Entscheidung treffen muss (if-then-else Formulierungen). z.B: (Falls ein Parameter als Boolean markiert wird so ...)
\item Reichlich refenrenzieren und verweisen auf Glossar, Index und andere Stellen im Text wo (verwandte / ben�tigte) ( Aufgaben / Konzepte ) beschrieben werden.
\end{enumerate}
\end{comment}
\section{Outline}
\label{outline}
Here we will have an overview of this user guide specifying where the user can find what!
\section{Introduction}
\input{introduction}
\section{Graphical User Interface}
\input{connection}
\input{modes}
\input{managedbmode}
\input{experimentmode}
\input{property}
\newpage
\section{Parameter search space specification}
\label{parameter_spec}
\input{parameter_spec}
\clearpage
\newpage
\section{Client}
\label{client}
\input{client}
\clearpage
\attention The client is running solely on Unix and is not distributed yet for Windows systems.
\newpage
\section{Web Frontend}
\label{web_frontend}
\input{web_frontend}
\clearpage
\section{Monitor}
\section{Troubleshooting}
\begin{fullpage}
\stepcounter{section}
\addcontentsline{toc}{section}{\numberline {\thesection} Glossar}
\printglossary
\end{fullpage}
\printindex
\end{document}