INSTALL

   1 PREREQUISITES
   2 =============
   3
   4 GiNaC requires the CLN library by Bruno Haible installed on your system.
   5 It is available from <https://www.ginac.de/CLN/>.
   6
   7 You will also need a decent ISO C++-11 compiler. We recommend the C++
   8 compiler from the GNU compiler collection, GCC >= 4.8. If you have a
   9 different or older compiler you are on your own. Note that you may have to
  10 use the same compiler you compiled CLN with because of differing
  11 name-mangling schemes.
  12
  13 The pkg-config utility is required for configuration, it can be downloaded
  14 from <http://pkg-config.freedesktop.org/>. Also, Python 3 is required.
  15
  16 To build the GiNaC tutorial and reference manual the doxygen utility
  17 (it can be downloaded from http://www.stack.nl/~dimitri/doxygen) and
  18 TeX are necessary.
  19
  20 Known to work with:
  21  - Linux on x86 and x86_64 using
  22    - GCC 4.8, 4.9, 5.x, 6.x, 7.x, 8.x, and 9.x
  23    - Clang 3.5, 3.6, 3.7, 3.8, 6.x, 7.x, 8.x, and 9.x
  24
  25 Known not to work with:
  26  - Clang 2.7 and earlier due to poor C++ support.
  27  - GCC < 4.6.0 due to missing C++-11 support
  28
  29 If you install from git, you also need GNU autoconf (>=2.59), automake (>=1.8),
  30 libtool (>= 1.5), python (version 2.7 or 3.x), bison (>= 2.3), flex (>= 2.5.33)
  31 to be installed.
  32
  33
  34 INSTALLATION
  35 ============
  36
  37 To install from an unpacked source .tar.bz2 distribution:
  38
  39  $ ./configure
  40  $ make
  41  [become root if necessary]
  42  # make install
  43
  44 To build the GiNaC tutorial and reference manual in HTML, DVI, PostScript,
  45 or PDF formats, use one of
  46
  47  $ make html
  48  $ make dvi
  49  $ make ps
  50  $ make pdf
  51
  52 To compile and run GiNaC's test and benchmark suite and check whether the
  53 library works correctly you can use
  54
  55  $ make check
  56
  57 The "configure" script can be given a number of options to enable and
  58 disable various features. For a complete list, type:
  59
  60  $ ./configure --help
  61
  62 A few of the more important ones:
  63
  64  --prefix=PREFIX        install architecture-independent files in PREFIX
  65                         [defaults to /usr/local]
  66  --exec-prefix=EPREFIX  install architecture-dependent files in EPREFIX
  67                         [defaults to the value given to --prefix]
  68  --disable-shared       suppress the creation of a shared version of libginac
  69  --disable-static       suppress the creation of a static version of libginac
  70
  71 More detailed installation instructions can be found in the documentation,
  72 in the doc/ directory.
  73
  74 The time to build the library depends to a large degree on optimization levels.
  75 Using the default high optimization, 'make' takes a few minutes on a fast
  76 machine and 'make check' takes some more minutes. You can speed this up with a
  77 parallel build with 'make -j2' or higher, depending on the number of available
  78 CPU cores.
  79
  80
  81 To install from git
  82 ===================
  83
  84 First, download the code:
  85  $ git clone git://www.ginac.de/ginac.git ginac
  86  $ cd ginac
  87
  88 Secondly, make sure all required software is installed. This is *really*
  89 important step. If some package is missing, the `configure' script might
  90 be misgenerated, see e.g. this discussion:
  91 <https://www.ginac.de/pipermail/ginac-list/2007-November/001263.html>
  92
  93 Finally, run
  94
  95  $ autoreconf -i
  96
  97 to generate the `configure' script, and proceed in a standard way, i.e.
  98
  99  $ ./configure
 100  $ make
 101  [become root if necessary]
 102  # make install
 103
 104 COMMON PROBLEMS
 105 ===============
 106
 107 Problems with CLN
 108 -----------------
 109
 110 You should use at least CLN-1.2.2, since during the development of GiNaC
 111 various bugs have been discovered and fixed in earlier versions. Please
 112 install CLN properly on your system before continuing with GiNaC.
 113
 114 Problems building ginsh
 115 -----------------------
 116
 117 The GiNaC interactive shell, ginsh, makes use of GNU readline to provide
 118 command line editing and history. If readline library and/or headers are
 119 missing on your system, the configure script will issue a warning. In this
 120 case you have two options:
 121
 122 1) (the easiest) If you don't intend to use ginsh (i.e. if you need GiNaC
 123 library to compile some piece of software), ignore it. ginsh builds just
 124 fine without readline (obviously, it won't support the command line history
 125 and editing).
 126
 127 2) Install GNU readline and run the configure script once again. Depending on
 128 what your system/distribution is, you will have to install a package called
 129 libreadline and libreadline-dev (or readline-devel). If your system's vendor
 130 doesn't supply such packages, go to <ftp://ftp.gnu.org/gnu/readline/> and
 131 compile it yourself. Note that non-GNU versions of libreadline (in particular
 132 one shipped with Mac OS X) are not supported at the moment.
 133
 134 Problems with missing standard header files
 135 -------------------------------------------
 136
 137 Building GiNaC requires many standard header files. If you get a configure
 138 error complaining about such missing files your compiler and library are
 139 probably not up to date enough and it's no worth continuing.