Changes between Version 1 and Version 2 of WARPLab/MEX

Timestamp:

Aug 23, 2013, 6:09:22 PM (11 years ago)

Author:

welsh

Comment:

--

WARPLab/MEX

@@ -12 +12 @@
 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 [http://warpproject.org/trac/wiki/WARPLab/Benchmarks Read IQ / Write IQ performance 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.
 
+The source files for the WARPLab MEX UDP transport can be found at:
+
+ * MEX Code:
+  * [source:/ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/mex/wl_mex_udp_transport.c wl_mex_udp_transport.c]
+  * [source:/ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/mex/wl_mex_udp_transport.m wl_mex_udp_transport.m]
+ * WARPLab MEX UDP Transport:
+  * [source:/ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/classes/wl_transport_eth_udp_mex.m wl_transport_eth_udp_mex.m]
+  * [source:/ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/classes/wl_transport_eth_udp_mex_bcast.m wl_transport_eth_udp_mex_bcast.m]
+
+
 To install the WARPLab MEX UDP Transport, please perform the following steps:
 
 NOTE: Make sure you are downloading the WARPLab 7.3.0 (or later) release, or your repository is updated to the WARPLab 7.3.0 (or later) release.  In order to use this transport on your system, you must compile the wl_mex_udp_transport mex function (see [wiki:/howto/MEX_Compile How-To Compile MEX] for more information).
 
-  1. Locate the WARPLab MEX UDP Transport source in one of the following locations:
-    1. {{{<Unpacked WARPLab Reference Design Directory>\M_Code_Reference\mex\}}}
-    1. [source:/ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/mex /ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/mex]
-    1. {{{svn co http://warpproject.org/svn/WARP/ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/mex}}}
-  1. TBD - 
-  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:
+  1. Within MATLAB, change your directory to the M_Code_Reference directory that you unpacked as part of the WARPLab release.
+  1. Run {{{ wl_setup }}} in order to set up your MATLAB paths.  When running {{{ wl_setup }}}, you should only see the java transport available.  If not, please check your paths to make sure there are no issues.
+    * Now your paths should be set up to proceed.  Run {{{ which wl_mex_udp_transport }}} to check that you can see the mex files.  You should see: {{{ <your WARPLab install dir>/M_Code_Reference/mex/wl_mex_udp_transport.m }}}
+  1.  Run {{{ wl_mex_udp_transport }}} from the MATLAB command line:
+{{{
+>> wl_mex_udp_transport
+WARPLab wl_mex_udp_transport Setup
+    Would you like [1] Manual (default) or [2] Automatic compliation?
+    Selection: 
+}}}
+    * You have the ability to run either the manual or automatic compilation.  
+
+=== Manual Compilation ===
+
+If you run the manual compilation, MATLAB will print out the compilation steps:
+
+{{{
+Manual Compliation Steps:  
+    1) Please familiarize yourself with the process at: 
+         http://warpproject.org/trac/wiki/WARPLab/MEX 
+       to make sure your environment is set up properly. 
+    2) Set up mex to choose your compiler.  (mex -setup) 
+         1. Select "Yes" to have mex locate installed compilers 
+         2. Select "Microsoft Visual C++ 2010 Express" 
+         3. Select "Yes" to verify your selections 
+    3) Change directory to M_Code_Reference/mex (cd mex) 
+    4) Run the compile command: 
+         mex -g -O wl_mex_udp_transport.c -lwsock32 -lKernel32 
+    5) Re-run wl_setup and make sure that "WARPLab Mex UDP" is an available transport. 
+}}}
+
+=== Automatic Compilation ===
+
+If you run the automatic compilation, the code will attempt to compile the mex using the compiler you installed from the [wiki:../../howto/MEX_Compile How-To Compile MEX] guide.  
+
+{{{
+>> wl_mex_udp_transport
+WARPLab wl_mex_udp_transport Setup
+    Would you like [1] Manual (default) or [2] Automatic compliation?
+    Selection: 2
+
+Running Automatic Setup procedure: ...Done. 
+
+***************************************************************
+***************************************************************
+Please re-run wl_setup to use your "WARPLab Mex UDP" transport.
+***************************************************************
+***************************************************************
+}}}
+
+If there are any issues, please follow the prompts to set up the compiler (ie you will be running {{{ mex -setup }}}) and then re-run {{{ wl_udp_mex_transport }}} and the compilation should succeed.
+
+
+=== Finalizing Your MEX install ===
+
+Please make sure to re-run {{{ wl_setup }}} so that you can choose the WARPLab MEX transport to use with WARPLab.  You can verify that the transport is recognized by running {{{wl_mex_udp_transport('version');}}} on the MATLAB command line. The output should print the version number.  For example:
 {{{
 >> wl_mex_udp_transport('version');
@@ -29 +89 @@
 Distributed under the WARP license:  http://warpproject.org/license  
 }}}
-  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.  
 
-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.
+
+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.
+
+NOTE: once you have correctly compiled your wl_mex_udp_transport, you will no longer be able to just run {{{ wl_udp_mex_transport }}}.  This will result in a usage error because now you need to use the functions within the transport.
+
+=== Transport Documentation ===
+
+While the source code is heavily commented, you can always run:
+{{{
+help wl_mex_udp_transport
+}}}
+on the MATLAB command line and it will print out the help information as well as the usage.
+
+If you have any additional questions, please let us know on [http://warpproject.org/forums/ the WARP forums].
+
+
+
 
 [[br]]