Difference between revisions of "Document:COMKAT install"

From COMKAT wiki
Jump to navigation Jump to search
(New page: '''Installation procedures before you use COMKAT''' == System requirements == Matlab 6 or higher version (NOTE: Matlab 7 is strongly recommended to use COMKAT with. Althouth COMKAT shou...)
 
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
 
== System requirements ==
 
== System requirements ==
 +
OS: Mac OS, Linux and Windows.
 +
<br>Matlab: As the mex files are compiled under different versions of Matlab, COMKAT on different platforms requires different Matlab release.
  
−
Matlab 6 or higher version
+
*Windows: Matlab 7 and above
 +
*PowerPC-based Mac OS: Matlab R14 sp1 and above
 +
*Intel-based Mac OS: Matlab 2007a and above
 +
*Linux: Matlab R14 and above
  
−
(NOTE: Matlab 7 is strongly recommended to use COMKAT with. Althouth COMKAT should be compatible in all matlab versions, COMKAT GUI was developed and test under Matlab 7. If you are using Matlab 7, you should also consider upgrading to the latest service pack.) To check your Matlab version, use command "ver" in the Matlab command window.
+
== Installation ==
 +
1. Download COMKAT_R3.zip.  
  
−
== Mircosoft Windows installation ==
+
2. Unzip it to your computer.
  
−
1. Download the zip file from COMKAT website (http://comkat.uhrad.com) and save it on your disk.
+
3. Set up search path for COMKAT. You may do either of the following:
 +
(1) Open Matlab, run 'SetComkatPath.m' under the COMKAT root folder.
 +
<br>'''Or'''
 +
(2) You may set up the paths manually. First, open Matlab and go to File -> Set Path. Click 'Add folder' and select the following folders. (COMKATROOT is the root folder that you unzip COMKAT files under.)
  
−
2. Download the installation script file: install_COMKAT_win32.bat.
+
COMKATROOT/
  
−
3. Double-click install_COMKAT_win32.bat. It will open a new Matlab session and prompt you to specify where you saved the zip file you previously downloaded. Follow the directions.
+
COMKATROOT/comkat_GUI
  
−
4. Since this batch file will automatically decompress the file and set the path, you should be able to see a welcome window after installation.
+
COMKATROOT/ComkatImageTool
  
−
5. Congradulations! You are now free to use COMKAT! Enjoy.
+
COMKATROOT/utilities
  
−
== Mac and Linux installation ==
+
COMKATROOT/validation
  
−
1. Download the zip file from COMKAT website (http://comkat.uhrad.com) and save it on your disk.
+
After that, click 'Add subfolders' and select COMKATROOT/ImageReadingFunctions.
  
−
2. Decompress the zip file.
+
4. In Matlab, execute command 'validate'. Validation suite should pop up and
 +
allow you to examine if results are correctly generated on your computer.  
  
−
3. Open Matlab. Then open the script "setComkatPath.m" under "utilities" folder. Run it and follow the directions.
+
'''NOTE Mac users''': To display tables in the COMKAT GUI properly, you have to set up your Matlab startup option to show Java elements by following these steps:
  
−
Mac users: To display tables in the COMKAT GUI properly, you have to set up your Matlab startup option to show Java elements by following these steps:
+
#Find file named "Matlab" under Matlab_root/bin/mac (Matlab_root is your Matlab directory)
−
 
+
#Press "ctrl" and click on the file "Matlab" (at the same time)
−
1. Find file named "Matlab" under Matlab_root/bin/mac (Matlab_root is your Matlab directory)
+
#Select "Show Package Contents"
−
2. Press "ctrl" and click on the file "Matlab" (at the same time)
+
#Another finder window should popup showing "Contents", enter this folder
−
3. Select "Show Package Contents"
+
#Find a file named " launch_matlab.sh"
−
4. Another finder window should popup showing "Contents", enter this folder
+
#Open this file by TextEdit or any other editor
−
5. Find a file named " launch_matlab.sh"
+
#Modify the following line: ''<nowiki>$SHELL -c 'bin/mac/setsid bin/matlab -desktop -display :0.0 &'</nowiki>'' to ''<nowiki>$SHELL -c 'bin/mac/setsid bin/matlab -useJavaGUI -desktop -display :0.0 &'</nowiki>''
−
6. Open this file by TextEdit or any other editor
+
#Save "launch_matlab.sh"
−
7. Modify the following line:
 
−
$SHELL -c 'bin/mac/setsid bin/matlab -desktop -display :0.0 &'
 
−
to
 
−
$SHELL -c 'bin/mac/setsid bin/matlab -useJavaGUI -desktop -display :0.0 &'
 
−
8. Save "launch_matlab.sh"
 
  
 
== Test COMKAT ==
 
== Test COMKAT ==
  
−
You can now test if comkat is properly installed by running the validation suite
+
You can now test if comkat is properly installed by running the validation suite. NOTE: This step is NOT necessary if you have done the previous steps successfully.
−
Manual setting of the search path for COMKAT
 
−
 
 
−
NOTE: This step is NOT necessary if you have done the previous steps successfully.
 
−
 
 
−
== Manual setup for path ==
 
−
 
 
−
If you wish to set up the Matlab search path for COMKAT by yourself, here are the steps:
 
−
 
 
−
1. Open Matlab. Go to "File"=>"Set path"
 
−
 
 
−
2. Click "Add folder" and add the following folders one by one:
 
−
 
 
−
COMKAT_root (where you decompress the files to)
 
−
COMKAT_root\ComkatImageTool'
 
−
COMKAT_root\ImageReadingFunctions\ECAT
 
−
COMKAT_root\ImageReadingFunctions\Philips
 
−
COMKAT_root\ImageReadingFunctions\Simens-CTI microPET
 
−
COMKAT_root\utilities
 
−
COMKAT_root\examples
 
−
COMKAT_root\comkat_GUI
 

Latest revision as of 21:22, 31 January 2008

Installation procedures before you use COMKAT

System requirements

OS: Mac OS, Linux and Windows.
Matlab: As the mex files are compiled under different versions of Matlab, COMKAT on different platforms requires different Matlab release.

  • Windows: Matlab 7 and above
  • PowerPC-based Mac OS: Matlab R14 sp1 and above
  • Intel-based Mac OS: Matlab 2007a and above
  • Linux: Matlab R14 and above

Installation

1. Download COMKAT_R3.zip.

2. Unzip it to your computer.

3. Set up search path for COMKAT. You may do either of the following: (1) Open Matlab, run 'SetComkatPath.m' under the COMKAT root folder.
Or (2) You may set up the paths manually. First, open Matlab and go to File -> Set Path. Click 'Add folder' and select the following folders. (COMKATROOT is the root folder that you unzip COMKAT files under.)

COMKATROOT/

COMKATROOT/comkat_GUI

COMKATROOT/ComkatImageTool

COMKATROOT/utilities

COMKATROOT/validation

After that, click 'Add subfolders' and select COMKATROOT/ImageReadingFunctions.

4. In Matlab, execute command 'validate'. Validation suite should pop up and allow you to examine if results are correctly generated on your computer.

NOTE Mac users: To display tables in the COMKAT GUI properly, you have to set up your Matlab startup option to show Java elements by following these steps:

  1. Find file named "Matlab" under Matlab_root/bin/mac (Matlab_root is your Matlab directory)
  2. Press "ctrl" and click on the file "Matlab" (at the same time)
  3. Select "Show Package Contents"
  4. Another finder window should popup showing "Contents", enter this folder
  5. Find a file named " launch_matlab.sh"
  6. Open this file by TextEdit or any other editor
  7. Modify the following line: $SHELL -c 'bin/mac/setsid bin/matlab -desktop -display :0.0 &' to $SHELL -c 'bin/mac/setsid bin/matlab -useJavaGUI -desktop -display :0.0 &'
  8. Save "launch_matlab.sh"

Test COMKAT

You can now test if comkat is properly installed by running the validation suite. NOTE: This step is NOT necessary if you have done the previous steps successfully.

Retrieved from "https://comkat.cwru.edu/index.php?title=Document:COMKAT_install&oldid=337"