README.txt 4.19 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
-----------------------------------------
1) Folders and files description
-----------------------------------------

This directory contains different targets for OpenAirInterface.org implementations

ARCH/EXMIMO - Kernel driver for EXMIMO1+2 
RTAI/USER   - Target to run .11p (uses openairITS) or LTE modem (uses openair1 and openair2) for x86 in RTAI user-space
SIMU    - Simulator/Emulator target for x86
DOCS    - Doxygen documentation generation for openair1/openair2


First, you must have all four openair SW directories, openair1, openair2, openair3, and targets at the same hierarchical level as this directory.

1. The following packages must be available on your system:

        - libblas and libblas-dev
18 19
	- libconfig++8-dev
	- libgtk-3-dev
20
        - libxml2 and libxml2-dev and gccxml
21
        - libforms-bin libforms-dev
22
	- nettle-dev nettle-bin openssl
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
	- libatlas-base-dev and libatlas-headers (for Ubuntu 11.04, libatlas-dev instead of libatlas-headers)
        - asn1c and the LTE ASN1 files (for more information on how to install this and generate the required files see the README file in openair2/RRC/LITE/MESSAGES) 

Makefile - This Makefile does basic checks of the code to verify that everything is properly installed, just run make to see what your options are.

----------------------------------------------------
2) Organization of the folders and their dependancies
----------------------------------------------------
The 3 folders have the following structures
   
    - EXAMPLES: there you can find some basic examples with/without the network interface
    - KERN: this folder includes the files for kernel space compilation targeting realtime operation (RF/emulation platform)
    - USER: this folder includes the files for user space compilation targeting soft realtime operation (emulation/simulation/debugging)

----------------------------------------------------------------
3)  How to use through a tutorial: run a simple experimentation
----------------------------------------------------------------
1. Up to know you should have creted a directory: mkdir openair4G

2. Check out the openair4G/trunk repository:  svn co https://svn.eurecom.fr/openairsvn/openair4G/trunk openair4G

3. Now, please check the following:
   
   - the env variables in .bashrc the following lines, and source them if necessaary :
    set OPENAIR_HOME variable and export the following:
    export OPENAIR1_DIR=$OPENAIR_HOME/openair4G/openair1
    export OPENAIR2_DIR=$OPENAIR_HOME/openair4G/openair2
    export OPENAIR3_DIR=$OPENAIR_HOME/openair4G/openair3
    export OPENAIRITS_DIR=$OPENAIR_HOME/openair4G/openairITS
    export OPENAIR_TARGETS=$OPENAIR_HOME/openair4G/targets/
    
   - checkout and compile the asn1 messages 
     follow the README.txt in OPENAIR2_DIR/RRC/LITE/MESSAGES to checkou the ASN.1 RRC messages
     follow the OPENAIR2_DIR/RRC/LITE/MESSAGE/asn1c/asn1c/INSTALL to install the asn1c
     go back to $OPENAIR_TARGET and "make install" if you have not used the shell script to install asn1c 
nikaeinn's avatar
nikaeinn committed
58
   - cd $OPENAIR_TARGET/SIMU/USER, and make a sanity check by doing make pre-ci (require 15 minutes)
59 60 61 62 63 64 65 66 67
   - Check out simple examples in $OPENAIR_TARGET/SIMU/EXAMPLES 

4. to automatically bring up the oai interfaces and configure the default radio beares (usefull when sending data traffic):
   - add your username into the list of sudoers
     + edit /etc/sudoers as a super user 
     + after the line: # User privilege specification, add : user_name   ALL=(ALL:ALL) ALL
     + after the line: %admin ALL=(ALL) ALL,           add : user_name   ALL=(ALL) NOPASSWD: ALL
   - include this line: alias sudo='sudo -E', to the .bashrc 
   - run oai as follows: sudo ./oaisim arg1 arg2 ....
68 69 70 71 72 73 74 75 76 77 78 79 80 81


----------------------------------------------------------------
4)  Detail Instructions
----------------------------------------------------------------

	Please follow the instructions given in DOCS/oaisim_walkthrough.pdf


----------------------------------------------------------------
5) OAI on virtual machine  
----------------------------------------------------------------
	you may download the image using this URL: https://emu.openairinterface.org/openairlab/openairlab.zip
	chekc that all the packges are there as some packages might be added later.