root/documentation/ossie/user-guide-0.8.2/Installation.tex @ 10745

Revision 10745, 26.5 KB (checked in by Snyder.Jason, 2 years ago)

changed a few references from 0.8.1 to 0.8.2 and added instructions for ubuntu > 10.04

Line 
1% ------------------------------------------------------------------
2%
3%   TITLE: OSSIE 0.8.2 Installation Guide
4% AUTHORS: Mike Ekoniak, Matt Carrick, Drew Cormier, Christopher Covington,
5%          Carl B. Dietrich, Joseph Gaeddert, Benjamin Hilburn,
6%          C. Ian Phelps, Shereef Sayed, Jason Snyder, Haris Volos
7% CREATED:
8% REVISED:
9% 23Mar11 IB Minor typo fixes.
10%     URL: http://ossie.wireless.vt.edu/
11%
12% ------------------------------------------------------------------
13
14\newpage
15\section{Installation}
16\label{section:installation}
17For users that do not have access to a Linux system, or are unfamiliar with Linux, we recommend
18that you use our pre-built VMWare images.  These images have OSSIE pre-installed on them, and are
19ready to use out-of-the-box. Using an OSSIE VMware image is described in
20Section~\ref{section:installation:vmware}.
21
22% NOTE: We lack yum install at the moment
23
24% For most users on Fedora systems, installing OSSIE and its dependencies via yum is the best
25% route.  The only reason not to install via yum is if you plan on doing active
26% development \emph{on} OSSIE, and need access to the source code.  Note that this
27% does not include application/waveform developers who are developing \emph{with}
28% OSSIE, as they do not need access to the OSSIE source code.
29
30Although we do not yet provide and support binary installation packages for more Linux
31distributions, compiling OSSIE from source on them should be possible.
32
33To install OSSIE from source, follow the below instructions to install the OSSIE dependencies,
34and then compile and install the source code.
35
36% \subsection{Installing OSSIE via Yum}
37% \label{section:installation:yum}
38
39% Note:  At the time this guide was compiled, the latest version of OSSIE available by Yum was 0.7.0.  Version 0.7.1 is expected to be available by Yum in late 2008 or early 2009.
40
41% \subsubsection{Add OSSIE Repository to Yum}
42% \label{section:installation:yum:ossierepo}
43% In order to install OSSIE via the YUM repository, you must first edit your `/etc/yum.conf' to
44% add the OSSIE repository to the YUM search list. In this example, we use {\tt nano}, but you may use
45% whatever editor you wish ({\tt vim}, {\tt emacs}, etc). Unless your nanorc has already been configured to not
46% wrap lines, the `-w' flag is necessary to prevent {\tt nano} from adding line breaks to the file.
47% \begin{lstlisting}[]
48% $ su -
49% # nano -w /etc/yum.conf
50% \end{lstlisting}
51% Add the following lines at the bottom of the file:
52% \begin{lstlisting}[]
53% [ossie-vt]
54% name = OSSIE-VT
55% baseurl=http://ossie.wireless.vt.edu/yum/ossie-vt/
56% gpgcheck=0
57% \end{lstlisting}
58% Now update your system. This will refresh your yum package cache.  It is also always smart to have
59% a fully updated system before installing new software anyways.
60% \begin{lstlisting}[]
61% # yum update
62% \end{lstlisting}
63%
64% \subsubsection{Install OSSIE}
65% \label{section:installation:yum:installviayum}
66% Now install OSSIE and its dependencies via yum by typing:
67% \begin{lstlisting}[]
68% # yum install ossie
69% # exit
70% \end{lstlisting}
71
72% Congratulations!  You should now have a fully-operable OSSIE installation.
73
74\subsection{Installing OSSIE from Source}
75\label{section:installation:source}
76
77\subsubsection{Notes on OSSIE Installation from Source}
78\label{section:installation:source:notesonsource}
79This section assumes that the user is familiar with basic
80Linux commands such as {\tt cd} and {\tt ls}.
81Commands run with root permissions are prefixed with {\tt \#}, while others
82are prefixed with {\tt \$}.
83
84OSSIE depends on the following software packages:
85\begin{itemize}
86\item Boost - a C++ library of common mechanisms
87\item omniORB - a CORBA implementation
88\item omniORBpy - a Python interface for omniORB, necessary for the OSSIE tools and components
89\item wxPython - a Python interface for the wxWidgets graphical library, used by the OSSIE tools
90\item numpy - a Python numerical library used by the OSSIE tools
91\end{itemize}
92
93If you have an older version of OSSIE installed, then you will need to delete the contents of {\tt /sdr/}.
94\begin{lstlisting}[]
95 $ rm -rf /sdr/*
96\end{lstlisting}
97
98% OSSIE \ossieversion\  is packaged with a convenient Python script called {\tt build.py} to automatically
99% configure and build the packages necessary for the framework, tools, and other
100% libraries. Use of this script is not mandatory, and you can manually compile and install all/part of
101% OSSIE as you wish.
102
103\subsubsection{Installing Dependencies on Fedora}
104\label{section:installation:source:dependencies:fedora}
105 On Fedora systems, the dependencies can be installed via {\tt yum}.
106%
107% First, add the OSSIE yum repository to your yum.conf.  This is described in
108% Section~\ref{section:installation:yum:ossierepo}
109%
110This is the entire dependency list, so some of these packages may already be installed.
111\begin{lstlisting}[]
112# yum -y install wxPython wxPython-devel numpy \
113rpm-build cabextract glibc-devel \
114python-devel openssl-devel gcc gcc-c++ libtool
115\end{lstlisting}
116
117When installing OSSIE on Fedora, we recommend installing omniORB and omniORBpy
118from source. This should only be done for Fedora however. If installing on
119Ubuntu, follow the directions in
120section~\ref{section:installation:dependencies:ubuntu}.
121\begin{lstlisting}[]
122$ wget http://omniorb.sourceforge.net/releases/omniORB-4.1.4.tar.gz
123$ wget http://omniorb.sourceforge.net/releases/omniORBpy-3.4.tar.gz
124$ tar -xvf omniORB-4.1.4.tar.gz $ tar -xvf omniORBpy-3.4.tar.gz
125$ cd omniORB-4.1.4/
126$ mkdir build
127$ cd build
128$ ../configure
129$ make
130$ sudo make install
131$ cd ../../omniORBpy-3.4/
132$ mkdir build
133$ cd build
134$ ../configure
135$ make
136$ sudo make install
137\end{lstlisting}
138
139If you plan on using GNURadio 3.2 or higher, or the USRP2, as part of your work, then you will need to install Boost v1.35 or higher.
140Currently, Fedora and Ubuntu do not ship with this version, so you will need to install it.
141Whether you are using Fedora or Ubuntu, we recommend that you install Boost from source. Download Boost from
142\href{http://sourceforge.net/projects/boost/files/boost/1.37.0/boost\_1\_37\_0.tar.bz2/download}{http://sourceforge.net/projects/boost/} and unpack {\tt boost\_1\_37\_0.tar.bz2}.
143\begin{lstlisting}[]
144 $ wget http://sourceforge.net/projects/boost/files/boost/1.37.0/ \
145       boost_1_37_0.tar.bz2/download
146 $ tar -xvf boost_1_37_0.tar.bz2
147 $ cd boost_1_37_0/
148 $ ./configure --prefix=/usr/
149 $ make
150 $ sudo make install
151\end{lstlisting}
152
153If you are using Fedora Core 10 or higher, you will need to download the RPM for the SDL library in order to user the JPEGVideoViewer component.
154\begin{lstlisting}[]
155 $ wget http://www.libsdl.org/release/SDL-devel-1.2.13-1.i386.rpm
156 $ rpm -Ui SDL-devel-1.2.13-1.i386.rpm
157\end{lstlisting}
158%
159% Now move onto Section~\ref{section:installation:source:dependencies:gnuradio}
160%
161\subsubsection{Installing Dependencies on Ubuntu up to version 10.04}
162\label{section:installation:dependencies:ubuntu}
163
164This is the entire dependency list, so some of these packages may already be installed.
165Install all of the following packages:
166\begin{lstlisting}[]
167$ sudo aptitude install gcc build-essential
168$ sudo aptitude -y install omniorb4 libomniorb4-dev omniidl4-python \
169omniorb4-nameserver python-omniorb2 libgtk2.0-dev freeglut3-dev \
170python-wxgtk2.8 python-wxversion python-wxtools python-numpy \
171python-numpy-ext python-numpy-dev python-profiler g++ automake \
172libtool subversion python-dev fftw3-dev libcppunit-dev libboost-dev sdcc \
173libusb-dev libasound2-dev libsdl1.2-dev guile-1.8 libqt3-mt-dev swig \
174python-profiler automake1.9 python2.6-dev sdcc-libraries guile-1.8-dev \
175libqt4-dev ccache python-opengl libgsl0-dev python-lxml \
176doxygen qt4-dev-tools libqwt5-qt4-dev libqwtplot3d-qt4-dev \
177libboost-filesystem-dev libboost-system-dev libboost-thread-dev \
178libboost-program-options-dev
179\end{lstlisting}
180
181\subsubsection{Installing Dependencies on Ubuntu 10.10 and up}
182A few of the dependencies changed with Ubuntu 10.10, specifically omniidl4-python is now omniid-python, and python-omniorb2 is now python-omniorb. The updated dependency list is below.
183\begin{lstlisting}[]
184$ sudo aptitude install gcc build-essential
185$ sudo aptitude -y install omniorb4 libomniorb4-dev omniidl-python \
186omniorb4-nameserver python-omniorb libgtk2.0-dev freeglut3-dev \
187python-wxgtk2.8 python-wxversion python-wxtools python-numpy \
188python-numpy-ext python-numpy-dev python-profiler g++ automake \
189libtool subversion python-dev fftw3-dev libcppunit-dev libboost-dev sdcc \
190libusb-dev libasound2-dev libsdl1.2-dev guile-1.8 libqt3-mt-dev swig \
191python-profiler automake1.9 python2.6-dev sdcc-libraries guile-1.8-dev \
192libqt4-dev ccache python-opengl libgsl0-dev python-lxml \
193doxygen qt4-dev-tools libqwt5-qt4-dev libqwtplot3d-qt4-dev \
194libboost-filesystem-dev libboost-system-dev libboost-thread-dev \
195libboost-program-options-dev
196\end{lstlisting}
197
198
199\subsubsection{Configure omniORB}
200\label{section:installation:source:dependencies:configomni}
201omniORB must be configured through the modification of a file. This file may be either \\
202{\tt /etc/omniORB.cfg} or {\tt /etc/omniORB4.cfg}, depending on the
203version of the omniORB dependency. If the file is not found, copy
204{\tt sample.cfg} from the omniORB-4.1.4 directory and rename it.
205\begin{lstlisting}[]
206 $ cd omniORB-4.1.4
207 # cp sample.cfg /etc/
208 # mv /etc/sample.cfg /etc/omniORB.cfg
209\end{lstlisting}
210Open the file as root, and search for the following line:
211\begin{lstlisting}[]
212 InitRef = NameService=corbaname::my.host.name
213\end{lstlisting}
214Uncomment the line by deleting the pound or hash character `\#' and change
215it to:
216\begin{lstlisting}[]
217 InitRef = NameService=corbaname::127.0.0.1
218\end{lstlisting}
219Before running the framework you will need to start the naming service. If you
220installed omniORB from source, you have to follow the instructions in
221Appendix~\ref{appendix:omninamessh}. When installing from yum
222{\tt omniNames} will automatically start when you restart your machine. Refer
223to Appendix~\ref{appendix:services} for instructions on how to start the
224omniNames service without restarting your machine or set whether the service
225starts automatically at boot.
226\footnote{You may also manually start a source-compiled tarball package of
227omniNames {\tt omniNames} with the script described in
228Appendix~\ref{appendix:omninamessh}}
229
230At this time it is a good idea to restart your machine.
231
232\subsubsection{Installing Portions of GNU Radio}
233\label{section:installation:source:dependencies:gnuradio}
234OSSIE uses a small subset of GNU Radio to communicate with and configure the USRP. The
235following steps will walk through installing portions of GNU Radio. OSSIE provides support
236for both the USRP and USRP2. If you would like to use the USRP2, then you will need to
237install GNURadio v3.2; otherwise, GNURadio v3.1 will work fine.
238
239First, we must install the GNU Radio firmware that can communicate with the USRP.
240
241If you are using Fedora 11, or Fedora 10 or lower and would like to use GNURadio v3.1, then:
242\begin{lstlisting}[]
243 # yum install gnuradio-devel usrp-devel
244\end{lstlisting}
245
246If you are using Ubuntu, and would like to use GNURadio v3.1 then:
247\begin{lstlisting}[]
248 $ sudo aptitude install libusrp0 libusrp-dev
249\end{lstlisting}
250
251If you would like to use GNURadio v3.2, and do not have Fedora 11 installed,
252then you must install from source:
253\begin{lstlisting}[]
254 $ wget ftp://ftp.gnu.org/gnu/gnuradio/gnuradio-3.2.2.tar.gz
255 $ tar -xvf gnuradio-3.2.2.tar.gz
256 $ cd gnuradio-3.2.2/
257 $ ./configure
258 $ make
259 $ sudo make install
260\end{lstlisting}
261
262% First, GNU Radio's dependencies must be installed. If you are using Ubuntu and followed
263% the instructions for installing the dependencies, skip down to checking out the source
264% code from the GNU Radio Subversion repository. If you are installing on Fedora 9,
265% proceed with the following directions.
266
267% Install the Engineering and Scientific packages as well as the Software Development
268% packages as root entering the command:
269
270% \begin{lstlisting}[]
271%  # yum groupinstall "Engineering and Scientific" "Development Tools"
272% \end{lstlisting}
273
274% Additional utilities such as the FFT library and the CPP Test Framework must also be
275% installed. As root, enter the following command
276
277% \begin{lstlisting}[]
278%  # yum install fftw-devel cppunit-devel wxPython-devel libusb-devel  \
279%    guile boost-devel alsa-lib-devel numpy
280% \end{lstlisting}
281
282% The Small Device C Compiler, SDCC, must be installed:
283
284% \begin{lstlisting}[]
285%  # yum install sdcc
286% \end{lstlisting}
287
288% The path for the SDCC must be set. Open the .bashrc file and add the path to the end
289% of the file. To open the file, enter the command:
290
291% \begin{lstlisting}[]
292%  $ vim ~/.bashrc
293% \end{lstlisting}
294
295% Add the following path to the end of the file:
296% \begin{lstlisting}[]
297%  export PATH=/usr/libexec/sdcc:$PATH
298% \end{lstlisting}
299
300% At this point, all of the GNU Radio dependencies have been installed. Now, the GNU Radio
301% software must be installed.
302
303% Download the GNU Radio source code by entering the command:
304% \begin{lstlisting}[]
305%  $ svn co http://gnuradio.org/svn/gnuradio/branches/releases/3.1 gnuradio
306% \end{lstlisting}
307
308% Move into the {\tt gnuradio} directory and start building the source code by entering the
309% following commands:
310
311% \begin{lstlisting}[]
312%  $ cd gnuradio/
313%  $ ./bootstrap
314%  $ ./configure --disable-all-components --enable-gnuradio-core \
315%    --enable-usrp --enable-gr-usrp --enable-omnithread
316% \end{lstlisting}
317
318% This sets up the install to only build resources for the USRP which OSSIE requires.
319% Compile the source code by entering the command:
320
321% \begin{lstlisting}[]
322%  $ make
323% \end{lstlisting}
324
325% Verify that the compile worked by running a check:
326
327% \begin{lstlisting}[]
328%  $ make check
329% \end{lstlisting}
330
331% Install the portions of GNU Radio by running the following command as root:
332
333% \begin{lstlisting}[]
334%  # make install
335% \end{lstlisting} 
336
337% The libraries installed by GNU Radio need to be linked:
338
339% \begin{lstlisting}[]
340%  # /sbin/ldconfig
341% \end{lstlisting}
342
343At this point, GNU Radio and its dependencies have been installed. Now setup the
344proper permissions for the USRP. As root, create a group which will have access
345to the USRP:
346
347\begin{lstlisting}[]
348 # /usr/sbin/groupadd usrp
349\end{lstlisting}
350
351Add users to the group which need access to the USRP:
352
353\begin{lstlisting}[]
354 # /usr/sbin/usermod -G usrp -a USERNAME
355\end{lstlisting}
356
357Now that users will have access to the USRP, read and write access to the device
358must be created. As root, create the file {\tt /etc/udev/rules.d/10-usrp.rules} in
359a text editor:
360
361in Fedora,
362\begin{lstlisting}[]
363 # vim /etc/udev/rules.d/10-usrp.rules
364\end{lstlisting}
365
366Some distributions such as Ubuntu do not have vim installed by default. If that is the case, use vi instead.
367
368Add the following text to the file:
369
370\begin{lstlisting}[]
371 ACTION=="add", BUS=="usb", SYSFS{idVendor}=="fffe", \
372 SYSFS{idProduct}=="0002", GROUP:="usrp", MODE:="0660"
373\end{lstlisting}
374
375The text above is displayed on two lines due to the contraints on page size, however
376the text must appear on a single line, without the backslash, in the file for the
377access to the USRP to work properly. You may also add the following comment lines to
378the file for future reference:
379
380\begin{lstlisting}[]
381 # rule to grant read/write access on USRP to group named usrp.
382 # to use, install this file in /etc/udev/rules.d/ as
383 # 10-usrp.rules
384\end{lstlisting}
385
386The USRP interface has now been created. As an optional test, connect the USRP
387to the computer and run the following command:
388
389\begin{lstlisting}[]
390 $ ls -lR /dev/bus/usb
391\end{lstlisting}
392
393The users root and usrp should now be listed under the user groups.
394
395If you are using the USRP2, it is necessary to have a gigabit ethernet interface and
396intruct the kernel to allow raw socket access to the ethernet port:
397\begin{lstlisting}[]
398 # chmod u+s /usr/local/bin/usrp2_socket_opener
399\end{lstlisting}
400
401This step is necessary every time you reinstall GNU Radio.
402
403
404\subsubsection{Install OSSIE}
405\label{section:installation:source:ossiecf}
406You are now ready to build and install OSSIE. 
407Note that installing by hand requires some knowledge of OSSIE, Linux, and software development.
408
409Download the latest tarball from
410\href{http://ossie.wireless.vt.edu/download/tarballs/\ossieversion/}{http://ossie.wireless.vt.edu/download/tarballs/\ossieversion/}
411\\ and unpack {\tt ossie-\ossieversion.tar.gz}.
412\begin{lstlisting}[]
413 $ wget http://ossie.wireless.vt.edu/download/tarballs/0.8.2/ \
414   ossie-0.8.2.tar.gz
415 $ tar -xvf ossie-0.8.2.tar.gz
416\end{lstlisting}
417
418By default, the installation directory of the OSSIE platform is {\tt /sdr}. In order to install new
419source code and binaries into this directory without root permissions, you need to create and change
420the ownership of {\tt /sdr}.
421\begin{lstlisting}[]
422 # sudo mkdir /sdr
423 # chown -R username.username /sdr
424\end{lstlisting}
425where {\tt username} is your user name.
426
427\subsubsection{Using Autoconf}
428\label{section:installation:source:ossiecf:autoconf}
429
430\begin{lstlisting}[]
431 $ cd ossie-0.8.2
432 $ ./configure --prefix=/sdr --libdir=/usr/local/lib/ \
433   --includedir=/usr/local/include/ --with-boost --with-boost-filesystem
434 $ make
435 $ sudo make install
436\end{lstlisting}
437
438If you prefer, or require, a different root directory, then change the '--prefix' flag to your appropriate absolute path.
439If you require the OSSIE libraries to be installed to a different location, then change the '--libdir' flag to your appropriate absolute path.
440For further 'configure' options, use {\tt configure --help}.
441
442If configure fails, use {\tt aptitude search <dependency name>}
443
444%\subsubsection{Using Installation Scripts}
445%\label{section:installation:source:ossiecf:buildpy}
446
447%The included {\tt build.py} and {\tt setup.py} scripts automate the building and installation of
448%the OSSIE packages. Because OSSIE is built as a set of dependent libraries it is
449%necessary to build and install each one separately so that
450%they can link properly. These scripts take care of that for you.
451
452%In order for the script to run uninterrupted, the {\tt sudo} command must be
453%able to execute {\tt make install}.
454%As root, edit the {\tt sudoers} file\footnote{By default the sudoers file must
455%be edited with the {\tt visudo} command}
456%\begin{lstlisting}[]
457% # /usr/sbin/visudo
458%\end{lstlisting}
459
460%At the end of the file, add the following line:
461%\begin{lstlisting}[]
462% ALL ALL = NOPASSWD: /usr/bin/make install
463%\end{lstlisting}
464
465%Save and quit ({\tt :wq}).  If you made an error, visudo will tell you. We
466%recommend that you comment this line out by putting a pound character (`\#') in
467%front of it once you have finished installing OSSIE.
468%%TODO: Have a more secure (wheel group only?) method
469
470%The {\tt setup.py} script installs the tools used for component and waveform development. To install the tools, move into the {\tt tools} directory and run the {\tt setup.py} script as follows \\(optionally, use {\tt su -c "<command>"} instead of {\tt sudo <command>}):
471
472%\begin{lstlisting}[]
473% $ cd /home/username/path_to_ossie/tools
474% $ python setup.py build && sudo python setup.py install
475%\end{lstlisting}
476
477%The {\tt build.py} script installs the core framework, components, devices and a few demonstration waveforms. This script should not be run as root.
478%To install, first exit out of root, then move into the directory where the OSSIE \ossieversion\ tarball has been unpacked and run the script:
479
480%\begin{lstlisting}[]
481% # exit
482% $ cd /home/username/path_to_ossie/
483% $ python build.py
484%\end{lstlisting}
485
486%Depending on the speed of your system this might take several minutes. You may
487%be asked for a password during the first {\tt make install} command. Because we
488%are using {\tt sudo}, this prompt is asking for your user password, not the
489%root password. If successful, the prompt should say:
490%\begin{lstlisting}[]
491%*********************************************************
492
493%  Complete installation of OSSIE 0.8.2 finished!
494
495%*********************************************************
496%\end{lstlisting}
497
498\subsubsection{Updating System Libraries}
499\label{section:installation:source:ossiecf:ldconfig}
500Once the OSSIE libraries are installed, they need to be linked.
501As root edit the file {\tt /etc/ld.so.conf}, adding the line
502\begin{lstlisting}[]
503 /usr/local/lib
504\end{lstlisting}
505Now run:
506\begin{lstlisting}[]
507 # /sbin/ldconfig
508\end{lstlisting}
509
510OSSIE should now be successfully installed on your system. You can skip to
511Section~\ref{section:runningwaveforms} to learn how to run waveforms.
512
513\subsection{Installation of OSSIE Eclipse Feature}
514\label{section:installation:alloefinstall}
515Installation of the OSSIE Eclipse Feature (OEF) requires the installation of OSSIE, Java, and Eclipse.
516
517\subsubsection{Installing Java}
518\label{section:installation:javainstall}
519Eclipse is written in Java, so you must have it installed to run Eclipse and OEF.
520We recommend using Sun's Java Development Kit. As of this writing, the GNU Compiler for Java (GCJ) will not work.
521
522Fedora Core 9 comes with the Sun JDK pre-installed but older versions require manual installation. On other distributions it is advisable to use the
523package manager to manage the installation, if possible.
524
525\subsubsection{Installing Java on Older Versions of Fedora}
526\label{section:installation:javafedora}
527Go to \href{http://java.sun.com/javase/downloads/index.jsp}{http://java.sun.com/javase/downloads/index.jsp}
528and click Download next to JDK 6 Update 6. Choose Linux in the platform drop down menu, click the check-box
529agreeing to the license agreement, and click continue. Download the Linux rpm in self extracting file,
530{\tt jdk-6u6-linux-i586-rpm.bin}.
531
532Open a terminal and navigate to the file. As root, execute the following command:
533\begin{lstlisting}[]
534 # sh jdk-u6-linux-i586-rpm.bin
535\end{lstlisting}
536
537Create {\tt java.sh} in {\tt /etc/profile.d/} with the following contents:
538\begin{lstlisting}[]
539 export JAVA_HOME="/usr/java/latest"
540 export JAVA_PATH="$JAVA_HOME"
541 export PATH="$PATH:$JAVA_HOME/bin"
542\end{lstlisting}
543
544Log out and back in to allow the changes to update.
545
546\subsubsection{Installing Java on Ubuntu}
547\label{section:installation:javaubuntu}
548
549Open /etc/apt/sources.list in an editor and add the following lines to the end of the file:
550\begin{lstlisting}[]
551 deb http://archive.canonical.com/ubuntu lucid partner
552 deb-src http://archive.canonical.com/ubuntu lucid partner
553\end{lstlisting}
554
555In a terminal, enter the following lines:
556\begin{lstlisting}[]
557 $ sudo apt-get update
558 $ sudo apt-get install sun-java6-jdk
559\end{lstlisting}
560
561\subsubsection{Installing Eclipse}
562\label{section:installation:eclipseinstall}
563Install the Eclipse IDE for Java Developers. Go to the \href{http://www.eclipse.org/downloads/}{Eclipse Download Center} and download an Eclipse distribution for your platform.
564
565Eclipse is distributed as a tarball archive that you can unpack to location of your choice. Pick a location that is appropriate for your platform and
566simply unpack the contents. There is no self-installer, just unpack the distribution. Do not install Eclipse in a directory that has spaces anywhere
567in its full path name.
568
569\subsubsection{Installing OEF}
570\label{section:installation:oefinstall}
571Now that the dependencies have been installed, OEF can be installed.
572
573Move into the unpacked eclipse directory, and start eclipse:
574\begin{lstlisting}[]
575$ cd /path/to/eclipse
576$ ./eclipse
577\end{lstlisting}
578
579After Eclipse starts, on the toolbar select {\tt Help}, {\tt Install New Software}.
580In the new window, select the ``Work with'' textbox and enter the URL: {\tt http://ossie.wireless.vt.edu/eclipse/}
581and select Add. Give a name, e.g., ``OEF''.
582
583The window will then add the URL, OSSIE, OSSIE Waveform Developer
584Feature to the list of available software. Place a check in the box next to OSSIE
585Waveform Developer Feature and click Next. Eclipse will show a window with more details, select Finish to complete the installation process.
586
587%Eclipse will bring up a window which will
588%resolve any dependencies and then start the install guide.
589
590%When the install window opens, make sure OSSIE Waveform Developer Feature is selected and click Next.
591
592%Accept the GNU license agreement and select Next. Eclipse will then begin to download the necessary files, which may take a few minutes.
593Allow Eclipse to restart when it prompts to do so. After it restarts, the OSSIE Eclipse Feature will be installed.
594
595Select the OSSIE perspective within Eclipse. On the toolbar, select {\tt Window},
596{\tt Open Perspective}, {\tt Other}. In the new window, select OSSIE which will then
597open the OSSIE perspective. On the toolbar, select {\tt File}, {\tt New}, {\tt OSSIE Waveform},
598or {\tt OSSIE Component} to start developing.
599
600These same instructions used for installing OEF can be used later to update it to newer versions.
601
602\subsection{Using a VMware Image on Any Platform}
603\label{section:installation:vmware}
604A VMware image of a complete Fedora Core 9-based Linux system with all necessary
605dependencies and a complete install of OSSIE \ossieversion\ is available at \\
606\href{http://ossie.wireless.vt.edu/trac/wiki/Downloads}{http://ossie.wireless.vt.edu/trac/wiki/Downloads}.
607All that is needed to run the virtual image is the VM­Ware Player, available
608for no fee from \\
609\href{http://www.vmware.com/download/player/}{http://www.vmware.com/download/player/}.
610Versions of the player are available for both Windows and Linux.
611
612Install VMware Player on your system, unzip the virtual image and open it.
613For full instructions on installing and using VMware player, please
614consult the VMWare Player User Guide~\cite{vmware:web}.
615
616It is recommended that you keep a copy of the zipped virtual image so that you do
617not need to download the image a second time to start with a fresh copy. Changes
618that you make from within the image will alter it, and in the event of drastic
619unwanted changes, starting afresh is easy if you have an extra copy of the image
620on your hard drive.
621
622% \subsection{Via Ebuild on Gentoo Linux}
623% Support for installation via Gentoo's Portage package management system has not
624% yet been thoroughly tested but ebuilds do exist.
625%
626% To access the ebuilds, install and configure layman if you haven't already:
627% \begin{figure}
628% \begin{lstlisting}[]
629% # emerge layman
630% # echo "source /usr/portage/local/layman/make.conf" >> /etc/make.conf
631% \end{lstlisting}
632% \end{figure}
633%
634% Then, add ossie-overlay to your locally-stored overlays:
635% \begin{figure}
636% \begin{lstlisting}[]
637% # layman -a -o https://ossie.wireless.vt.edu/repos/ossie/experimental/scripts/gentoo/ossie-overlay.xml
638% \end{lstlisting}
639% \end{figure}
640%
641% You can then proceed with installing OSSIE:
642% \begin{figure}
643% \begin{lstlisting}[]
644% # emerge -av ossie
645% \end{lstlisting}
646% \end{figure}
647%
648% After sucessful compiliation of the OSSIE framework and its dependencies, skip
649% to section X.
650
651%\subsection{Embedded Platforms}
652%While installation on embedded platforms is not officially supported in the
653%0.6.2 release, work has been done (MENTION WORK) on porting OSSIE to embedded
654%platforms and we are interested in promoting more work in this area.
655
656
Note: See TracBrowser for help on using the browser.