SparsePOP Files

README.txt for SparsePOP Windows Binary
Copyright (C) 2007-2011 SparsePOP Project
http://sparsepop.sourceforge.net/

==INDEX==
1. Usage
2. License
3. Compile from source
4. History
========

== 1. Usage ==
[1] To use from command line, execute command prompt and
    move to this directory. 

    Solve a problem by typing
    $ sparsePOP.exe <problem file with GMP format>
    For instance, to solve an example which is contained in
    this directory, type
    $ sparsePOP.exe example1.windows.gms

    User may obtain a tighter value and solution by editing
    `param.sdpa' and `param.pop'$, which are parameter files
    of SDPA and SparesPOP. 

Note:
   GMS formatted files may contain Unix-type newline. To convert 
   such files to Windows-type newline files, use `more' in the 
   command prompt. For instance, if `example1.gms' contains 
   Unix-type newline, use the following command in the command 
   prompt:
   $ more < example1.gms > example1.windows.gms
   If the file is large and you have Linux or Cygwin environments,
   $ perl -p -e 's/\n/\r\n/' example1.gms > example1.windows.gms
   may be much faster.
   Then the Windows-type newline file 'example1.windows.gms' 
   will be available.

== 2. License ==

This binary file is distributed under GNU General Public 
License v2. More details of GNU GPLv2 License is described in 
`GPL.txt' in this directory.

The binary files in this package contain the binary file generated 
from following packages.
The source file of each package is available at the web page
of each package.

[1] SparsePOP
http://sparsepop.sourceforge.net/
SparsePOP is distributed under GNU General Public License v2.

[2] SDPA 
http://sdpa.sourceforge.net/
SDPA is distributed under GNU General Public License v2.

[3] METIS (4.0.3 or earlier)
http://glaros.dtc.umn.edu/gkhome/metis/metis/overview
One of references of METIS: 
``A Fast and Highly Quality Multilevel Scheme for Partitioning 
Irregular Graphs". George Karypis and Vipin Kumar. 
SIAM Journal on Scientific Computing, Vol. 20, No. 1, 
pp. 359--392, 1999.

We give the remark that SparsePOP can call some functions in 
METIS 4.0.3 or earlier. However, them in METIS 5 or later are 
not available in SparsePOP. We recommend to install METIS 4.0.3 
or earlier. 

[4] UFconfig
http://www.cise.ufl.edu/research/sparse/UFconfig/
UFconfig is distrubuted under GNU Lesser General Public License. 

[5] COLAMD
http://www.cise.ufl.edu/research/sparse/colamd/
COLAMD is distributed under GNU Lesser General Public License.

[6] MUMPS
http://graal.ens-lyon.fr/MUMPS/

[7] pthreads-win32
http://sourceware.org/pthreads-win32/
pthreads-win32 is distributed under GNU Lesser General Public 
License.

[8] OpenBLAS
https://github.com/xianyi/OpenBLAS
OpenBLAS is an open source code based on GotoBLAS 
and supported by ICSAS.
Copyright (c) 2011, Lab of Parallel Software and Computational 
Science,ICSAS

[9] MinGW
http://www.mingw.org/
MinGW is distributed under GNU General Public License v2.
(This notice is from the web page of MinGW)
This library is distributed in the hope that it will be useful,
but WITHOUT WARRANTY OF ANY KIND;
without even the implied warranties of MERCHANTABILITY
or of FITNESS FOR A PARTICULAR PURPOSE.


== 3. The way to generate the binary file (sparsePOP.exe) by ==
==    compiling source files                                 ==

(1) We recommend that the binary file is compiled on Debian Linux or Ubuntu. 
To generate the binary file of SparsePOP by compiling source files,
SDPA windows binary must be already compiled. 
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
For the compilation of SparsePOP windows binary, the following packages are
used. We recommend to install them by `apt-get', etc. 
   binutils build-essential 
   cvs git wget 
   cmake
   (for 32bit Windows) gcc-mingw32 mingw32-binutils mingw32-runtime
   (for 64bit Windows) binutils-mingw-w64 gcc-mingw-w64 mingw-w64
                       mingw-w64-dev mingw32-runtime 

(2) Copy the following files to in the directory of SDPA windows binary:
   compile-sparsepop-windows.sh
   libsdrand48.c 

(3) Move to the directory of SDPA windows binary.

(4) Type the following command:
   ./compile-sparsepop-windows.sh

This will automatically download METIS(ver. 4.0.3), UFconfig, COLAMD 
and compile them, then compile SparsePOP.
You will find the compiled binary package named sparsePOPC++259-windows.zip.

= 4. History = 

Version 2.59 (February 1, 2012)
SparsePOPC++259-windows released.