Changes between Version 15 and Version 16 of user-download


Ignore:
Timestamp:
Oct 5, 2006 2:40:55 PM (14 years ago)
Author:
andreasw
Comment:

updated according to new release policy

Legend:

Unmodified
Added
Removed
Modified
  • user-download

    v15 v16  
    11= Downloading the Source Code =
    22
    3 The source code for the COIN-OR projects is maintained using the [http://subversion.tigris.org/ subversion] version control system.
    4 '''We 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'''.
     3The source code for the COIN-OR projects is maintained using the [http://subversion.tigris.org/ subversion] version control system.  If you expect to frequently get updates for the downloaded COIN-OR projects and to make local modifications, '''we recommend you obtain the source code directly from the subversion repository system''', since it allows one to obtain updates and bugfixes very easily.  '''We also provide tarballs for the "official" releases''' of each project.
    54
    65The source code usually comes with the [wiki:user-directories directory structure explained here].
     
    2019'''NOTE:''' If you plan to use the {{{configure}}} script and {{{Makefile}}}s, the '''path to the directory into which you download the source code must not contain white spaces'''.
    2120
     21=== Determining Version Number ===
     22
     23First you need to find out which version of a COIN package (say, '''Pkg''') you want to obtain.  Assuming, that you want to obtain an "official" release, you can find the available three-digit version numbers by opening the URL {{{https://projects.coin-or.org/svn/Pkg/releases}}} in a browser, or by typing
     24{{{
     25svn list https://projects.coin-or.org/svn/Pkg/releases
     26}}}
     27Here and in further instructions below you 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).  Also, we assume that you chose '''x.y.z''' as the release number you want to obtain, and you will need to replace the {{{x.y.z}}} string correspondingly (e.g., by {{{2.3.5}}}).
     28
     29If you want to be really nifty, you can also download the latest version on a ''stable branch'', or even the latest development version.  Details regarding the (recommended) release policy can be found [wiki:pm-svn-releases here].
     30
    2231=== Downloading the Code ===
    2332
     
    2736
    2837{{{
    29 svn checkout https://projects.coin-or.org/svn/Pkg/trunk Coin-Pkg
     38svn checkout https://projects.coin-or.org/svn/Pkg/releases/x.y.z Coin-Pkg
    3039}}}
    3140
    32 You 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.
     41You can choose any name for the directory where the source code should go ({{{Coin-Pkg}}} in the above example).
    3342
    3443With 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.
    3544
    36 If 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 and use the subversion update command.
     45If you want to '''update your local copy of the code at a later point''' to get a later release of the package (say, {{{a,b,c}}}), you go into the downloaded base directory and use the subversion switch command:
    3746{{{
    3847cd Coin-Pkg
    39 svn update
     48svn switch https://projects.coin-or.org/svn/Pkg/releases/a.b.c .
    4049}}}
    4150
     
    6473}}}
    6574
    66 '''The !CoinAll Package'''
    67 
    68 A special project is the [wiki:user-coinall CoinAll] package.  If you download this one, you will obtain the source code for all projects available in COIN.
    69 
    7075== Obtaining the Code Via Tarballs ==
    7176
    72 '''NOTE: The following instructions do not yet fully apply, until the switch to SVN is completed.  The link to the svn tarball directory is currently [http://www.coin-or.org/Tarballs-SVN/ http://www.coin-or.org/Tarballs-SVN/]'''.
    73 
    74 Daily 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/].  For each COIN project, you will find a subdirectory there with the tarballs. The name of the tarball with the nightly snotshots of the official release are called '''Pkg_Date.tgz''', where {{{Pkg}}} is the name of the package, and {{{Data}}} is the date.  You might also find versioned tarballs for some packages.
     77Tarballs for point releases of COIN packages can be downloaded from the corresponding directories in [http://www.coin-or.org/Tarballs http://www.coin-or.org/Tarballs].  They have the form {{{Pgk-x.y.z.tgz}}}.
    7578
    7679To 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
    7780
    7881{{{
    79 gunzip Pkg_Date.tar.gz
    80 tar xvf Pkg_Date.tar
     82gunzip Pkg-x.y.z.tgz
     83tar xvf Pkg-x.y.z.tar
    8184}}}
    8285