Changes between Version 30 and Version 31 of WARPLab/QuickStart


Ignore:
Timestamp:
Aug 22, 2013, 11:51:05 PM (11 years ago)
Author:
welsh
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WARPLab/QuickStart

    v30 v31  
    11[[TracNav(WARPLab/TOC)]]
    22
    3 = Quick Start =
     3= WARPLab Quick Start =
    44
    55== System Requirements ==
    66 * Review the [wiki:../Requirements WARPLab 7 System Requirements]
    77 * Review the [wiki:../../GettingStarted Getting Started Guide] for hardware basics
     8 * Review the [wiki:../MEX WARPLab Mex Compilation Guide] for additional WARPLab features
    89[[br]]
    910== Setting up the WARPLab 7 Framework ==
     
    53541. The [wiki:../Reference/Utility#wl_cmd_doc wl_cmd_doc] is a function that will display documentation for a particular command.
    54551. The WARP forums ([http://warpproject.org/forums/]) are a great place to ask questions.
    55 [[br]]
    56 == Additional Tools ==
    57 
    58 === WARPLab MEX UDP Transport (WARPLab 7.3.0 and later)===
    59 
    60 By default, WARPLab will use built-in java routines for performing network I/O.  However, this has some performance limitations as can be seen by our Read IQ / Write IQ [http://warpproject.org/trac/wiki/WARPLab/Benchmarks benchmarks].  Therefore, we have developed a custom WARPLab MEX UDP transport in order to provide a high performance transport for data transfer operations.  The WARPLab MEX UDP transport can provide dramatically faster performance while leaving the usage of WARPLab otherwise identical.
    61 
    62 To install the WARPLab MEX UDP Transport, please perform the following steps:
    63 
    64 NOTE: Make sure your repository is updated to the WARPLab 7.3.0 (or later) release.  The repository contains a compiled binary for Windows 7 64-bit.  For other platforms, compile the wl_mex_udp_transport mex function (see [wiki:/howto/MEX_Compile How-To Compile MEX] for more information).
    65 
    66   1. Locate the WARPLab MEX UDP Transport source in one of the following locations:
    67     1. {{{<Your Installed WARP Repository Directory>\PlatformSupport\wl_mex_udp_transport}}}
    68     1. [source:/PlatformSupport/wl_mex_udp_transport /PlatformSupport/wl_mex_udp_transport]
    69     1. {{{svn co http://warpproject.org/svn/WARP/PlatformSupport/wl_mex_udp_transport}}}
    70   1. Add the wl_mex_udp_transport folder to your MATLAB path. The wl_mex_udp_transport folder should contain wl_mex_udp_transport.m and the wl_mex_udp_transport.mex binary (i.e. wl_mex_udp_transport.mexw64)
    71 {{{
    72 addpath('<wl_mex_udp_transport folder>');
    73 }}}
    74   1. Verify wl_mex_udp_transport is recognized by running {{{wl_mex_udp_transport('version');}}} on the MATLAB command line. The output should print the version number.  For example:
    75 {{{
    76 >> wl_mex_udp_transport('version');
    77 Loaded wl_mex_udp_transport version 1.0.0a
    78 WARPLab MEX UDP Transport v1.0.0a (compiled Aug 21 2013 09:46:30)
    79 Copyright 2013, Mango Communications. All rights reserved.
    80 Distributed under the WARP license:  http://warpproject.org/license 
    81 }}}
    82   1. Re-run the [wiki:../Reference/Utility#wl_setup 'wl_setup'] function in {{{M_Code_Reference}}}. One prompt will be to select which type of transport you want to use. If you have added a compatible, compiled wl_mex_udp_transport to your path, the script will list it as an option you can select. 
    83 
    84 NOTE: simply re-running 'wl_setup' and selecting java is sufficient for switching back to the built-in java routines. You do not need to explicitly remove wl_mex_udp_transport from your MATLAB path.
    85 
    86 [[br]]
    87 
    88 
    89 == Other Information ==
    90 
    91 === pnet Toolbox ===
    92 
    93 '''NOTE:  The PNET toolbox will not be supported in WARPLab 7.4.0 or later.'''
    94 
    95 By default, WARPLab will use built-in java routines for performing network I/O. pnet, a custom UDP mex toolbox for matlab, is also supported, but the latest version is required. pnet can offer modestly higher performance than the built-in java routines, but the usage of WARPLab is otherwise identical. Note: these performance gains are negligible for jumbo frame packets near 9000 bytes on length. If you want to use pnet, please perform the following steps:
    96  1. Install the updated pnet IP/UDP toolbox for MATLAB
    97   1. Checkout the source from [source:/PlatformSupport/pnet /PlatformSupport/pnet] (or {{{svn co http://warpproject.org/svn/WARP/PlatformSupport/pnet}}})
    98     * The repository contains a compiled binary for Windows 7 64-bit
    99     * For other platforms, compile the pnet mex function
    100   1. Add the pnet folder to your MATLAB path. The pnet folder should contain pnet.m and th pnet.mex binary (i.e. pnet.mexw64)
    101   1. Verify pnet is recognized by running {{{pnet('version');}}} on the MATLAB command line. The output should print the version number.
    102   1. Re-run the [wiki:../Reference/Utility#wl_setup 'wl_setup'] function in {{{M_Code_Reference}}}. The final prompt will be to select which type of transport you want to use. If you have added a compatible, compiled pnet to your path, the script will list it as an option you can select. Note: simply re-running 'wl_setup' and selecting java is sufficient for switching back to the built-in java routines. You do not need to explicitly remove pnet from your MATLAB path.