See the Normaliz manual, doc/Normaliz.pdf, Chapter 11, for
installation prerequisites (compiler, build tools, and libraries) and
how to install them using the install scripts in the distribution.

****************** ***
****   PACKAGES   ****
****************** ***

For rational polyhedra:

CoCoALib, http://cocoa.dima.unige.it/cocoalib/, version 0.99710
MPFR,  http://www.mpfr.org/mpfr, version 4.0.2
Flint, http://www.flintlib.org/flint, version 2.5.2
nauty, http://users.cecs.anu.edu.au/~bdm/nauty, version 27rc5

nauty should be configured with --enable-tls.

For algebraic polyhedra additionally:

MPFR and Flint as above
arb, https://github.com/fredrik-johansson/arb/archive/, version 2.17.0
e-antic, http://www.labri.fr/perso/vdelecro/e-antic/, version 0.1.5


*********************
****   SCRIPTS   ****
*********************

The Normaliz install scripts handle the installation without any user interaction.
They only generate directories and files within the Normaliz directory, unless
the user forces them to do otherwise.

The use of the install scripts is described in the Normaliz manual,
doc/Normaliz.pdf, Section 11.2.

They installation can in addition be controlled by several environment variables:

NMZ_COMPILER: overrides the standard choice of compiler (g++ on Linux, clang++ on Mac)
NMZ_PREFIX: if set defines the path for make install; 
    by default it is "local" in the Normaliz directory
GMP_INSTALLDIR: sets the path to the GMP files
NMZ_OPT_DIR: sets the directory to which the sources of the optional libraries are downloaded;
  by default it is the subdirectory "nmz_opt_lib" in the Normaliz directory
NO_OPENMP: if set blocks OpenMP in the compilation of Normaliz (and e-antic)
NMZ_EXTENDED_TESTS: if set activates compilation for extended tests

EXTRA_FLAGS: One can further control the build process of Normaliz by setting options for configure using this
   variable, the contents of which are appended to the call to the configure script; see

   ./configure --help

Have a look at the install scripts.

************************
**** THE TEST SUITE ****
************************

Normaliz has a large test suite contained in test and its subdirectories. If Normaliz has been built in b uild_shared, one can simply navigate to this directory and type

    make check

This will run all checks that fit the installed version of Normaliz. 

The checks are based on Makefile.classic in test. A direct access is also possible. Within test it is started by

    make -f Makefile.classic <goal>

This call assumes that the binary normaliz is located in ../source (for historical treaseons). The binary can be defined by

    make -f Makefile.classic <goal> NORMALIZ=path_to_normaliz/normaliz

The general method is to create an output file and to compare it to a reference file. Certain tests create two output files per input file, for example integer hull computations or automorphism groups.

Adding OUTPUTCHECK=yes disables the comparisons to the reference files. This makes it easier to spot unwanted debugging output to the terminal.

Basic tests
-----------

The default goal is all. It runs the tests that do not depend on an optional package. The goal total runs the tests in total, including those deoending on the optional packages (except tstLARGE). The tests depending on the existence of CoCoALib are covered by the goal testInt. Those requiring nauty are called by testAut and the tests for algebraic polyhedra depend on several goals:

    testnf testnfH testdegQ testnfAut

namely general tests, integer hull tests, tests of degenerate polytopes, and finally the computation of automorphism groups, which requires nauty as well.

If diff finds differences, these are recorded in a file with suffix diff and printed to the terminal.

Extended tests
--------------

Since the tests must be  fast, they cannot cover those parts of the program that aim at large computations or are critical for arithmetic. Therefore it is possible to disguise small computations as being large. This is done via cone properties

TestArithOverflowFullCone     TestSmallPyramids 
TestArithOverflowDualMode     TestLargeePyramids
TestArithOverflowDescent      TestSimplexParallel
TestArithOverflowProjAndLift  TestLinearAlgebraGMP
TestLibNormaliz


The names are self-explanatory. These cone properties are always defined, but they are ignored, unless Normaliz has been compiled with NMZ_EXTENDED_TESTS. (sSee install_normaliz.sh or source/Makefile.configuration.)

Large tests
-----------

It is possible to run truly large tests via the goal testLARGE. They are time consuming.


********************
**** plain MAKE ****
********************

Under Linux one can still use our old simple plain Makefile.

IT IS MEANT FOR THE DEVELOPMENT OF NORMALIZ and the creation of static binaries under Linux.

It is assumed that the optional libraries are installed in

   local
   
within the Normaliz directory.

1) Go to the source directory

2) Check the configuration in Makefile.configuration, especially the locations of
the optional packages and their versions.

3) Say 

        make -f Makefile.classic

It should work without change of Makefile.classic or Makefile.configuration on many systems
that have a system installation of the needed libraries. 
(We must use the name Makefile.classic since Makefile is occupied by autotools.) 

If everything is successful, then the executable file normaliz is
in the source directory. You may of course want to move them somewhere else.


Makefile.classic accepts optional arguments (also simultaneously):

        make -f Makefile.classic OPENMP=no  # deactivates OpenMP
        make -f Makefile.classic COCOA=no   # deactivates CoCoALib
        make -f Makefile.classic Flint=no   # deactivates Flint
        make -f Makefile.classic EANTIC=no  # deactivates e-antic
        make -f Makefile.classic NMZ_DEVELOP=no  # deactivates development version
        make -f Makefile.classic NMZ_EXTENDED_TESTS=yes  # activates extended tests

You must make sure that everything is compiled with the same set of options!
In doubt use "make -f Makefile.classic clean" beforehand.

Similarly

        make -f Makefile.classic maxsimplex

for the compilation of maxsimplex (in its directory, example for the use of libnormaliz
in the manual).

5) If you want to install Normaliz, Say 

        make -f Makefile.classic install
    
Installs Normaliz in "local".

6) Makefile.classic includes a target "clean". It will remove the compiled files (but not uninstall them) by 

        make -f Makefile.classic clean
