COIN-OR::LEMON - Graph Library

Changeset 7:934258c64b6b in lemon-tutorial


Ignore:
Timestamp:
10/24/08 14:26:15 (11 years ago)
Author:
Alpar Juttner <alpar@…>
Branch:
default
Phase:
public
Message:

Rework installation part and move it to the appendix

Files:
1 added
2 edited

Legend:

Unmodified
Added
Removed
  • getting_started.dox

    r6 r7  
    1919/**
    2020\page getting_started Getting Started
    21 
    22 In this page we detail how to start using LEMON, from downloading it to
    23 your computer, through the steps of installation, to showing a simple
    24 "Hello World" type program that already uses LEMON. We assume that you
    25 have a basic knowledge of your operating system and C++ programming
    26 language. The procedure is pretty straightforward, but if you have any
    27 difficulties do not hesitate to
    28 <a href="mailto:lemon-user@lemon.cs.elte.hu"><b>ask</b></a>.
    29 
    30 \section requirements_lemon Hardware and Software Requirements
    31 
    32 In LEMON we use C++ templates heavily, thus compilation takes a
    33 considerable amount of time and memory. So some decent box would be
    34 advantageousm, but otherwise there are no special hardware requirements.
    35 
    36 You will need a recent C++ compiler. Our primary target is the GNU C++
    37 Compiler (g++), from version 3.3 upwards. We also checked the Intel C++
    38 Compiler (icc) and Microsoft Visual C++ (on Windows).
    39 If you want to develop with LEMON under Windows, you can use a Windows
    40 installer or you can consider using Cygwin.
    41 
    42 In this description we will suppose a Linux environment and GNU C++ Compiler.
    43 If you would like to develop under Windows and use a Windows installer,
    44 you could skip the following sections and continue reading \ref hello_lemon.
    45 However keep in mind that you have to make appropriate steps instead of
    46 the instructions detailed here to be able to compile the example code
    47 with your compiler.
    48 
    49 \subsection requirements_lp LP Solver Requirements
    50 
    51 The LEMON LP solver interface can use the GLPK (GNU Linear Programming
    52 Kit), CPLEX and SoPlex solver. If you want to use it, you will need at
    53 least one of these.
    54 See the <b><tt>INSTALL</tt></b> file how to enable these at compile time.
    55 
    56 \section download_lemon How to Download LEMON
    57 
    58 You can download LEMON from our web site:
    59 <a href="http://lemon.cs.elte.hu/">http://lemon.cs.elte.hu/</a>.
    60 There you will find released versions in form of <tt>.tar.gz</tt> files
    61 (and Windows installers).
    62 If you want a developer version (for example you want to contribute in
    63 developing LEMON) then you might want to use our Mercurial repository.
    64 This case is detailed \ref hg_checkout "later", so from now on we
    65 suppose that you downloaded a <tt>.tar.gz</tt> file.
    66 
    67 \section install_lemon How to Install LEMON
    68 
    69 In order to install LEMON you have to do the following steps.
    70 
    71 Download the tarball (named <tt>lemon-x.y.z.tar.gz</tt> where \c x, \c y
    72 and \c z are numbers indicating the version of the library, in our example
    73 we will have <tt>lemon-1.0.tar.gz</tt>) and issue the following commands:
    74 
    75 \verbatim
    76 tar xvzf lemon-1.0.tar.gz
    77 cd lemon-1.0
    78 ./configure
    79 make
    80 make check    # This is optional, but recommended. It runs a bunch of tests.
    81 make install
    82 \endverbatim
    83 
    84 These commands install LEMON under \c /usr/local (you will
    85 need root privileges to be able to install to that
    86 directory). If you want to install it to some other place, then
    87 pass the \c --prefix=DIRECTORY flag to <tt>./configure</tt>, for example:
    88 
    89 \verbatim
    90 ./configure --prefix=/home/username/lemon
    91 \endverbatim
    92 
    93 In what follows we will assume that you were able to install to directory
    94 \c /usr/local, otherwise some extra care is to be taken to use the library.
    95 
    96 We briefly explain these commands below.
    97 
    98 \verbatim
    99 tar xvzf lemon-1.0.tar.gz
    100 \endverbatim
    101 This command untars the <tt>tar.gz</tt> file into a directory named
    102 <tt>lemon-1.0</tt>.
    103 
    104 \verbatim
    105 cd lemon-1.0
    106 \endverbatim
    107 This command enters the directory.
    108 
    109 \verbatim
    110 ./configure
    111 \endverbatim
    112 This command runs the configure shell script, which does some checks and
    113 creates the makefiles.
    114 
    115 \verbatim
    116 make
    117 \endverbatim
    118 This command compiles the non-template part of LEMON into <tt>libemon.a</tt>
    119 file. It also compiles the programs in the tools and demo subdirectories
    120 when enabled.
    121 
    122 \verbatim
    123 make check
    124 \endverbatim
    125 This step is optional, but recommended. It runs the test programs that
    126 have been developed for LEMON to check whether the library works properly on
    127 your platform.
    128 
    129 \verbatim
    130 make install
    131 \endverbatim
    132 This command will copy the directory structure to its final destination
    133 (e.g. to \c /usr/local) so that your system can access it.
    134 This command should be issued as "root", unless you provided a
    135 \c --prefix switch to the \c configure to install the library in
    136 non-default location.
    137 
    138 Several other configure flags can be passed to <tt>./configure</tt>.
    139 For more information see the <b><tt>INSTALL</tt></b> file.
    140 
    141 \section hg_checkout How to Checkout LEMON from our Mercurial Repository
    142 
    143 You can obtain the latest (developer) version of LEMON from our Mercurial
    144 repository. To do this issue the following command.
    145 \verbatim
    146 hg clone http://lemon.cs.elte.hu/hg/lemon-main lemon-src
    147 \endverbatim
    148 
    149 \section hg_compile How to Compile the Source from the Repository
    150 
    151 You can compile the code from the repository similarly to the packaged
    152 version, but you will need to run <b><tt>autoreconf -vif</tt></b>
    153 (or <b><tt>./bootstrap</tt></b> in some older environment) before
    154 <tt>./configure</tt>. See <tt>./configure --help</tt> for options.
    155 For bootstrapping you will need the following tools:
    156 
    157  - <a href="http://www.gnu.org/software/automake/">automake</a> (1.7 or newer)
    158  - <a href="http://www.gnu.org/software/autoconf/">autoconf</a> (2.59 or newer)
    159  - <a href="http://www.gnu.org/software/libtool/">libtool</a>
    160  - <a href="http://pkgconfig.freedesktop.org/">pkgconfig</a>
    161 
    162 To generate the documentation, run <tt>make html</tt>.
    163 You will need <a href="http://www.doxygen.org/">Doxygen</a> for this.
    16421
    16522\section hello_lemon Compile Your First Code
  • mainpage.dox

    r4 r7  
    2525 - \ref intro
    2626 - \ref getting_started
    27    - \ref requirements_lemon
    28      - \ref requirements_lp
    29    - \ref download_lemon
    30    - \ref install_lemon
    31    - \ref hg_checkout
    32    - \ref hg_compile
    3327   - \ref hello_lemon
    34      - \ref hello_lemon_system
    35      - \ref hello_lemon_user
    3628 - \ref basic_concepts "Basic Concepts"
    3729   - \ref digraph_build "Build and Modify a Digraph"
     
    6456   - \ref lp_maxflow "Maximum Flow as LP Problem"
    6557 - \ref appendix "Appendix"
    66    - \ref install "Install LEMON"
    67      - \ref install_system "Install System Wide"
    68        - \ref install_system_source "From Source"
    69        - \ref install_system_rpm "From rpm"
     58   - \ref install
     59     - \ref requirements_lemon
     60       - \ref requirements_lp
     61     - \ref install_from_source
     62     - \ref install_system_rpm "From rpm"
    7063     - \ref install_user "Install Locally to the User"
    7164
Note: See TracChangeset for help on using the changeset viewer.