RhodeCode

Installation Instructions

=========================

Since you are reading this I assume you already obtained one of the release

tarballs and successfully extracted it. The latest version of LEMON is

available at our web page (http://lemon.cs.elte.hu/).

LEMON provides two different build environments, one is based on "autotool",

while the other is based on "cmake". This file contains instructions only for

the former one, which is the recommended build environment on Linux, Mac OSX

and other unices or if you use Cygwin on Windows. For cmake installation

instructions visit http://lemon.cs.elte.hu.

In order to install LEMON from the extracted source tarball you have to

issue the following commands:

   1. `cd lemon-x.y.z'

      This command changes to the directory which was created when you

      extracted the sources. The x.y.z part is a version number.

   2. `./configure'

      This command runs the configure shell script, which does some checks and

      creates the makefiles.

   3. `make'

      This command compiles the non-template part of LEMON into libemon.a

   4. `make check'

      This step is optional, but recommended. It runs the test programs that

      we developed for LEMON to check whether the library works properly on

      your platform.

   5. `make install'

      This command installs LEMON under /usr/local (you will need root

      privileges to be able to do that). If you want to install it to some

      other location, then pass the --prefix=DIRECTORY flag to configure in

      step 2. For example: `./configure --prefix=/home/username/lemon'.

   6. `make install-html'

      This command installs the documentation under share/doc/lemon/docs. The

      generated documentation is included in the tarball. If you want to

      generate it yourself, then run `make html'. Note that for this you need

      to have the following programs installed: Doxygen, Graphviz, Ghostscript,

      Latex.

Configure Options and Variables

===============================

In step 2 you can customize the actions of configure by setting variables

and passing options to it. This can be done like this:

`./configure [OPTION]... [VARIABLE=VALUE]...'

Below you will find some useful variables and options (see `./configure --help'

for more):

CXX='comp'

  Change the C++ compiler to 'comp'.

CXXFLAGS='flags'

  Pass the 'flags' to the compiler. For example CXXFLAGS='-O3 -march=pentium-m'

  turns on generation of aggressively optimized Pentium-M specific code.

--prefix=PREFIX

  Set the installation prefix to PREFIX. By default it is /usr/local.

--enable-tools

   Build the programs in the tools subdirectory (default).

--disable-tools

   Do not build the programs in the tools subdirectory.

--with-glpk[=PREFIX]

   Enable GLPK support (default). You should specify the prefix too if

   you installed GLPK to some non-standard location (e.g. your home

   directory). If it is not found, GLPK support will be disabled.

--with-glpk-includedir=DIR

   The directory where the GLPK header files are located. This is only

   useful when the GLPK headers and libraries are not under the same

   prefix (which is unlikely).

--with-glpk-libdir=DIR

   The directory where the GLPK libraries are located. This is only

   useful when the GLPK headers and libraries are not under the same

   prefix (which is unlikely).

--without-glpk

   Disable GLPK support.

--with-cplex[=PREFIX]

   Enable CPLEX support (default). You should specify the prefix too

   if you installed CPLEX to some non-standard location

   (e.g. /opt/ilog/cplex75). If it is not found, CPLEX support will be

   disabled.

--with-cplex-includedir=DIR

   The directory where the CPLEX header files are located. This is

   only useful when the CPLEX headers and libraries are not under the

   same prefix (e.g.  /usr/local/cplex/cplex75/include).

--with-cplex-libdir=DIR

   The directory where the CPLEX libraries are located. This is only

   useful when the CPLEX headers and libraries are not under the same

   prefix (e.g.

   /usr/local/cplex/cplex75/lib/i86_linux2_glibc2.2_gcc3.0/static_pic_mt).

--without-cplex

   Disable CPLEX support.

--with-soplex[=PREFIX]

   Enable SoPlex support (default). You should specify the prefix too if

   you installed SoPlex to some non-standard location (e.g. your home

   directory). If it is not found, SoPlex support will be disabled.

--with-soplex-includedir=DIR

   The directory where the SoPlex header files are located. This is only

   useful when the SoPlex headers and libraries are not under the same

   prefix (which is unlikely).

--with-soplex-libdir=DIR

   The directory where the SoPlex libraries are located. This is only

   useful when the SoPlex headers and libraries are not under the same

   prefix (which is unlikely).

--without-soplex

   Disable SoPlex support.

ACLOCAL_AMFLAGS = -I m4

AM_CXXFLAGS = $(WARNINGCXXFLAGS)

AM_CPPFLAGS = -I$(top_srcdir) -I$(top_builddir)

LDADD = $(top_builddir)/lemon/libemon.la

EXTRA_DIST = \

	AUTHORS \

	LICENSE \

	m4/lx_check_cplex.m4 \

	m4/lx_check_glpk.m4 \

	m4/lx_check_soplex.m4 \

	CMakeLists.txt \

	cmake/FindGhostscript.cmake \

	cmake/FindGLPK.cmake \

	cmake/version.cmake.in \

	cmake/version.cmake \

	cmake/nsis/lemon.ico \

	cmake/nsis/uninstall.ico

pkgconfigdir = $(libdir)/pkgconfig

lemondir = $(pkgincludedir)

bitsdir = $(lemondir)/bits

conceptdir = $(lemondir)/concepts

pkgconfig_DATA =

lib_LTLIBRARIES =

lemon_HEADERS =

bits_HEADERS =

concept_HEADERS =

noinst_HEADERS =

noinst_PROGRAMS =

bin_PROGRAMS =

check_PROGRAMS =

dist_bin_SCRIPTS =

TESTS =

XFAIL_TESTS =

include lemon/Makefile.am

include test/Makefile.am

include doc/Makefile.am

include tools/Makefile.am

MRPROPERFILES = \

	aclocal.m4 \

	config.h.in \

	config.h.in~ \

	configure \

	Makefile.in \

	build-aux/config.guess \

	build-aux/config.sub \

	build-aux/depcomp \

	build-aux/install-sh \

	build-aux/ltmain.sh \

	build-aux/missing \

	doc/doxygen.log

mrproper:

	$(MAKE) $(AM_MAKEFLAGS) maintainer-clean

	-rm -f $(MRPROPERFILES)

dist-bz2: dist

	zcat $(PACKAGE)-$(VERSION).tar.gz | \

	bzip2 --best -c > $(PACKAGE)-$(VERSION).tar.bz2

distcheck-bz2: distcheck

	zcat $(PACKAGE)-$(VERSION).tar.gz | \

	bzip2 --best -c > $(PACKAGE)-$(VERSION).tar.bz2

dnl Process this file with autoconf to produce a configure script.

dnl Version information.

m4_define([lemon_version_number],

	[m4_normalize(esyscmd([echo ${LEMON_VERSION}]))])

dnl m4_define([lemon_version_number], [])

m4_define([lemon_hg_path], [m4_normalize(esyscmd([./scripts/chg-len.py]))])

m4_define([lemon_hg_revision], [m4_normalize(esyscmd([hg id -i]))])

m4_define([lemon_version], [ifelse(lemon_version_number(),

			   [],

			   [lemon_hg_path().lemon_hg_revision()],

			   [lemon_version_number()])])

AC_PREREQ([2.59])

AC_INIT([LEMON], [lemon_version()], [lemon-user@lemon.cs.elte.hu], [lemon])

AC_CONFIG_AUX_DIR([build-aux])

AC_CONFIG_MACRO_DIR([m4])

AM_INIT_AUTOMAKE([-Wall -Werror foreign subdir-objects nostdinc])

AC_CONFIG_SRCDIR([lemon/list_graph.h])

AC_CONFIG_HEADERS([config.h lemon/config.h])

dnl Do compilation tests using the C++ compiler.

AC_LANG([C++])

dnl Check the existence of long long type.

AC_CHECK_TYPE(long long, [long_long_found=yes], [long_long_found=no])

if test x"$long_long_found" = x"yes"; then

  AC_DEFINE([HAVE_LONG_LONG], [1], [Define to 1 if you have long long.])

fi

dnl Checks for programs.

AC_PROG_CXX

AC_PROG_CXXCPP

AC_PROG_INSTALL

AC_DISABLE_SHARED

AC_PROG_LIBTOOL

AC_CHECK_PROG([doxygen_found],[doxygen],[yes],[no])

AC_CHECK_PROG([gs_found],[gs],[yes],[no])

dnl Detect Intel compiler.

AC_MSG_CHECKING([whether we are using the Intel C++ compiler])

AC_COMPILE_IFELSE([#ifndef __INTEL_COMPILER

choke me

#endif], [ICC=[yes]], [ICC=[no]])

if test x"$ICC" = x"yes"; then

  AC_MSG_RESULT([yes])

else

  AC_MSG_RESULT([no])

fi

dnl Set custom compiler flags when using g++.

if test "$GXX" = yes -a "$ICC" = no; then

  WARNINGCXXFLAGS="-Wall -W -Wall -W -Wunused -Wformat=2 -Wctor-dtor-privacy -Wnon-virtual-dtor -Wno-char-subscripts -Wwrite-strings -Wno-char-subscripts -Wreturn-type -Wcast-qual -Wcast-align -Wsign-promo -Woverloaded-virtual -ansi -fno-strict-aliasing -Wold-style-cast -Wno-unknown-pragmas"

fi

AC_SUBST([WARNINGCXXFLAGS])

dnl Checks for libraries.

LX_CHECK_GLPK

LX_CHECK_CPLEX

LX_CHECK_SOPLEX

LX_CHECK_CLP

AM_CONDITIONAL([HAVE_LP], [test x"$lx_lp_found" = x"yes"])

AM_CONDITIONAL([HAVE_MIP], [test x"$lx_mip_found" = x"yes"])

dnl Disable/enable building the binary tools.

AC_ARG_ENABLE([tools],

AS_HELP_STRING([--enable-tools], [build additional tools @<:@default@:>@])

AS_HELP_STRING([--disable-tools], [do not build additional tools]),

              [], [enable_tools=yes])

AC_MSG_CHECKING([whether to build the additional tools])

if test x"$enable_tools" != x"no"; then

  AC_MSG_RESULT([yes])

else

  AC_MSG_RESULT([no])

fi

AM_CONDITIONAL([WANT_TOOLS], [test x"$enable_tools" != x"no"])

dnl Checks for header files.

AC_CHECK_HEADERS(limits.h sys/time.h sys/times.h unistd.h)

dnl Checks for typedefs, structures, and compiler characteristics.

AC_C_CONST

AC_C_INLINE

AC_TYPE_SIZE_T

AC_HEADER_TIME

AC_STRUCT_TM

dnl Checks for library functions.

AC_HEADER_STDC

AC_CHECK_FUNCS(gettimeofday times ctime_r)

dnl Add dependencies on files generated by configure.

AC_SUBST([CONFIG_STATUS_DEPENDENCIES],

  ['$(top_srcdir)/doc/Doxyfile.in $(top_srcdir)/lemon/lemon.pc.in $(top_srcdir)/cmake/version.cmake.in'])

AC_CONFIG_FILES([

Makefile

cmake/version.cmake

doc/Doxyfile

lemon/lemon.pc

])

AC_OUTPUT

echo

echo '****************************** SUMMARY ******************************'

echo

echo Package version............... : $PACKAGE-$VERSION

echo

echo C++ compiler.................. : $CXX

echo C++ compiles flags............ : $WARNINGCXXFLAGS $CXXFLAGS

echo

echo Compiler supports long long... : $long_long_found

echo

echo GLPK support.................. : $lx_glpk_found

echo CPLEX support................. : $lx_cplex_found

echo SOPLEX support................ : $lx_soplex_found

echo CLP support................... : $lx_clp_found

echo

echo Build additional tools........ : $enable_tools

echo

echo The packace will be installed in

echo -n '  '

echo $prefix.

echo

echo '*********************************************************************'

echo

echo Configure complete, now type \'make\' and then \'make install\'.

echo

@defgroup auxalg Auxiliary Algorithms

@ingroup algs

\brief Auxiliary algorithms implemented in LEMON.

This group contains some algorithms implemented in LEMON

in order to make it easier to implement complex algorithms.

*/

/**

@defgroup approx Approximation Algorithms

@ingroup algs

\brief Approximation algorithms.

This group contains the approximation and heuristic algorithms

implemented in LEMON.

*/

/**

@defgroup gen_opt_group General Optimization Tools

\brief This group contains some general optimization frameworks

implemented in LEMON.

This group contains some general optimization frameworks

implemented in LEMON.

*/

/**

@defgroup lp_group Lp and Mip Solvers

@ingroup gen_opt_group

\brief Lp and Mip solver interfaces for LEMON.

This group contains Lp and Mip solver interfaces for LEMON. The

various LP solvers could be used in the same manner with this

interface.

*/

/**

@defgroup lp_utils Tools for Lp and Mip Solvers

@ingroup lp_group

\brief Helper tools to the Lp and Mip solvers.

This group adds some helper tools to general optimization framework

implemented in LEMON.

*/

/**

@defgroup metah Metaheuristics

@ingroup gen_opt_group

\brief Metaheuristics for LEMON library.

This group contains some metaheuristic optimization tools.

*/

/**

@defgroup utils Tools and Utilities

\brief Tools and utilities for programming in LEMON

Tools and utilities for programming in LEMON.

*/

/**

@defgroup gutils Basic Graph Utilities

@ingroup utils

\brief Simple basic graph utilities.

This group contains some simple basic graph utilities.

*/

/**

@defgroup misc Miscellaneous Tools

@ingroup utils

\brief Tools for development, debugging and testing.

This group contains several useful tools for development,

debugging and testing.

*/

/**

@defgroup timecount Time Measuring and Counting

@ingroup misc

\brief Simple tools for measuring the performance of algorithms.

This group contains simple tools for measuring the performance

of algorithms.

*/

/**

@defgroup exceptions Exceptions

@ingroup utils

\brief Exceptions defined in LEMON.

This group contains the exceptions defined in LEMON.

*/

/**

@defgroup io_group Input-Output

\brief Graph Input-Output methods

This group contains the tools for importing and exporting graphs

and graph related data. Now it supports the \ref lgf-format

"LEMON Graph Format", the \c DIMACS format and the encapsulated

postscript (EPS) format.

*/

/**

@defgroup lemon_io LEMON Graph Format

@ingroup io_group

\brief Reading and writing LEMON Graph Format.

This group contains methods for reading and writing

\ref lgf-format "LEMON Graph Format".

*/

/**

@defgroup eps_io Postscript Exporting

@ingroup io_group

\brief General \c EPS drawer and graph exporter

This group contains general \c EPS drawing methods and special

graph exporting tools.

*/

/**

@defgroup dimacs_group DIMACS format

@ingroup io_group

\brief Read and write files in DIMACS format

Tools to read a digraph from or write it to a file in DIMACS format data.

*/

/**

@defgroup nauty_group NAUTY Format

@ingroup io_group

\brief Read \e Nauty format

Tool to read graphs from \e Nauty format data.

*/

/**

@defgroup concept Concepts

\brief Skeleton classes and concept checking classes

This group contains the data/algorithm skeletons and concept checking

classes implemented in LEMON.

The purpose of the classes in this group is fourfold.

- These classes contain the documentations of the %concepts. In order

  to avoid document multiplications, an implementation of a concept

  simply refers to the corresponding concept class.

- These classes declare every functions, <tt>typedef</tt>s etc. an

  implementation of the %concepts should provide, however completely

  without implementations and real data structures behind the

  interface. On the other hand they should provide nothing else. All

  the algorithms working on a data structure meeting a certain concept

  should compile with these classes. (Though it will not run properly,

  of course.) In this way it is easily to check if an algorithm

  doesn't use any extra feature of a certain implementation.

- The concept descriptor classes also provide a <em>checker class</em>

  that makes it possible to check whether a certain implementation of a

  concept indeed provides all the required features.

- Finally, They can serve as a skeleton of a new implementation of a concept.

*/

/**

@defgroup graph_concepts Graph Structure Concepts

@ingroup concept

\brief Skeleton and concept checking classes for graph structures

This group contains the skeletons and concept checking classes of LEMON's

graph structures and helper classes used to implement these.

*/

/**

@defgroup map_concepts Map Concepts

@ingroup concept

\brief Skeleton and concept checking classes for maps

This group contains the skeletons and concept checking classes of maps.

*/

/**

\anchor demoprograms

@defgroup demos Demo Programs

Some demo programs are listed here. Their full source codes can be found in

the \c demo subdirectory of the source tree.

*/

/**

@defgroup tools Standalone Utility Applications

Some utility applications are listed here.

The standard compilation procedure (<tt>./configure;make</tt>) will compile

them, as well.

*/

}

#!/bin/bash

set -e

if [ $# = 0 ]; then

    echo "Usage: $0 release-id"

    exit 1

else

    export LEMON_VERSION=$1

fi

echo '*****************************************************************'

echo ' Start making release tarballs for version '${LEMON_VERSION}

echo '*****************************************************************'

autoreconf -vif

make

make html

make distcheck

tar xf lemon-${LEMON_VERSION}.tar.gz

zip -r lemon-${LEMON_VERSION}.zip lemon-${LEMON_VERSION}

mv lemon-${LEMON_VERSION}/doc/html lemon-doc-${LEMON_VERSION}

tar czf lemon-doc-${LEMON_VERSION}.tar.gz lemon-doc-${LEMON_VERSION}

zip -r lemon-doc-${LEMON_VERSION}.zip lemon-doc-${LEMON_VERSION}

tar czf lemon-nodoc-${LEMON_VERSION}.tar.gz lemon-${LEMON_VERSION}

zip -r lemon-nodoc-${LEMON_VERSION}.zip lemon-${LEMON_VERSION}

hg tag -m 'LEMON '${LEMON_VERSION}' released ('$(hg par --template="{node|short}")' tagged as r'${LEMON_VERSION}')' r${LEMON_VERSION}

rm -rf lemon-${LEMON_VERSION} lemon-doc-${LEMON_VERSION}

echo '*****************************************************************'

echo '  Release '${LEMON_VERSION}' has been created' 

echo '*****************************************************************'

EXTRA_DIST += \

	test/CMakeLists.txt

noinst_HEADERS += \

	test/graph_test.h \

	test/test_tools.h

check_PROGRAMS += \

	test/adaptors_test \

	test/bfs_test \

	test/circulation_test \

	test/counter_test \

	test/dfs_test \

	test/digraph_test \

	test/dijkstra_test \

	test/dim_test \

	test/edge_set_test \

	test/error_test \

	test/euler_test \

	test/gomory_hu_test \

	test/graph_copy_test \

	test/graph_test \

	test/graph_utils_test \

	test/hao_orlin_test \

	test/heap_test \

	test/kruskal_test \

	test/maps_test \

	test/max_matching_test \

	test/min_cost_arborescence_test \

	test/path_test \

	test/preflow_test \

	test/radix_sort_test \

	test/random_test \

	test/suurballe_test \

	test/test_tools_fail \

	test/test_tools_pass \

	test/time_measure_test \

	test/unionfind_test

if HAVE_LP

check_PROGRAMS += test/lp_test

endif HAVE_LP

if HAVE_MIP

check_PROGRAMS += test/mip_test

endif HAVE_MIP

TESTS += $(check_PROGRAMS)

XFAIL_TESTS += test/test_tools_fail$(EXEEXT)

test_adaptors_test_SOURCES = test/adaptors_test.cc

test_bfs_test_SOURCES = test/bfs_test.cc

test_circulation_test_SOURCES = test/circulation_test.cc

test_counter_test_SOURCES = test/counter_test.cc

test_dfs_test_SOURCES = test/dfs_test.cc

test_digraph_test_SOURCES = test/digraph_test.cc

test_dijkstra_test_SOURCES = test/dijkstra_test.cc

test_dim_test_SOURCES = test/dim_test.cc

test_edge_set_test_SOURCES = test/edge_set_test.cc

test_error_test_SOURCES = test/error_test.cc

test_euler_test_SOURCES = test/euler_test.cc

test_gomory_hu_test_SOURCES = test/gomory_hu_test.cc

test_graph_copy_test_SOURCES = test/graph_copy_test.cc

test_graph_test_SOURCES = test/graph_test.cc

test_graph_utils_test_SOURCES = test/graph_utils_test.cc

test_heap_test_SOURCES = test/heap_test.cc

test_kruskal_test_SOURCES = test/kruskal_test.cc

test_hao_orlin_test_SOURCES = test/hao_orlin_test.cc

test_lp_test_SOURCES = test/lp_test.cc

test_maps_test_SOURCES = test/maps_test.cc

test_mip_test_SOURCES = test/mip_test.cc

test_max_matching_test_SOURCES = test/max_matching_test.cc

test_min_cost_arborescence_test_SOURCES = test/min_cost_arborescence_test.cc

test_path_test_SOURCES = test/path_test.cc

test_preflow_test_SOURCES = test/preflow_test.cc

test_radix_sort_test_SOURCES = test/radix_sort_test.cc

test_suurballe_test_SOURCES = test/suurballe_test.cc

test_random_test_SOURCES = test/random_test.cc

test_test_tools_fail_SOURCES = test/test_tools_fail.cc

test_test_tools_pass_SOURCES = test/test_tools_pass.cc

test_time_measure_test_SOURCES = test/time_measure_test.cc

test_unionfind_test_SOURCES = test/unionfind_test.cc