-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathd2.2.tex
366 lines (292 loc) · 13.6 KB
/
d2.2.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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
%%% LearnPAd Document template / example using learnpad.cls class for styling
%%% 20140704,
%%% Guglielmo De Angelis <[email protected]>
%%% Andrea Polini <[email protected]>
\documentclass{learnpad}
%%% ------------------------------------------------------
%%% ---------------- The Title
%%% ------------------------------------------------------
\title{Core Platform Implementation}
%%% ------------------------------------------------------
%%% ---------------- The Sub-Title
%%% ------------------------------------------------------
\subtitle{First version}
%%% ------------------------------------------------------
%%% ---------------- The Name of the Deliverable
%%% ------------------------------------------------------
\deliverableno{D2.2}
%%% ------------------------------------------------------
%%% ---------------- The Authors
%%% ------------------------------------------------------
\authors{
Mehmet Albayrak (BOC),
Francesco Basciani (UDA),
% Mohamed Boussaa (XWIKI),
Antonello Calabr\`o (CNR),
Massimo Casali (MAR),
Guglielmo De Angelis (CNR),
Caleb James DeLisle (XWIKI)
Nesat Efendioglu (BOC),
Sandro Emmenegger (FHNW),
Damiano Falcioni (UNICAM),
Daniele Gagliardi (FHNW),
Tom Jorquera (LIN),
Jean Simard (XWIKI),
Giorgio Oronzo Spagnolo (CNR),
Wilfrid Utz (BOC)
}
%%% ------------------------------------------------------
%%% ---------------- The Editors
%%% ------------------------------------------------------
\editors{Guglielmo De Angelis, Jean Simard}
%%% ------------------------------------------------------
%%% ---------------- The reviewers
%%% ------------------------------------------------------
\reviewers{Andrea Polini (UNICAM)}
%%% ------------------------------------------------------
%%% ---------------- The date
%%% ------------------------------------------------------
\date{\today}
%%% ------------------------------------------------------
%%% ---------------- deliverable info
%%% ---------------- choose among : Report / Other / Prototype
%%% ------------------------------------------------------
\naturedeliverable{Prototype}%
%%% ------------------------------------------------------
%%% ---------------- deliverable dissemination levele
%%% ---------------- choose among the two options below:
\disseminationlevelpublic
% \disseminationlevelconfidential
%%% ------------------------------------------------------
\version{4.1}%
\contractualdeliverydate{31 July 2015}%
\actualdeliverydate{31 July 2015}%
\contributingwp{WP2}%
%%% ------------------------------------------------------
%%% ---------------- abstract
%%% ------------------------------------------------------
\abstract{Deliverable D2.2 consists of a first version of the \learnpad core
platform. The deliverable is of software nature. In this accompanying
documentation we provide a mapping of places and links from where the
``official'' released version of prototype at M18 can be retrieved, as well as
instructions for experimenting it. }
%%% ------------------------------------------------------
%%% ---------------- Keywords
%%% ------------------------------------------------------
\keywords{platform, prototype}
%%% ------------------------------------------------------
%%% ---------------- review table
%%% ------------------------------------------------------
\reviewoutline{1 Jun. 2015}{0.2}{}{}
\reviewdraft{26 Jun. 2015}{1.0}{}{}
\reviewinternal{17 Jul. 2015}{2.0}{Andrea Polini, Antonia Bertolino}{}
\reviewcandidatefinal{24 Jul. 2015}{3.3}{Antonia Bertolino}{}
\begin{document}
\frontmatter
\maketitle
%% ------------------------------------------------------
%% ---------------- document history
%% ------------------------------------------------------
\begin{history}
\historyitem{0.1}{ToC}{Jean Simard}
\historyitem{0.2}{ToC}{Jean Simard}
\historyitem{1.0}{First Draft}{Jean Simard}
\historyitem{2.0}{Internal Release}{Guglielmo De Angelis}
\historyitem{3.0}{Candidate Final}{Guglielmo De Angelis}
\historyitem{3.1}{Added clarifications about the \learnpad Developer
Space}{Guglielmo De Angelis}
\historyitem{3.2}{Added clarifications about the \learnpad
Developer's Repository}{Guglielmo De Angelis}
\historyitem{3.3}{Added clarifications about the Testbed}{Guglielmo De
Angelis}
\historyitem{3.4}{Typos fixed}{Jean Simard}
\historyitem{4.0}{Final Release}{Antonia Bertolino, Guglielmo De Angelis, Jean Simard}
\historyitem{4.1}{Typos fixed}{Antonia Bertolino}
\end{history}
%%% ------------------------------------------------------
%%% ---------------- review table with the previous info
%%% ------------------------------------------------------
\reviewtable
% %%% ------------------------------------------------------
% %%% ---------------- acronyms
% %%% ------------------------------------------------------
% \begin{acronyms}
% \acronym{CA}{Consortium Agreement}%
% \acronym{DL}{Deliverable Leader}%
% \acronym{DOW}{Description of Work}%
% \acronym{EC}{European Commission}%
% \acronym{EL}{Exploitation Leader}%
% \acronym{GA}{Grant Agreement}%
% \acronym{IPR}{Intellectual Property Rights}%
% \acronym{PAB}{Project Advisory Board}%
% \acronym{PCB}{Project Coordination Board}%
% \acronym{PL}{Project Leader}%
% \acronym{PMB}{Project Management Board}%
% \acronym{PO}{Project Officer}%
% \acronym{SL}{Scientific Leader}%
% \acronym{S\&T}{Scientific and Technical}%
% \acronym{TL}{Technical Leader}%
% \acronym{WP}{Work Package}%
% \acronym{WPL}{Work Package Leader}
% % \acronym{\dots}{\dots~\dots}%
% \end{acronyms}
\tableofcontents
%%% ------------------------------------------------------
% In case you don't need one of the following list
% just comment the line
%%% ------------------------------------------------------
% \listoftables
% \listoffigures
% \listoflistings
%%% ------------------------------------------------------
\mainmatter
%%% ------------------------------------------------------
%%% ---------------- Start whit chapter and sections here!
%%% ------------------------------------------------------
\chapter{Introduction}
\label{ch:intro}
Deliverable D2.2 ``Core Platform Implementation'' concerns the first version of the \learnpad platform.
This informal accompanying document points out the links and places where the source files as well as related
information about this first prototype can be found. It is not a detailed explanation of the
architecture of the platform which you can find in deliverable D2.1
\emph{Platform Architectural Description}~\cite{learnpad:D2.1} neither it will
explain implementation choices.
A more focused description about both the best practices, and the tools
that have been setup in order to facilitate the development and the deployment
of the \learnpad prototypes were presented in the deliverables
D7.1~\cite{learnpad:D7.1}, and D7.2~\cite{learnpad:D7.2}.
\section{Structure of the Deliverable}
\label{sec:structure}
The document is organized as follows:
\begin{itemize}
\item Chapter~\ref{ch:sourcecode} reports how to access both the
source-code repositories and the other facilities available for the developers
of the \learnpad platform;
\item With respect to the open-source software, Chapter~\ref{ch:platform}
describes how to access and build the \textit{core development
projects}~\cite{learnpad:D7.1} in the platform;
\item Chapter~\ref{ch:testbed} introduces to a running instance of the
\learnpad Platform that the consortium makes available as a testbed.
\end{itemize}
\chapter{Developer's Repositories}
\label{ch:sourcecode}
As stated in the Consortium Agreement, most of the source code of the
platform is placed under the open source license (defined and certified by Open
Source Initiative). Therefore, the source code of the \learnpad platform that
is released under any open-source licence can be accessed on the web at the
following address:
\url{https://github.com/LearnPAd/learnpad}
Since every partner is using \texttt{git} and
GitHub\footnote{\url{http//www.github.com}} to implement, this link is
always an up-to-date version of the \learnpad platform.
Nevertheless, a snapshot of the \learnpad Platform version ``officially'' released at M18
can be downloaded at:
\url{http://www.learnpad.eu/docs/learnpad-master-M18.zip}
The status of the build of the platform is monitored by means of
Travis-CI~\footnote{\url{https://travis-ci.org/}} and is accessible at the
following link:
\url{https://travis-ci.org/LearnPAd/learnpad}
Travis-CI reports each time the build of the last version of \learnpad is
breaking.
Parts of the \learnpad platform are released under closed-source licences;
specifically this software is mostly related to the development of the modelling
environment. The \learnpad Modelling Environment implemented on the ADOxx
meta-modelling platform is accessible at the \learnpad Developer Space:
\url{http://www.adoxx.org/live/web/learnpad-developer-space/space}
The latest version of the \learnpad Modelling Environment implemented on the
ADOxx platform can be freely downloaded at:
\url{http://www.adoxx.org/live/web/learnpad-developer-space/prototype-v3.0}
\chapter{Working with the \learnpad Platform}
\label{ch:platform}
In the following it is reported how to get, to build, and to
run the \learnpad platform from the source file under a linux-like
operating system.
\section{Get the Sources and Build the Platform}
\label{sec:build}
The first action required is to locally clone the \learnpad
repository form GitHub:
\begin{lstlisting}[style=javaCode, breaklines]
git clone https://github.com/LearnPAd/learnpad.git
\end{lstlisting}
Once the repository is cloned, it could be required to import
possible sub-modules:
\begin{lstlisting}[style=javaCode, breaklines]
cd learnpad
git submodule init
git submodule update
\end{lstlisting}
Finally, the build can be triggered by running the build script in the
root directory of the project.
\begin{lstlisting}[style=javaCode, breaklines]
./build
\end{lstlisting}
\section{Run the Platform}
\label{sec:run}
After the build, a complete wiki instance will exist in the directory
\texttt{lp-platform} and this will be the core of the platform. In order to run
the platform, the following command should be run from a terminal:
\begin{lstlisting}[style=javaCode, breaklines]
./lp-platform/out/start
\end{lstlisting}
The running instance of the platform can be stopped by launching command:
\begin{lstlisting}[style=javaCode, breaklines]
./lp-platform/out/stop
\end{lstlisting}
Once an instance of the \learnpad platform is started, it will be accessible on
your local machine at \url{http://localhost:8080}.
\chapter{A Testbed for the \learnpad Platform}
\label{ch:testbed}
A running instance of the \learnpad platform is also deployed on an XWiki
server for testing purposes. It allows to manipulate the platform in a pretty
recent version. A new deployment is done every time a significant new feature
has been added or a blocking bug has been fixed. This instance is available
at the address:
\url{http://testbed.learnpad.eu/}.
The main goal of this testbed is to facilitate the developers of the several
components aggregated into the \texttt{\learnpad Core
Platform}~\cite{learnpad:D2.1} to test how their own software interacts with
the components developed by the other partners. This testing server may change a
lot along time because of manipulations of partners. The actual demonstration environment
for the \learnpad platform will be deployed later on a dedicated virtual-machine
into the \texttt{Mcloud} platform, i.e., the IAAS cloud service
provided by Regione Marche. Needed formal activities to enable the
switch of the server have already started since April 2015.
\begin{figure}[h!]
\centering
\includegraphics[width=0.85\textwidth]{./Figures/testbed.jpg}
% testbed.jpg: 1280x1004 pixel, 101dpi, 32.19x25.25 cm, bb=0 0 912 716
\caption{\learnpad Platform Testbed}
\label{fig:testbed}
\end{figure}
Note that by accessing the testbed with a browser, it returns the
web pages of the running instance of the platform. Often, these web pages may
result or appear empty (see Figure~\ref{fig:testbed}), but this is normal.
In fact, as described above the main purpose of the testbed is to provide
a technical mean to the developers in order to test their components; thus the
most proper way of interacting with the testbed is not with a browser, yet.
Also, since it's a testing server, data may be erased either at each new
deployment, or periodically.
In this platform, you are able to upload a new model from one of our Modelling
tools (e.g. MagicDraw or ADOxx). Modelling tools are then able to verify the
models (please refer to deliverable D4.1~\cite{learnpad:D4.1} for more details
about the verification process). Once the models have been verified, they are
imported into the wiki.
All imported models are listed in the main page and you can browse them. For
each element of the model, a \textit{feedback} button is available at the
bottom. If the civil servant, looking at the model, wants to give a feedback
about the current page he/she is browsing, he/she can do so through these buttons. All of
these feedbacks are aggregated and sent to the modelling tools when asked. The
modeller can then try to address the feedbacks in order to improve the models.
% ---------------------------------- Start whit annexes here!
% ----------------------------------
% \annex{}
% ---------------------------------- Start EndNotes here!
% ----------------------------------
% Plese use this command if and only if your text includes endnotes.
% Otherwise, comment it.
% \theendnotes
% ---------------------------------- Bibliography starts here
% ----------------------------------
\bibliographystyle{plain}
\bibliography{biblio}
\end{document}