readme.1st

MIMO and VBLAST( please see the documentation)

%% BEGIN README

********************************************************************************
**         "README" file for MIMO Toolbox Package, v2.0beta, 02/28/10         **
********************************************************************************

COPYRIGHT

  (c)2001-2002, Kamil Anis,
  K337 Dept. of Radioelectronics
  Faculty of Electrical Engineering
  Czech Technical University in Prague
  Technicka 2
  166 27 - Prague, Czech Republic

  e-mail: [e-mail],
  URL: http://radio.feld.cvut.cz/~anis

COPYING

  (i)  Copying of all or part of the MIMO toolbox package requires the Dept. of
       Radioelectronics approval! Please include the documentation when you do
       so. All the scripts and documentation are maintained by the author.
      
  (ii) MIMO Toolbox is primarily intended for academical and non-commercial use.        Requests that survey commercial purposes will be reviewed individually.   
PACKAGE CONTENT

  README.1st		(this file)
  doc/mimouser.pdf	(toolbox documentation in PDF format)
  toolbox/		(toolbox sources)
  
  Moreover you need to have Signal Processing Toolbox right from The Mathworks     Inc. to run the program sucessfuly.

TUNED UNDER

  MATLAB(R) version 6.1.0.450 (R12.1)

  
INSTALLATION

  (1) copy the directory with M-files to wherever you want it to have

  (2) include the path to the directory in your startup.m file

      addpath /home/user/matlab/toolbox

      On UNIX(R) platforms this file should be located in
      $HOME/matlab/ directory.
      
MODIFYING THE SOURCES    

  If you decide to modify the scripts, you need to include the following lines
  into the header of the script:
  
  % (c)2001-2002 Kamil Anis, [e-mail]
  % Dept. of Radioelectronics
  % Faculty of Electrical Engineering
  % Czech Technical University in Prague
  % --
  % (c)year Your Name

PROGRAMING CONVENTIONS

  If you will modify the sources or you will create a new scripts based on those
  from MIMO toolbox please do that with respect to the following conventions:

  (1) set the value for smart indenting to 2 as shown below

      for i = 1:10
	disp(i);
      end

  (2) write the expressions in the way shown below

      y = k * x + q		(OK)
      y=k*x+q		        (WRONG)
      k = 1:10			(OK)
      c = -1			(OK)
      x = [1,2,5:10,12];	(OK)
      out = function(in1,in2)	(OK)

  (3) set the variables in lower case letter; the name should be selfexplanatory
      and should have consistent labeling

      i
      shortvar
      long_variable

      symb_time = 0.0001;
      symb_samples = 4;
      symb_energy = 1;

      if not necessary please do not use a global variables; if there is no way
      out set the global variable in upper case letters

      SYNC
      SYNC_TIMING

  (4) write the strings in full form with leading upper case letter

      'TableFormat'
      'FullReport'
      'EchoOn'

  (5) determine the program body in such a way  

      %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
      %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% BODY BEGIN %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
      %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

      program body...


      %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
      %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% BODY END %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
      %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%      

%% END README