X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=doc%2Fuser_manual%2Fec_api.tex;h=40b73ef75fa2c64fe816a7f404729970afef5051;hb=e55924b6886bd7382a28e1ae235c4810f852e163;hp=5de660f5fa16261170d510a55c9bf7a58863c60d;hpb=4fea45903bd5ae406ea9965bdec3ada7119d0ea1;p=nepi.git diff --git a/doc/user_manual/ec_api.tex b/doc/user_manual/ec_api.tex index 5de660f5..40b73ef7 100644 --- a/doc/user_manual/ec_api.tex +++ b/doc/user_manual/ec_api.tex @@ -1,12 +1,11 @@ -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % % NEPI, a framework to manage network experiments % Copyright (C) 2013 INRIA % % This program is free software: you can redistribute it and/or modify -% it under the terms of the GNU General Public License as published by -% the Free Software Foundation, either version 3 of the License, or -% (at your option) any later version. +% it under the terms of the GNU General Public License version 2 as +% published by the Free Software Foundation; % % This program is distributed in the hope that it will be useful, % but WITHOUT ANY WARRANTY; without even the implied warranty of @@ -25,7 +24,7 @@ The ExperimentController (EC) is the entity in charge of turning the experiment description into a running experiment. In order to do this the EC needs to know which resources are to be used, how they should be configured and how resources relate to one another. -To this pourpose the EC exposes methods to register resources, specify their +To this purpose the EC exposes methods to register resources, specify their configuration, and register dependencies between. These methods are part of the EC design API. Likewise, in order to deploy and control resources, and collect data, @@ -214,8 +213,8 @@ print ec.trace_enabled(guid, "trace-name") \subsection{Registering connections} -In order to describe the experiment set-up, resources need to be -associated to one another. Through the process of connecting resources +In order to describe the experiment set-up, a resources need to be +associated at least to one another. Through the process of connecting resources the \emph{topology graph} is constructed. A certain application might need to be configured and executed on a certain node, and this must be indicated to the EC by connecting the application RM to the node @@ -335,7 +334,7 @@ ec.deploy(wait_all_ready=False) Attribute values can be retrieved at any moment during the experiment run, using the \emph{get} method. -However, not all attributes can de modified after a resource has +However, not all attributes can be modified after a resource has been deployed. The possibility of changing the value of a certain attribute depends strongly on the RM and on the attribute itself. As an example, once a \emph{hostname} has been specified for a certain Node @@ -446,7 +445,7 @@ for trace in ec.get_traces(guid): Further information about classes and method signatures can be found using the Python \emph{help} method. -For this inspection work, we recommend instantiating an +For this inspection work, we recommend to instantiate an ExperimentController from an IPython console. This is an interactive console that allows to dynamically send input to the python interpreter.