X-Git-Url: https://www.ginac.de/ginac.git//ginac.git?p=ginac.git;a=blobdiff_plain;f=INSTALL;h=1a0eb81c8db0468a1c3e924d472785e16b023500;hp=95919a7bc923fd5dced407de1ec82613d5e8d2db;hb=74bc832973cda4204e349396c9f4f7d056f16366;hpb=4c7cf165dfe9cae732de45fcd0d95585bf9cf60f diff --git a/INSTALL b/INSTALL index 95919a7b..1a0eb81c 100644 --- a/INSTALL +++ b/INSTALL @@ -2,46 +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 +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 3 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, Alpha and Sparc using GCC 3.x and 4.0. + - Linux on x86 and x86_64 using + - GCC 4.8, 4.9, 5.x, 6.x, 7.x, 8.x, and 9.x + - Clang 3.5, 3.6, 3.7, 3.8, 6.x, 7.x, 8.x, and 9.x Known not to work with: - - GCC 2.96 or earlier because proper exception and standard library support - is missing there. + - Clang 2.7 and earlier due to poor C++ support. + - GCC < 4.6.0 due to missing C++-11 support -If you install from CVS, you also need GNU autoconf (>=2.52) and -automake (>=1.4) to be installed. +If you install from git, you also need GNU autoconf (>=2.59), automake (>=1.8), +libtool (>= 1.5), python (version 2.7 or 3.x), bison (>= 2.3), flex (>= 2.5.33) +to be installed. INSTALLATION ============ -To install from a source .tar.bz2 distribution: +To install from an unpacked source .tar.bz2 distribution: $ ./configure $ make [become root if necessary] # make install -To install from CVS: - - $ cvs -d :pserver:anoncvs@cvsthep.physik.uni-mainz.de:/home/cvs login - [enter "anoncvs" as the password] - $ cvs -d :pserver:anoncvs@cvsthep.physik.uni-mainz.de:/home/cvs co GiNaC - $ cd GiNaC - $ autoreconf -i - $ make - [become root if necessary] - # make install - To build the GiNaC tutorial and reference manual in HTML, DVI, PostScript, or PDF formats, use one of @@ -55,9 +54,8 @@ library works correctly you can use $ make check -The "configure" script (and "autogen.sh", which invokes "configure") can be -given a number of options to enable and disable various features. For a -complete list, type: +The "configure" script can be given a number of options to enable and +disable various features. For a complete list, type: $ ./configure --help @@ -73,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 +=================== -step | GCC optimization | comment - | -O1 | -O2 | ---------------+---------+---------+---------------------------------------- -make | ~6m | ~8m | shared and static library -make check | ~8m | ~12m | largely due to compilation +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 + + $ 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 =============== @@ -92,19 +107,29 @@ COMMON PROBLEMS Problems with CLN ----------------- -You should use at least CLN-1.1, since during the development of 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 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. +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: + +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). + +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 -------------------------------------------