wiki:WikiStart

Version 47 (modified by fmargot, 13 years ago) (diff)

--

Welcome to COIN Help

The information behind these webpages tells you how to obtain and compile most of the packages available on COIN-OR. Project managers can find also find information on using the BuildTools here

If you want to obtain precompiled binaries (executables and libraries), please go to the COIN binaries page (only available for some packages).

Below you find straight-forward instructions for downloading and compiling the source code if you are using a UNIX-like system (inclkuding Linux, Cygwin, MSys). More detailed information is available here?. The MSVisualStudio project describes how several COIN-OR projects can be built with Microsoft Visual Studio.


Minimal Download and Installation Instructions

NOTE: Please check the current issues page before trying to configure and compile the code.

The very short version of the download and installation instructions for UNIX-like system (including Linux and Cygwin) are as follows. The simple commands work in most cases if you don't have particular requirements, but it is probably a good idea to read the information on the home page for the desired COIN project, and to learn more details here?. You can also share comments, trick and hints with other users and developers at the user comments page.

Assume that you want to compile the package Pkg (where Pkg needs to be replaced below by the name of the COIN package you want to install).

  1. Find out what version of the code you would like to obtain.
    • If you only want to download and compile the code only once, we recommend that you get the source code archive from the COIN source site. For each package, you find a subdirectory there that with several archives. Usually, you would choose the one with the latest release number, such as Pgk.x.y.z.tgz.
    • If you want to stay up to date with bug-fixes and improvements, we recommand that you use subversion to get the latest stable branch. In this way, you can get updates of the source code very easily at a later point, without having to having to redo all the installation steps. You will need to know the number of the stable branch you want to obtain (see the projects' home page). Below, we denote this number with x.y.
  2. Get the code for the desired package Pkg:
    • As archive: Download the archive Pgk-x.y.z.tgz from the COIN source archive site and extract it, for example with
      gunzip Pgk-x.y.z.tgz
      tar xvf Pgk-x.y.z.tar
      
    • Via subversion: Go into the directory where you want to have a subdirectory with the downloaded source code and type
      svn co https://projects.coin-or.org/svn/Pkg/stable/x.y  Pkg-x.y
      
      The COIN-OR FAQ page has a brief explanation of how to use a Windows subversion client to download the code.
  3. Go into the downloaded directory, create a subdirectory for the compiled code, and run the configuration script
    cd Pkg-x.y.z   (or cd Pkg-x.y)
    mkdir build
    cd build
    ../configure
    
    Make sure the last line of output says that the configuration was successful. The configure script has many customization features. To learn more about them, go to the Preparing the compilation page.
  4. Compile the code
    make
    
  5. Test the compiled code (optional)
    make test
    
  6. Install the generated libraries, executables, and header files
    make install
    
    This will create subdirectories bin, lib, and include in the download directory with the product of the compilation.
  7. If you downloaded the code with subversion, you can update your local copy of the stable branch and recompile.
    cd /path/to/Pkg-x.y
    svn update
    cd build
    
    and continue at the compilation step 4 above.

If these simple instructions don't work for you, please check for more detailed information?, and visit the Troubleshooting page.

tinyInstructions?