updating user manual

diff --git a/doc/user_manual/getting_started.tex b/doc/user_manual/getting_started.tex
index 904e112..148c54b 100644 (file)
--- a/doc/user_manual/getting_started.tex
+++ b/doc/user_manual/getting_started.tex
@@ -33,7 +33,11 @@ before using NEPI. \\
 Mandatory dependencies:
 \begin{itemize}
     \item Python 2.6+
 Mandatory dependencies:
 \begin{itemize}
     \item Python 2.6+

-    \item Mercurial 
+    \item Mercurial
+    \item python-ipaddr
+    \item python-networkx
+    \item python-pygraphviz
+    \item python-matplotlib 

 \end{itemize}
 
 Optional dependencies:
 \end{itemize}
 
 Optional dependencies:


@@ -47,7 +51,7 @@ Optional dependencies:
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}

-    $ sudo aptitude install -y python mercurial
+    $ sudo apt-get -y install python mercurial python-ipaddr python-networkx python-pygraphviz python-matplotlib

 \end{verbatim}
 
 \endgroup
 \end{verbatim}
 
 \endgroup


@@ -58,7 +62,7 @@ Optional dependencies:
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}

-    $ sudo yum install -y python mercurial
+    $ sudo yum -y install python mercurial python-ipaddr python-networkx graphviz-python python-matplotlib

 \end{verbatim}
 
 \endgroup
 \end{verbatim}
 
 \endgroup


@@ -66,13 +70,30 @@ Optional dependencies:
 \subsection{Install dependencies on Mac}
 
 First install homebrew (\url{http://mxcl.github.io/homebrew/}),
 \subsection{Install dependencies on Mac}
 
 First install homebrew (\url{http://mxcl.github.io/homebrew/}),

-then install Python.
+then you can install Python and the rest of the dependencies as follows:

 
 \begingroup
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}
 
 \begingroup
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}

-    $ brew install python
+   $ brew install python
+   $ sudo port install mercurial
+   $ sudo easy_install pip
+   $ sudo pip install ipaddr
+   $ sudo pip install networkx
+   $ sudo  pip install pygraphviz
+   $ sudo  pip install matplotlib
+\end{verbatim}
+
+\endgroup
+
+To use Python you will need to set the PATH environmental variable as:
+
+\begingroup
+    \fontsize{10pt}{12pt}\selectfont
+
+\begin{verbatim}
+   $ export PATH=$PATH:/usr/local/share/python

 \end{verbatim}
 
 \endgroup
 \end{verbatim}
 
 \endgroup


@@ -105,7 +126,7 @@ control system. The Mercurial NEPI repo can also be browsed online at: \\
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}

-$ hg clone http://nepi.inria.fr/code/nepi -r nepi-3.0-release
+$ hg clone http://nepi.inria.fr/code/nepi -r nepi-3-dev

 \end{verbatim}
 
 \endgroup
 \end{verbatim}
 
 \endgroup


@@ -139,7 +160,7 @@ environmental variable, when you run a NEPI script.
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}

-    $ PYTHONPATH=$PYTHONPATH:<path-to-nepi>/src python experiment.py
+    $ export PYTHONPATH=$PYTHONPATH:<path-to-nepi>/src 

 \end{verbatim}
 
 \endgroup
 \end{verbatim}
 
 \endgroup


@@ -156,7 +177,7 @@ The second one is in interactive mode by using Python console.
 Writing a simple NEPI expeiment script is easy.
 Take a look at the example in the FAQ section \ref{faq:ping_example}.
 Once you have written down the script, you can run it using
 Writing a simple NEPI expeiment script is easy.
 Take a look at the example in the FAQ section \ref{faq:ping_example}.
 Once you have written down the script, you can run it using

-Python. Note that since NEPI is not yet installed in your system,
+Python. If NEPI is not installed in your system,

 you will need to export the path to NEPI's source code to 
 the PYTHONPATH environment variable, so that Python can find
 NEPI's libraries.
 you will need to export the path to NEPI's source code to 
 the PYTHONPATH environment variable, so that Python can find
 NEPI's libraries.


@@ -166,7 +187,8 @@ NEPI's libraries.
 
 \begin{verbatim}
     $ export PYTHONPATH=<path-to-nepi>/src:$PYTHONPATH
 
 \begin{verbatim}
     $ export PYTHONPATH=<path-to-nepi>/src:$PYTHONPATH

-    $ python first-experiment.py 
+    $ cd <path-to-nepi> 
+    $ python examples/linux/ping.py -a localhost

 \end{verbatim}
 
 \endgroup
 \end{verbatim}
 
 \endgroup


@@ -186,9 +208,7 @@ You can easily install IPython on Debian, Ubuntu, Fedora or Mac as follows:\\
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}

-
-$ sudo apt-get install ipython
-
+    $ sudo apt-get install ipython

 \end{verbatim}
 
 \endgroup
 \end{verbatim}
 
 \endgroup


@@ -199,9 +219,7 @@ $ sudo apt-get install ipython
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}

-
-$ sudo yum install ipython
-
+    $ sudo yum install ipython

 \end{verbatim}
 
 \endgroup
 \end{verbatim}
 
 \endgroup


@@ -212,9 +230,7 @@ $ sudo yum install ipython
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}

-
-$ pip install ipython
-
+    $ pip install ipython

 \end{verbatim}
 
 \endgroup
 \end{verbatim}
 
 \endgroup


@@ -226,9 +242,7 @@ path to the PYTHONPATH environment variable
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}
     \fontsize{10pt}{12pt}\selectfont
 
 \begin{verbatim}

-
-$ export PYTHONPATH=$PYTHONPATH:/usr/local/lib/python:/usr/local/share/python/ipython
-
+    $ export PYTHONPATH=$PYTHONPATH:/usr/local/lib/python:/usr/local/share/python/ipython

 \end{verbatim}
 
 \endgroup
 \end{verbatim}
 
 \endgroup

diff --git a/doc/user_manual/user_manual.pdf b/doc/user_manual/user_manual.pdf
index f25fcf3..2019a51 100644 (file)
Binary files a/doc/user_manual/user_manual.pdf and b/doc/user_manual/user_manual.pdf differ