Installation Guide for SparsePOP

		H. Waki, S. Kim, M. Kojima, 
	M. Muramatsu, H. Sugimoto and M. Yamashita
			August 20, 2009

Two versions of SparsePOP are available in this package:
   (A) MATLAB only version
   (B) MATLAB with C++ version
(A) will always be installed, while (B) is optional.


The functions and capabilities of the two versions are identical. 
Some of time-consuming parts of (B) is coded in C++, thus, it is
faster in generating SDP problems than (A). We recommend to use (B)
whenever possible, although in many cases (A) is sufficient.


The following software packages are required for SparsePOP.

  i. MATLAB R2006b or later.
	-- available from Mathworks inc.

  ii. SeDuMi 1.1R3 or later
	-- available from http://sedumi.ie.lehigh.edu/ 
	to call SeDuMi from SparsePOP for solving an SDP relaxation problem
  and/or 
  iii. sdpa.7.3.1 or later  
	-- available from http://sdpa.indsys.chuo-u.ac.jp/sdpa/
	to call sedumiwrap.m from SparsePOP for solving an SDP relaxation problem

We assume that the packages above have been already installed, and this guide only 
explains how to install SparsePOP. See also readme.txt

1. Quick Installation Guide for MacOSX 10.4.8 or later

If you want to install the C++ version (B), in addition to
MATLAB and SeDuMi, you need Xcode, distributed by Apple.
Be sure that you have an appropriate version of Xcode.
See:
   http://www.mathworks.com/support/tech-notes/1600/1601.html
For example, if you are using MATLAB 7.4 or later,
then you must use:
   Xcode 2.4.1 or later
	--available from http://developer.apple.com/tools/xcode/

  Installation steps:

(NOTE: Skip the step marked with * if C++ version is not needed.)

  1.1 Download SparsePOP from:
	http://www.is.titech.ac.jp/~kojima/SparsePOP

  1.2 Unpack it by either:
	double-clicking the icon, or typing on the terminal:
	% tar zxvf sparsePOP220.tar.gz

	You will get a folder named SparsePOP220

  1.3 Move the folder to any place you like, say, to
	/Users/smith/matlab/SparsePOP220 (if you are Smith),
	or, if you want to install SparsePOP machine-wide, to
	/Applications/MATLAB74/toolbox/shared/SparsePOP220

  1.4 Invoke MATLAB, and cd to the folder of SparsePOP220.
	>> cd /Users/smith/matlab/SparsePOP220

 *1.5 Compile C++ codes from MATLAB window:
	>> compileSparsePOP

  1.6 Set MATLAB-path to SparsePOP220. Specifically,
	Choose: File->Set Path
	Press 'Add with Subfolders...' button, and 
	Select the folder SparsePOP220.
	Finally, Save it by pressing 'Save' button.

  1.7 Now you are ready to use SparsePOP.
	Test it by typing
	>> sparsePOP('example1.gms');

NOTE: If you want to use MATLAB in "matlab -nodisply" mode, 
it is useful to add the path of the directory of SparsePOP in 
your startup.m. If your SparsePOP is installed in 
/Users/matlab/SparsePOP, write the following command in your 
startup.m:

addpath(genpath('/Users/matlab/SparsePOP'));


2. Quick Installation Guide for Linux

If you want to install the C++ version (B), in addition to
MATLAB and SeDuMi, you need gcc compilers, a free software
distributed by GNU. Be sure that you have an appropriate
version of gcc.
See:
   http://www.mathworks.com/support/tech-notes/1600/1601.html
For example, if you are using MATLAB R2007a or later, then
you must have:
	gcc/g++ version 4.1.1 or later, and
	appropriate kernel and glibc.

  Installation steps

(NOTE: Skip the step marked with * if C++ version is not needed.)


  2.1 Download SparsePOP from:
	http://www.is.titech.ac.jp/~kojima/SparsePOP

  2.2 Unpack it by either:
	double-clicking the icon, or typing on the terminal:
	% tar zxvf sparsePOP220.tar.gz

	You will get a directory named SparsePOP220

  2.3 Move the directory to any place you like, say, to
	/home/smith/matlab/SparsePOP220 (if you are Smith),
	or, if you want to install SparsePOP machine-widely, to
	/usr/matlab2007a/toolbox/shared/SparsePOP220

  2.4 Invoke MATLAB, and cd to the directory of SparsePOP220.
	>> cd /Users/smith/matlab/SparsePOP220

*2.5 Compile C++ codes from MATLAB window:
	>> compileSparsePOP

  2.6 Set MATLAB-path to SparsePOP220. Specifically,
	Choose: File->Set Path
	Press 'Add with Subfolders...' button, and 
	Select the folder SparsePOP220.
	Finally, Save it by pressing 'Save' button.
 
  2.7 Now you are ready to use SparsePOP.
	Test it by typing
	>> sparsePOP('example1.gms');

NOTE: If you want to use MATLAB in  "matlab -nodisply" mode, 
it may be useful to add the path of the directory of SparsePOP in 
your startup.m. If your SparsePOP is installed in 
/home/matlab/SparsePOP, write the following command in your 
startup.m:

addpath(genpath('/home/matlab/SparsePOP'));


3. Quick Installation Guide for Windows XP and Vista

If you want to install the C++ version (B), in addition to
MATLAB and SeDuMi, you need an appropriate C++ compilers.
See:
   http://www.mathworks.com/support/tech-notes/1600/1601.html
We have tested it by Microsoft Visual C++ 2005.

  Installation steps:

(NOTE: Skip the step marked with * if C++ version is not needed.)

  3.1 Download SparsePOP from:
	http://www.is.titech.ac.jp/~kojima/SparsePOP

  3.2 Unpack it by double-clicking the icon.
      You may need an appropriate software for unpacking the
      tar.gz file.

      You will get a folder named SparsePOP220

  3.3 Move the folder to, say, C:\MATLAB\SparsePOP220

 *3.4 Invoke DOS window, and type:
	> cd C:\MATLAB\SparsePOP220

 *3.5 Choose Compiler. In the DOS window, type:
	> mex -setup
	and follow the message to choose a compiler.

  3.6 Invoke MATLAB, and cd to the above folder.
	>> cd C:\MATLAB\SparsePOP220

 *3.7 Compile C++ codes from MATLAB window:
	>> compileSparsePOP

  3.8 Set MATLAB-path to SparsePOP220. Specifically,
	Choose: File->Set Path
	Press 'Add with Subfolders...' button, and 
	Select the folder SparsePOP220.
	Finally, Save it by pressing 'Save' button.

  3.9 Now you are ready to use SparsePOP.
	Test it by typing
	>> sparsePOP('example1.gms');