Changes between Initial Version and Version 1 of user-download


Ignore:
Timestamp:
May 25, 2006 11:26:56 PM (15 years ago)
Author:
andreasw
Comment:

first version

Legend:

Unmodified
Added
Removed
Modified
  • user-download

    v1 v1  
     1= Downloading the Source Code =
     2
     3The source code for the COIN-OR projects is maintained using the [http://subversion.tigris.org/ subversion] version control system.
     4We recommend to obtain the source code directly from the subversion repository system, since it allows one to obtain updates and bugfixes very easily.  We also provide daily snapshots of the main (official) branch for each project in the form of tarballs.
     5
     6== Obtaining the Code Using Subversion ==
     7
     8=== Getting Subversion ===
     9
     10In order to download the code from COIN via '''subversion''', you need to have a subversion client installed on your computer.  On UNIX-like systems, including Linux and Cygwin, the executable is usually called {{{svn}}}.  Subversion is available from
     11[http://subversion.tigris.org http://subversion.tigris.org].  The source code and some precompiled binaries can be downloaded [http://subversion.tigris.org/project_packages.html here].  If you compile the code on your own, make sure you specify the {{{--with-ssl}}} flag when you run the {{{./configure}}} script, so that your {{{svn}}} executable is able to connect to {{{https://}}} servers.
     12
     13For Windows systems, you can use the '''???''' client, which can be obtained '''WHERE?'''
     14
     15=== Downloading the Code ===
     16
     17'''Unix-type system (including Linux and Cygwin)'''
     18
     19In order to obtain the source code for a COIN package (say Pkg), you go into the directory where you want to have subversion put the source code in a new subdirectory (say, coin-Pkg).  Here, you type
     20
     21{{{
     22svn checkout https://www.coin-or.org/svn/Pkg/trunk coin-Pkg
     23}}}
     24
     25You need to replace the {{{Pkg}}} string in the URL above with the name of the particular COIN package you want to get (such as {{{Cbc}}}, {{{Osi}}}, etc).  You can choose any name for the directory where the source code should go ({{{coin-Pkg}}} in the above example).  The {{{trunk}}} part of the URL is used to specify that you want to obtain the code for the latest official release.
     26
     27With this command, subversion will download all the source code and other files required to compile and run the chosen package, including code from other COIN projects that are required for the compilation of the chosen package.  Note, however, that third-party source code (such as the code for the AMPL solver library) will not be downloaded and has to be obtain separately (see '''WHERE'''?)
     28
     29If you want to update your local copy of the code at a later point to get the latest changes made in the official version of the package, you go into the downloaded base directory ({{{coin-Pkg}}}), and type {{{svn update}}}.
     30
     31'''Windows'''
     32
     33On a Windows machine, you can download the code with '''???'''
     34
     35== Obtaining the Code Via Tarballs ==
     36
     37Daily snapshots for each package, including all (COIN-internal) dependencies and data files, can be found at [http://www.coin-or.org/Tarballs/ http://www.coin-or.org/Tarballs/].  The name of the tarball is usually of the form '''???'''.tar.gz
     38
     39To extract the source code from the tarball on a UNIX-like system, you go into the directory in which you want the source code directory to be created.  Then you type
     40
     41{{{
     42gunzip ????.tar.gz
     43tar xvf ????.tar
     44}}}
     45
     46If you don't like the name of the extracted base directory, you can rename it, but do not rename any directories inside the source code tree.
     47
     48On Windows, you can use the standard decompression programs to extract the files.