GAP (nq) - Chapter 5: Installation of the Package

Goto Chapter: Top 1 2 3 4 5 A Bib Ind
[Top of Book] [Contents] [Previous Chapter] [Next Chapter]

[MathJax off]

5 Installation of the Package
5.1 Configuring for compilation
5.2 Compiling the nq binary
5.3 Testing
5.4 Feedback

### 5 Installation of the Package

Installation of the ANU NQ is done in two steps.

#### 5.1 Configuring for compilation

First the configure script is run:

     ./configure

If you installed the package in another "`pkg`" directory than the standard "`pkg`" directory in your GAP 4 installation, then you have to do two things. Firstly during compilation you have to use the option `--with-gaproot=PATH` of the `configure` script where "PATH" is a path to the main GAP root directory (if not given the default "`../..`" is assumed). That is, run

     ./configure --with-gaproot=PATH

Secondly you have to specify the path to the directory containing your "`pkg`" directory to GAP's list of directories. This can be done by starting GAP with the "`-l`" command line option followed by the name of the directory and a semicolon. Then your directory is prepended to the list of directories searched. Otherwise the package is not found by GAP. Of course, you can add this option to your GAP startup script.

Another issue that can occur when running `configure` is that it may fail to locate the the GNU multiple precision library (GMP [GMP]) which ANU NQ requires to work. This library is also used by GAP and hence normally should be available on your system anyway. But if this is not the case for some reason, it has to be installed first. A copy of GMP can be obtained from https://gmplib.org/.

In order for the `configure` script to find your copy of GMP, you may have tell it where to find it via `--with-gmp=PATH`, where "PATH" is the path where GMP was installed:

     ./configure --with-gmp=PATH

If necessary, you may combine `--with-gmp` and `--with-gaproot`.

#### 5.2 Compiling the nq binary

If `configure` reports no problems, the next step is to start the compilation:

     make

A compiled version of the program named `nq` is then placed into the directory `bin/<complicated name>`. The <complicated name> component encodes the operating system and the compiler used. This allows you to compile NQ on several architectures sharing the same files system.

If there are any warnings or even fatal error messages during the compilation process, please submit a bug report about that following the instructions in Section 5.4

#### 5.3 Testing

After the compilation is finished you can check if the ANU NQ is running properly on your system. Simply type

     make test

This runs some computations and compares their output with the output files in the directory `examples`. If any errors are reported, please follow the instructions below.

#### 5.4 Feedback

If you encounter problems with any of the above steps, please do not hesitate to contact us about this. You can either use the nq issue tracker or contact the GAP support group via support@gap-system.org. Please make sure to include information about the specific issue you encountered (e.g. steps to reproduce it, the specific error message), your operating system, the compiler you used and also the versions of GAP and this package that were involved.

[Top of Book] [Contents] [Previous Chapter] [Next Chapter]
Goto Chapter: Top 1 2 3 4 5 A Bib Ind

generated by GAPDoc2HTML