X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=INSTALL;h=75b8446614be0c5ee021b1a65ad475e49dc65643;hp=893d091723a9d400121189a2307662814f6a3c77;hb=1109fafaa3f5da6d1483744c4bdee6f01a37c5c5;hpb=621735e24b361b9c0c8c9c938ebd2c87c117bd4e diff --git a/INSTALL b/INSTALL index 893d0917..75b84466 100644 --- a/INSTALL +++ b/INSTALL @@ -2,32 +2,45 @@ PREREQUISITES ============= GiNaC requires the CLN library by Bruno Haible installed on your system. -It is available from . +It is available from . -You will also need a decent ANSI-compliant C++-compiler. We recommend -the C++ compiler from the GNU compiler collection, GCC >= 3.0. If you -have a different or older compiler you are on your own. Note that you -may have to use the same compiler you compiled CLN with because of -differing name-mangling schemes. +You will also need a decent ISO C++-11 compiler. We recommend the C++ +compiler from the GNU compiler collection, GCC >= 4.8. If you have a +different or older compiler you are on your own. Note that you may have to +use the same compiler you compiled CLN with because of differing +name-mangling schemes. + +The pkg-config utility is required for configuration, it can be downloaded +from . Also Python version >= 2.6 is +required. + +To build the GiNaC tutorial and reference manual the doxygen utility +(it can be downloaded from http://www.stack.nl/~dimitri/doxygen) and +TeX are necessary. + +Known to work with: + - Linux on x86 and x86_64 using + - GCC 4.8, 4.9, 5.1, 5.2, 5.3, and 6.1 + - Clang 3.5, 3.6, 3.7, 3.8 + +Known not to work with: + - Clang 2.7 and earlier due to poor C++ support. + - GCC < 4.6.0 due to missing C++-11 support + +If you install from git, you also need GNU autoconf (>=2.59), automake (>=1.8), +libtool (>= 1.5), python (>= 2.5), bison (>= 2.3), flex (>= 2.5.33) to be installed. INSTALLATION ============ -As with any autoconfiguring GNU software, installation is as easy as this: +To install from an unpacked source .tar.bz2 distribution: $ ./configure $ make - $ make check -[become root if necessary] + [become root if necessary] # make install -Known to work with: - - Linux on x86, Alpha and Sparc using GCC 3.0.x, 3.1 and 3.2. -Known not to work with: - - GCC 2.96 or earlier because proper exception and standard library support - is missing there. - To build the GiNaC tutorial and reference manual in HTML, DVI, PostScript, or PDF formats, use one of @@ -36,6 +49,11 @@ or PDF formats, use one of $ make ps $ make pdf +To compile and run GiNaC's test and benchmark suite and check whether the +library works correctly you can use + + $ make check + The "configure" script can be given a number of options to enable and disable various features. For a complete list, type: @@ -53,18 +71,35 @@ A few of the more important ones: More detailed installation instructions can be found in the documentation, in the doc/ directory. -The time the "make" step takes depends heavily on optimization levels. -Large amounts of memory (>128MB) will be required by the compiler, -also depending on optimization. To give you a rough idea of what you -have to expect the following table may be helpful. It was measured on -an Athlon/800MHz with "enough" memory: +The time to build the library depends to a large degree on optimization levels. +Using the default high optimization, 'make' takes a few minutes on a fast +machine and 'make check' takes some more minutes. You can speed this up with a +parallel build with 'make -j2' or higher, depending on the number of available +CPU cores. + + +To install from git +=================== + +First, download the code: + $ git clone git://www.ginac.de/ginac.git ginac + $ cd ginac + +Secondly, make sure all required software is installed. This is *really* +important step. If some package is missing, the `configure' script might +be misgenerated, see e.g. this discussion: + + +Finally, run -step | GCC optimization | comment - | -O1 | -O2 | ---------------+---------+---------+---------------------------------------- -make | ~6m | ~8m | shared and static library -make check | ~8m | ~12m | largely due to compilation + $ autoreconf -i +to generate the `configure' script, and proceed in a standard way, i.e. + + $ ./configure + $ make + [become root if necessary] + # make install COMMON PROBLEMS =============== @@ -72,25 +107,33 @@ COMMON PROBLEMS Problems with CLN ----------------- -You should use at least CLN-1.1, since during the development of -GiNaC various bugs have been discovered and fixed in earlier versions. -Please install CLN properly on your system before continuing with -GiNaC. +You should use at least CLN-1.2.2, since during the development of GiNaC +various bugs have been discovered and fixed in earlier versions. Please +install CLN properly on your system before continuing with GiNaC. + +Problems building ginsh +----------------------- + +The GiNaC interactive shell, ginsh, makes use of GNU readline to provide +command line editing and history. If readline library and/or headers are +missing on your system, the configure script will issue a warning. In this +case you have two options: -Problems with building ginsh ----------------------------- +1) (the easiest) If you don't intend to use ginsh (i.e. if you need GiNaC +library to compile some piece of software), ignore it. ginsh builds just +fine without readline (obviously, it won't support the command line history +and editing). -The most common reason why this doesn't succeed is the absence of -libreadline and/or the corresponding header files. Depending on what -your system/distribution is, you will have to install a package called -libreadline and maybe libreadline-dev. If your system's vendor -doesn't supply such packages, go to -and compile it yourself. +2) Install GNU readline and run the configure script once again. Depending on +what your system/distribution is, you will have to install a package called +libreadline and libreadline-dev (or readline-devel). If your system's vendor +doesn't supply such packages, go to and +compile it yourself. Note that non-GNU versions of libreadline (in particular +one shipped with Mac OS X) are not supported at the moment. Problems with missing standard header files ------------------------------------------- -Building GiNaC requires many standard header files. If you get a -configure error complaining about such missing files your compiler and -library are probably not up to date enough and it's no worth -continuing. +Building GiNaC requires many standard header files. If you get a configure +error complaining about such missing files your compiler and library are +probably not up to date enough and it's no worth continuing.