<?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>
<title>GAP (Ferret) - Chapter 3: Installing and Loading the Ferret 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="chap3"  onload="jscontent()">


<div class="chlinktop"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chap3.html">3</a>  <a href="chapInd.html">Ind</a>  </div>

<div class="chlinkprevnexttop"> <a href="chap0.html">[Top of Book]</a>   <a href="chap0.html#contents">[Contents]</a>    <a href="chap2.html">[Previous Chapter]</a>    <a href="chapInd.html">[Next Chapter]</a>   </div>

<p id="mathjaxlink" class="pcenter"><a href="chap3_mj.html">[MathJax on]</a></p>
<p><a id="X782C0DD47E1D28EF" name="X782C0DD47E1D28EF"></a></p>
<div class="ChapSects"><a href="chap3.html#X782C0DD47E1D28EF">3 <span class="Heading">Installing and Loading the Ferret Package</span></a>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap3.html#X8527DE187ADA7D7A">3.1 <span class="Heading">Unpacking the Ferret Package</span></a>
</span>
</div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap3.html#X7DB615628530240D">3.2 <span class="Heading">Compiling Binaries of the Ferret Package</span></a>
</span>
</div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap3.html#X7BA03640834E607E">3.3 <span class="Heading">Loading the Ferret Package</span></a>
</span>
</div>
</div>

<h3>3 <span class="Heading">Installing and Loading the Ferret Package</span></h3>

<p><a id="X8527DE187ADA7D7A" name="X8527DE187ADA7D7A"></a></p>

<h4>3.1 <span class="Heading">Unpacking the Ferret Package</span></h4>

<p>If the Ferret package was obtained as a part of the <strong class="pkg">GAP</strong> distribution from the <q>Download</q> section of the <strong class="pkg">GAP</strong> website, you may proceed to Section <a href="chap3.html#X7DB615628530240D"><span class="RefLink">3.2</span></a>. Alternatively, the Ferret package may be installed using a separate archive, for example, for an update or an installation in a non-default location (see <a href="/home/runner/gap/doc/ref/chap9.html#X7A4973627A5DB27D"><span class="RefLink">Reference: GAP Root Directories</span></a>).</p>

<p>Below we describe the installation procedure for the <code class="file">.tar.gz</code> archive format. Installation using other archive formats is performed in a similar way.</p>

<p>It may be unpacked in one of the following locations:</p>


<ul>
<li><p>in the <code class="file">pkg</code> directory of your <strong class="pkg">GAP</strong> 4 installation;</p>

</li>
<li><p>or in a directory named <code class="file">.gap/pkg</code> in your home directory (to be added to the <strong class="pkg">GAP</strong> root directory unless <strong class="pkg">GAP</strong> is started with <code class="code">-r</code> option);</p>

</li>
<li><p>or in a directory named <code class="file">pkg</code> in another directory of your choice (e.g. in the directory <code class="file">mygap</code> in your home directory).</p>

</li>
</ul>
<p>In the latter case one one must start <strong class="pkg">GAP</strong> with the <code class="code">-l</code> option, e.g. if your private <code class="file">pkg</code> directory is a subdirectory of <code class="file">mygap</code> in your home directory you might type:</p>

<p>  <code class="code">gap -l ";<var class="Arg">myhomedir</var>/mygap"</code></p>

<p>where <var class="Arg">myhomedir</var> is the path to your home directory, which (since <strong class="pkg">GAP</strong> 4.3) may be replaced by a tilde (the empty path before the semicolon is filled in by the default path of the <strong class="pkg">GAP</strong> 4 home directory).</p>

<p><a id="X7DB615628530240D" name="X7DB615628530240D"></a></p>

<h4>3.2 <span class="Heading">Compiling Binaries of the Ferret Package</span></h4>

<p>After unpacking the archive, go to the newly created <code class="file">ferret</code> directory and call <code class="code">./configure</code> to use the default <code class="code">../..</code> path to the <strong class="pkg">GAP</strong> home directory or <code class="code">./configure <var class="Arg">path</var></code> where <var class="Arg">path</var> is the path to the <strong class="pkg">GAP</strong> home directory, if the package is being installed in a non-default location. So for example if you install the package in the <code class="file">~/.gap/pkg</code> directory and the <strong class="pkg">GAP</strong> home directory is <code class="file">~/gap4r5</code> then you have to call</p>


<div class="example"><pre>
./configure ../../../gap4r5/
</pre></div>

<p>This will fetch the architecture type for which <strong class="pkg">GAP</strong> has been compiled last and create a <code class="file">Makefile</code>. Now simply call</p>


<div class="example"><pre>
make
</pre></div>

<p>to compile the binary and to install it in the appropriate place.</p>

<p><a id="X7BA03640834E607E" name="X7BA03640834E607E"></a></p>

<h4>3.3 <span class="Heading">Loading the Ferret Package</span></h4>

<p>To use the Ferret Package you have to request it explicitly. This is done by calling <code class="func">LoadPackage</code> (<a href="/home/runner/gap/doc/ref/chap76.html#X79B373A77B29D1F5"><span class="RefLink">Reference: LoadPackage</span></a>):</p>


<div class="example"><pre>
<span class="GAPprompt">gap></span> <span class="GAPinput">LoadPackage("ferret");</span>
true
</pre></div>

<p>If you want to load the Ferret package by default, you can put the <code class="code">LoadPackage</code> command into your <code class="file">gaprc</code> file (see Section <a href="/home/runner/gap/doc/ref/chap3.html#X7FD66F977A3B02DF"><span class="RefLink">Reference: The gap.ini and gaprc files</span></a>).</p>


<div class="chlinkprevnextbot"> <a href="chap0.html">[Top of Book]</a>   <a href="chap0.html#contents">[Contents]</a>    <a href="chap2.html">[Previous Chapter]</a>    <a href="chapInd.html">[Next Chapter]</a>   </div>


<div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chap3.html">3</a>  <a href="chapInd.html">Ind</a>  </div>

<hr />
<p class="foot">generated by <a href="https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
</body>
</html>