COIN-OR::LEMON - Graph Library

Changeset 1637:9d64d5672b88 in lemon-0.x for doc/getstart.dox


Ignore:
Timestamp:
08/17/05 22:37:36 (14 years ago)
Author:
Akos Ladanyi
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2150
Message:

Added a section about configure flags, and a few other things.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/getstart.dox

    r1528 r1637  
    1010<a href="http://lemon.cs.elte.hu/mailinglists.html">ask</a>.
    1111
     12
    1213\section requirementsLEMON Hardware and software requirements
    1314
     
    1718
    1819You will need a recent C++ compiler. Our primary target is the GNU C++
    19 Compiler (g++), from version 3.3 upwards. We also checked the Intel C
    20 compiler (icc). Microsoft Visual C++ .NET version was also reported to
     20Compiler (g++), from version 3.3 upwards. We also checked the Intel C++
     21Compiler (icc). Microsoft Visual C++ .NET 2003 was also reported to
    2122work (but not the earlier versions). If you want to develop with LEMON
    2223under Windows you could consider using Cygwin.
    2324
    24 
    25 In this description we will suppose a linux environment and GNU C Compiler.
     25In this description we will suppose a Linux environment and GNU C++ Compiler.
     26
     27
     28\subsection requirementsLP LP solver requirements
     29
     30The LEMON LP solver interface can use the GLPK (GNU Linear Programming Kit)
     31and CPLEX solvers (was tested with CPLEX 7.5). If you want to use it you will
     32need at least one of these. See \ref configureFlags how to enable these at
     33compile time.
     34
     35
     36\subsection requirementsGUI GUI requirements
     37
     38To compile the graphical graph editor you will need libgnomecanvasmm
     39(2.6.0 or newer). See \ref configureFlags how to enable it.
     40
    2641
    2742\section downloadLEMON How to download LEMON
    2843
    2944You can download LEMON from the LEMON web site:
    30 http://lemon.cs.elte.hu/download.html.
     45http://lemon.cs.elte.hu/download.html .
    3146There you will find released versions in form of <tt>.tar.gz</tt> files.
    3247If you want a developer version (for example you want to contribute in
     
    3449repository. This case is not detailed here, so from now on we suppose that
    3550you downloaded a tar.gz file.
    36 
    3751
    3852
     
    8599\endverbatim
    86100Does some configuration (creates makefiles etc).
    87 \todo Explain the most important switches here (gui, doc, glpk, cplex).
    88101
    89102\verbatim
     
    107120/usr/local) so that your system can access it. This command should
    108121be issued as "root", unless you provided a \c --prefix switch to
    109 the \c cofugure to install the library in non-default location.
     122the \c configure to install the library in non-default location.
     123
     124
     125\subsection configureFlags Configure flags
     126
     127You can pass the following flags to \c ./configure (see \c ./configure --help
     128for more):
     129
     130\verbatim
     131--enable-gui
     132\endverbatim
     133Build the GUI.
     134
     135\verbatim
     136--disable-gui
     137\endverbatim
     138Do not build the GUI (default).
     139
     140\verbatim
     141--with-glpk[=PREFIX]
     142\endverbatim
     143Enable GLPK support (default). You should specify the prefix too if you
     144installed it to some non-standard location (e.g. your home directory). If
     145GLPK is not found, then GLPK support will be disabled.
     146
     147\verbatim
     148--with-glpk-includedir=DIR
     149\endverbatim
     150The directory where the GLPK header files are located. This is only useful when
     151the GLPK headers and libraries are not under the same prefix (which is not
     152likely).
     153
     154\verbatim
     155--with-glpk-libdir=DIR
     156\endverbatim
     157The directory where the GLPK libraries are located. This is only useful when
     158the GLPK headers and libraries are not under the same prefix (which is not
     159likely).
     160
     161\verbatim
     162--without-glpk
     163\endverbatim
     164Disable GLPK support.
     165
     166\verbatim
     167--with-cplex[=PREFIX]
     168\endverbatim
     169Enable CPLEX support (default). You should specify the prefix too if you
     170installed it to some non-standard location (e.g. \c /opt/ilog/cplex75). If
     171CPLEX is not found, then CPLEX support will be disabled.
     172
     173\verbatim
     174--with-cplex-includedir=DIR
     175\endverbatim
     176The directory where the CPLEX header files are located. This is only useful
     177when the CPLEX headers and libraries are not under the same prefix.
     178
     179\verbatim
     180--with-cplex-libdir=DIR
     181\endverbatim
     182The directory where the CPLEX libraries are located. This is only useful when
     183the CPLEX headers and libraries are not under the same prefix.
     184
     185\verbatim
     186--without-cplex
     187\endverbatim
     188Disable CPLEX support.
     189
     190
     191\section svnCheckout How to checkout LEMON form our Subversion repository
     192
     193You can obtain the latest version of LEMON from our Subversion repository. To
     194do this issue the following command:
     195\verbatim
     196svn co https://lemon.cs.elte.hu/svn/hugo/trunk lemon
     197\endverbatim
     198Use "lemon" as username, the password is empty.
     199
     200
     201\section svnCompile How to compile the source from the repository
     202
     203You can compile the code from the repository similarly to the packaged version,
     204but you will need to run \c ./bootstrap before \c ./configure. See \c
     205./bootstrap \c --help for options. For bootstrapping you will need the
     206following tools:
     207
     208 - <a href="http://www.gnu.org/software/automake/">automake</a> (1.7 or newer)
     209 - <a href="http://www.gnu.org/software/autoconf/">autoconf</a> (2.59 or newer)
     210 - <a href="http://www.gnu.org/software/libtool/">libtool</a>
     211 - <a href="http://pkgconfig.freedesktop.org/">pkgconfig</a>
     212
     213To generate the documentation, run \c make \c doc. You will need
     214<a href="http://www.doxygen.org/">Doxygen</a> for this.
     215
     216You can pass the \c --enable-doc=full flag to \c ./configure to generate the
     217internal documentation too.
     218
     219If you pass the \c --disable-doc flag to \c ./configure then the documentation
     220won't be installed, when you run \c make \c install (this speeds things up a
     221bit).
    110222
    111223\section helloworld My first program using LEMON
Note: See TracChangeset for help on using the changeset viewer.