Version 0.7 BSPlab utilities installation guide

Disclaimer: It should be noted that some of these utilities are rather primitive and one of our main targets for improvement in future version of BSPlab.

"Patch and run guide" guide for the make, test and batch utilities

1. This set of simple utilities can be used for running the BSP programs in the BSPlab environment from the DOS shell and as batch jobs.
2. Assumptions: The utilities runs only with 4NT.
3. Check that the lines

   set INCLUDE=C:\MSDEV\INCLUDE
   set LIB=C:\MSDEV\LIB
   	 

   in the file "BSPMake.bat" in the "BSPSim" directory reflect where you have installed "MSDEV" (i.e. the MSVC++ package).
4. Check that the "MSDEV/BIN" directory is in the path (this is usually set by the installation of the MSVC++).
5. If ClassView is not available in Developer Studio, close the workspace, delete the "BSPsim.ncb" file in the BSPSim directory, and reopen the workspace.
6. The BSPTest and BSPMake utilities (described below) is dependent on that the "BSPMake.mak" file is in the BSPSim directory.
7. BSPmake
   The use of "BSPMake" is described in part 7.4.2.1. of the documentation called "Batch compiling and execution". If BSPMake fails, try to run "VCVARS32.BAT" (located in "MSDEV\BIN") with parameter x86, and try again. If you have followed the steps above you can test "BSPMake" by typing this command while sitting at the BSPSim directory:
   
   BSPMake TestCode\MergeSort\MergeSort
   
   The output from running the program will be stored on the file "MergeSort.out" in the same subdirectory as the source (.cpp) file.
8. BSPTest
   This utility is used to test the BSPSim simulator on the test programs provided with BSPlib. All the files that are part of the BSPTest test is listed in the file "TestFiles.txt". This file contains the names of the files containing the bsp_main functions, without the .cpp extension. BSPtest uses BSPMake for each file that is tested. (See also section 7.5.4. in the documentation).
9. BSPBatch
   The BSPBatch utility resides in the BSPBatch directory. The executable file that should be run must be copied to the BSPBatch directory before the simulations can start.
   The BSPBatch directory must also contain a directory "Results", which shall contain the results of the simulations.
   The file "BSPbatch.bat" is an example batch file showing how an experiment may be specified by calling the other batchfiles in the directory.

   Some information of the files in the BSPBatch directory:
   

   • *.bat Several batch files that call each other to implement the batch simulation execution.
     
   • ParameterBase.dat The base parameters that should not vary between the simulations. Any parameters set here is overridden by any values set in the files below.
     
   • ParametersInc.dat A file containig the parameters set by BSP_SET. The file is deleted by BSP_RESET.
     
   • ParametersDynaInc.dat The parameters that are changed for every execution of the simulator.
     
   • Parameters.dat The final file read by the simulator. The file is a concatenation of the above three files, with DynaInc first, then Inc, and then Base.
     
   • XValues.txt A file containing the values along the X axis. Each value must be placed on the start of the line. The simulations are run for all the values in the file.