[certi-cvs] applications/PyHLA/doc PyHLA.tex

[certi-cvs]

CVSROOT:        /sources/certi
Module name:    applications
Changes by:     Petr Gotthard <gotthardp>       10/01/16 17:55:16

Modified files:
        PyHLA/doc      : PyHLA.tex 

Log message:
        Document PyHLA examples.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/applications/PyHLA/doc/PyHLA.tex?cvsroot=certi&r1=1.9&r2=1.10

Patches:
Index: PyHLA.tex
===================================================================
RCS file: /sources/certi/applications/PyHLA/doc/PyHLA.tex,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -b -r1.9 -r1.10
--- PyHLA.tex   12 Jul 2009 19:30:06 -0000      1.9
+++ PyHLA.tex   16 Jan 2010 17:55:15 -0000      1.10
@@ -101,7 +101,9 @@
 \item Many plug-ins providing scientific calculations, or geodetic conversions.
 \end{enumerate}
 
-\subsection{Installation Instructions}
+\subsection{Getting Started}
+
+\subsubsection{Installation Instructions}
 
 The \module{PyHLA} module requires
 \begin{itemize}
@@ -143,7 +145,7 @@
 make install
 \end{verbatim}
 
-\subsection{Building the PyHLA documentation}
+\subsubsection{Building the documentation}
 The \module{PyHLA} documentation may be find online at
 
\ulink{http://www.nongnu.org/certi/PyHLA/manual}{http://www.nongnu.org/certi/PyHLA/manual}
 however you may rebuild the documentation from the PyHLA source itself, in 
order
@@ -172,6 +174,25 @@
 The \texttt{msc.sty} step is optional and necessary only if you don't have
 \texttt{msc.sty} installed.
 
+\subsubsection{Examples}
+
+The \module{PyHLA} examples are stored in the 
\file{certi/applications/PyHLA/examples}
+directory.
+
+\paragraph{updateAttributeValues}
+The simplest \module{PyHLA} example. The
+\ulink{uav-send.py}{http://cvs.savannah.gnu.org/viewvc/applications/PyHLA/examples/updateAttributeValues/uav-send.py?root=certi&view=markup}
+joins a federation and periodically publishes dummy values. The transmitted 
attributes
+are described in
+\ulink{uav.fed}{http://cvs.savannah.gnu.org/viewvc/applications/PyHLA/examples/updateAttributeValues/uav.fed?root=certi&view=markup}.
+The
+\ulink{uav-receive.py}{http://cvs.savannah.gnu.org/viewvc/applications/PyHLA/examples/updateAttributeValues/uav-receive.py?root=certi&view=markup}
+joins the same federation and prints the received values.
+
+To start the example, copy \file{uav.fed} to respective RTIG directory, start 
RTIG
+and then run both \file{uav-send.py} and \file{uav-receive.py}.
+
+
 \subsection{Performance}
 
 Discuss the performance penalty. Use the DFSS/DMAIC methodology.
@@ -188,4 +209,4 @@
 \input{PyHLA.ind}
 \end{document}
 
-% $Id: PyHLA.tex,v 1.9 2009/07/12 19:30:06 gotthardp Exp $
+% $Id: PyHLA.tex,v 1.10 2010/01/16 17:55:15 gotthardp Exp $