COIN-OR::LEMON - Graph Library

source: lemon/INSTALL @ 1220:eb2f9d453070

Last change on this file since 1220:eb2f9d453070 was 1208:60c0c3ed8d11, checked in by Alpar Juttner <alpar@…>, 8 years ago

Use MathJax? for rendering the math formulae (#455)

File size: 4.4 KB
[5]1Installation Instructions
[1148]4This file contains instructions for building and installing LEMON from
5source on Linux. The process on Windows is similar.
[1148]7Note that it is not necessary to install LEMON in order to use
8it. Instead, you can easily integrate it with your own code
9directly. For instructions, see
[318]13In order to install LEMON from the extracted source tarball you have to
[5]14issue the following commands:
[1148]16   1. Step into the root of the source directory.
[1148]18      $ cd lemon-x.y.z
[1148]20   2. Create a build subdirectory and step into it.
[1148]22      $ mkdir build
23      $ cd build
[1148]25   3. Perform system checks and create the makefiles.
[1148]27      $ cmake ..
[1148]29   4. Build LEMON.
[1148]31      $ make
[1148]33      This command compiles the non-template part of LEMON into
34      libemon.a file. It also compiles the programs in the 'tools' and
35      'demo' subdirectories.
37   5. [Optional] Compile and run the self-tests.
39      $ make check
41   5. [Optional] Generate the user documentation.
43      $ make html
45      The release tarballs already include the documentation.
47      Note that for this step you need to have the following tools
48      installed: Python, Doxygen, Graphviz, Ghostscript, LaTeX.
50   6. [Optional] Install LEMON
52      $ make install
[245]54      This command installs LEMON under /usr/local (you will need root
[1148]55      privileges to be able to do that). If you want to install it to
56      some other location, then pass the
57      -DCMAKE_INSTALL_PREFIX=DIRECTORY flag to cmake in Step 3.
58      For example:
60      $ cmake -DCMAKE_INSTALL_PREFIX=/home/username/lemon'
[245]62Configure Options and Variables
[1148]65In Step 3, you can customize the build process by passing options to CMAKE.
[1148]67$ cmake [OPTIONS] ..
[1148]69You find a list of the most useful options below.
73  Set the installation prefix to PREFIX. By default it is /usr/local.
[1148]77  This sets the compiler options. The choices are the following
[1148]79  'Release': A strong optimization is turned on (-O3 with gcc). This
80    is the default setting and we strongly recommend using this for
81    the final compilation.
[1148]83  'Debug': Optimization is turned off and debug info is added (-O0
84    -ggdb with gcc). If is recommended during the development.
[1148]86  'Maintainer': The same as 'Debug' but the compiler warnings are
87    converted to errors (-Werror with gcc). In addition, 'make' will
88    also automatically compile and execute the test codes. It is the
89    best way of ensuring that LEMON codebase is clean and safe.
[1148]91  'RelWithDebInfo': Optimized build with debug info.
[1148]93  'MinSizeRel': Size optimized build (-Os with gcc)
[1148]97  Using this, the test codes will be executed using valgrind. It is a
98  very effective way of identifying indexing problems and memory leaks.
[1148]102  Change the compiler to be used.
[1148]106  Build shared library instead of static one. Think twice if you
107  really want to use this option.
111  Include the browsable cross referenced LEMON source code into the
112  doc. It makes the doc quite bloated, but may be useful for
113  developing LEMON itself.
117  Use MathJax ( for rendering the math formulae in
118  the doc.  It of much higher quality compared to the default LaTeX
119  generated static images and it allows copy&paste of the formulae to
120  LaTeX, Open Office, MS Word etc. documents.
122  On the other hand, it needs either Internet access or a locally
123  installed version of MathJax to properly render the doc.
127  The location of the MathJax library. It defaults to
128, which necessitates Internet access
129  for proper rendering. The easiest way to make it usable offline is
130  to set this parameter to 'mathjax' and copy all files of the MathJax
131  library into the 'doc/html/mathjax' subdirectory of the build
132  location.
134  See for more details.
[1148]141  Install root directory prefixes of optional third party libraries.
143Makefile Variables
[1148]146make VERBOSE=1
[1148]148   This results in a more verbose output by showing the full
149   compiler and linker commands.
Note: See TracBrowser for help on using the repository browser.