1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<script type="text/javascript"
src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
</script>
<title>GAP (nq) - Chapter 5: Installation of the Package</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<meta name="generator" content="GAPDoc2HTML" />
<link rel="stylesheet" type="text/css" href="manual.css" />
<script src="manual.js" type="text/javascript"></script>
<script type="text/javascript">overwriteStyle();</script>
</head>
<body class="chap5" onload="jscontent()">
<div class="chlinktop"><span class="chlink1">Goto Chapter: </span><a href="chap0_mj.html">Top</a> <a href="chap1_mj.html">1</a> <a href="chap2_mj.html">2</a> <a href="chap3_mj.html">3</a> <a href="chap4_mj.html">4</a> <a href="chap5_mj.html">5</a> <a href="chapA_mj.html">A</a> <a href="chapBib_mj.html">Bib</a> <a href="chapInd_mj.html">Ind</a> </div>
<div class="chlinkprevnexttop"> <a href="chap0_mj.html">[Top of Book]</a> <a href="chap0_mj.html#contents">[Contents]</a> <a href="chap4_mj.html">[Previous Chapter]</a> <a href="chapA_mj.html">[Next Chapter]</a> </div>
<p id="mathjaxlink" class="pcenter"><a href="chap5.html">[MathJax off]</a></p>
<p><a id="X79E1ED167D631DCC" name="X79E1ED167D631DCC"></a></p>
<div class="ChapSects"><a href="chap5_mj.html#X79E1ED167D631DCC">5 <span class="Heading">Installation of the Package</span></a>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap5_mj.html#X783433687E4C822A">5.1 <span class="Heading">Configuring for compilation</span></a>
</span>
</div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap5_mj.html#X83FF596582258A74">5.2 <span class="Heading">Compiling the nq binary</span></a>
</span>
</div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap5_mj.html#X7DE7E7187BE24368">5.3 <span class="Heading">Testing</span></a>
</span>
</div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap5_mj.html#X80D704CC7EBFDF7A">5.4 <span class="Heading">Feedback</span></a>
</span>
</div>
</div>
<h3>5 <span class="Heading">Installation of the Package</span></h3>
<p>Installation of the ANU NQ is done in two steps.</p>
<p><a id="X783433687E4C822A" name="X783433687E4C822A"></a></p>
<h4>5.1 <span class="Heading">Configuring for compilation</span></h4>
<p>First the configure script is run:</p>
<div class="example"><pre> ./configure </pre></div>
<p>If you installed the package in another "<code class="file">pkg</code>" directory than the standard "<code class="file">pkg</code>" directory in your <strong class="pkg">GAP</strong> 4 installation, then you have to do two things. Firstly during compilation you have to use the option <code class="code">--with-gaproot=PATH</code> of the <code class="file">configure</code> script where "PATH" is a path to the main <strong class="pkg">GAP</strong> root directory (if not given the default "<code class="file">../..</code>" is assumed). That is, run</p>
<div class="example"><pre> ./configure --with-gaproot=PATH </pre></div>
<p>Secondly you have to specify the path to the directory containing your "<code class="file">pkg</code>" directory to <strong class="pkg">GAP</strong>'s list of directories. This can be done by starting <strong class="pkg">GAP</strong> with the "<code class="file">-l</code>" 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 <strong class="pkg">GAP</strong>. Of course, you can add this option to your <strong class="pkg">GAP</strong> startup script.</p>
<p>Another issue that can occur when running <code class="file">configure</code> is that it may fail to locate the the GNU multiple precision library (GMP <a href="chapBib_mj.html#biBGNUMP">[GMP]</a>) which ANU NQ requires to work. This library is also used by <strong class="pkg">GAP</strong> 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 <span class="URL"><a href="https://gmplib.org/">https://gmplib.org/</a></span>.</p>
<p>In order for the <code class="file">configure</code> script to find your copy of GMP, you may have tell it where to find it via <code class="code">--with-gmp=PATH</code>, where "PATH" is the path where GMP was installed:</p>
<div class="example"><pre> ./configure --with-gmp=PATH </pre></div>
<p>If necessary, you may combine <code class="code">--with-gmp</code> and <code class="code">--with-gaproot</code>.</p>
<p><a id="X83FF596582258A74" name="X83FF596582258A74"></a></p>
<h4>5.2 <span class="Heading">Compiling the nq binary</span></h4>
<p>If <code class="file">configure</code> reports no problems, the next step is to start the compilation:</p>
<div class="example"><pre> make </pre></div>
<p>A compiled version of the program named <code class="file">nq</code> is then placed into the directory <code class="file">bin/<complicated name></code>. 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.</p>
<p>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 <a href="chap5_mj.html#X80D704CC7EBFDF7A"><span class="RefLink">5.4</span></a></p>
<p><a id="X7DE7E7187BE24368" name="X7DE7E7187BE24368"></a></p>
<h4>5.3 <span class="Heading">Testing</span></h4>
<p>After the compilation is finished you can check if the ANU NQ is running properly on your system. Simply type</p>
<div class="example"><pre> make test </pre></div>
<p>This runs some computations and compares their output with the output files in the directory <code class="file">examples</code>. If any errors are reported, please follow the instructions below.</p>
<p><a id="X80D704CC7EBFDF7A" name="X80D704CC7EBFDF7A"></a></p>
<h4>5.4 <span class="Heading">Feedback</span></h4>
<p>If you encounter problems with any of the above steps, please do not hesitate to contact us about this. You can either use the <span class="URL"><a href="https://github.com/gap-system/nq/issues">nq issue tracker</a></span> or contact the GAP support group via <span class="URL"><a href="mailto:support@gap-system.org">support@gap-system.org</a></span>. 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 <strong class="pkg">GAP</strong> and this package that were involved.</p>
<div class="chlinkprevnextbot"> <a href="chap0_mj.html">[Top of Book]</a> <a href="chap0_mj.html#contents">[Contents]</a> <a href="chap4_mj.html">[Previous Chapter]</a> <a href="chapA_mj.html">[Next Chapter]</a> </div>
<div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0_mj.html">Top</a> <a href="chap1_mj.html">1</a> <a href="chap2_mj.html">2</a> <a href="chap3_mj.html">3</a> <a href="chap4_mj.html">4</a> <a href="chap5_mj.html">5</a> <a href="chapA_mj.html">A</a> <a href="chapBib_mj.html">Bib</a> <a href="chapInd_mj.html">Ind</a> </div>
<hr />
<p class="foot">generated by <a href="http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
</body>
</html>
|
