<h4>2.1 <span class="Heading">For those in a hurry</span></h4>
<p>In this section we give a brief description of how to start using <strong class="pkg">Digraphs</strong>.</p>
<p>It is assumed that you have a working copy of <strong class="pkg">GAP</strong> with version number 4.10.0 or higher. The most up-to-date version of <strong class="pkg">GAP</strong> and instructions on how to install it can be obtained from the main <strong class="pkg">GAP</strong> webpage <spanclass="URL"><a href="https://www.gap-system.org">https://www.gap-system.org</a></span>.</p>
<p>The following is a summary of the steps that should lead to a successful installation of <strongclass="pkg">Digraphs</strong>:</p>
<ul>
<li><p>ensure that the <span class="URL"><a href="https://gap-packages.github.io/io">IO</a></span> package version 4.5.1 or higher is available. <span class="URL"><a href="https://gap-packages.github.io/io">IO</a></span> must be compiled before <strong class="pkg">Digraphs</strong> can be loaded.</p>
</li>
<li><p>ensure that the <strong class="pkg">orb</strong> package version 4.8.2 or higher is available. <strong class="pkg">orb</strong> has better performance when compiled, but although compilation is recommended, it is not required to be compiled for <strong class="pkg">Digraphs</strong> to be loaded.</p>
</li>
<li><p>ensure that the <strong class="pkg">datastructures</strong> package version 0.2.5 or higher is available.</p>
</li>
<li><p><strong class="button">This step is optional:</strong> certain functions in <strong class="pkg">Digraphs</strong> require the <span class="URL"><a href="https://gap-packages.github.io/grape">GRAPE</a></span> package to be available; see Section <a href="chap2.html#X8493C7587FCF6D8B"><span class="RefLink">2.2-1</span></a> for full details. To use these functions make sure that the <span class="URL"><a href="https://gap-packages.github.io/grape">GRAPE</a></span> package version 4.8.1 or higher is available. If <span class="URL"><a href="https://gap-packages.github.io/grape">GRAPE</a></span> is not available, then <strong class="pkg">Digraphs</strong> can be used as normal with the exception that the functions listed in Subsection <a href="chap2.html#X8493C7587FCF6D8B"><span class="RefLink">2.2-1</span></a> will not work.</p>
</li>
<li><p><strong class="button">This step is optional:</strong> certain functions in <strong class="pkg">Digraphs</strong> require the <span class="URL"><a href="https://github.com/gap-packages/NautyTracesInterface">NautyTracesInterface</a></span> package to be available. If you want to make use of these functions, please ensure that the <span class="URL"><a href="https://github.com/gap-packages/NautyTracesInterface">NautyTracesInterface</a></span> package version 0.2 or higher is available. If <span class="URL"><a href="https://github.com/gap-packages/NautyTracesInterface">NautyTracesInterface</a></span> is not available, then <strong class="pkg">Digraphs</strong> can be used as normal with the exception that functions whose names contain <q>Nauty</q> will not work.</p>
</li>
<li><p>download the package archive <code class="file">digraphs-1.13.1.tar.gz.tar.gz</code> from <span class="URL"><a href="https://digraphs.github.io/Digraphs/">the Digraphs package webpage</a></span>.</p>
</li>
<li><p>unzip and untar the file, this should create a directory called <code class="file">digraphs-1.13.1.tar.gz</code>.</p>
</li>
<li><p>locate the <code class="file">pkg</code> directory of your <strong class="pkg">GAP</strong> directory, which contains the directories <code class="file">lib</code>, <code class="file">doc</code> and so on. Move the directory <code class="file">digraphs-1.13.1.tar.gz</code> into the <codeclass="file">pkg</code> directory.</p>
</li>
<li><p>it is necessary to compile the <strong class="pkg">Digraphs</strong> package. Inside the <code class="file">pkg/digraphs-1.13.1.tar.gz</code> directory, type</p>
</li>
</ul>
<p>If you want to check that the package is working correctly, you should run some of the tests described in Section <a href="chap2.html#X7862D3F37C5BBDEF"><span class="RefLink">2.5</span></a>.</p>
<p>The <strong class="pkg">Digraphs</strong> package is written in <strong class="pkg">GAP</strong> and C code and requires the <span class="URL"><a href="https://gap-packages.github.io/io">IO</a></span> package. The <span class="URL"><a href="https://gap-packages.github.io/io">IO</a></span> package is used to read and write transformations, partial permutations, and bipartitions to a file.</p>
<p>The <span class="URL"><a href="https://gap-packages.github.io/grape">GRAPE</a></span> package must be available for the following operations to be available:</p>
<ul>
<li><p><code class="func">Graph</code> (<a href="chap3.html#X7B335342839E5146"><span class="RefLink">3.2-3</span></a>) with a digraph argument</p>
</li>
<li><p><code class="func">AsGraph</code> (<a href="chap3.html#X7C4F13E080EC16B0"><span class="RefLink">3.2-4</span></a>) with a digraph argument</p>
</li>
<li><p><code class="func">Digraph</code> (<a href="chap3.html#X834843057CE86655"><span class="RefLink">3.1-7</span></a>) with a <span class="URL"><a href="https://gap-packages.github.io/grape">GRAPE</a></span> graph argument</p>
</li>
</ul>
<p>If <span class="URL"><a href="https://gap-packages.github.io/grape">GRAPE</a></span> is not available, then <strong class="pkg">Digraphs</strong> can be used as normal with the exception that the functions above will not work.</p>
<h4>2.3 <span class="Heading">Compiling the kernel module</span></h4>
<p>The <strong class="pkg">Digraphs</strong> package has a <strong class="pkg">GAP</strong> kernel component in C which should be compiled. This component contains certain low-level functions required by <strong class="pkg">Digraphs</strong>.</p>
<p>It is not possible to use the <strong class="pkg">Digraphs</strong> package without compiling it.</p>
<p>To compile the kernel component inside the <code class="file">pkg/digraphs-1.13.1.tar.gz</code> directory, type</p>
<div class="example"><pre>
./configure
make</pre></div>
<p>If you installed the package in another 'pkg' directory than the standard 'pkg' directory in your <strong class="pkg">GAP</strong> 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).</p>
<p>If you installed <strong class="pkg">GAP</strong> on several architectures, you must execute the configure/make step for each of the architectures. You can either do this immediately after configuring and compiling GAP itself on this architecture, or alternatively set the environment variable 'CONFIGNAME' to the name of the configuration you used when compiling GAP before running './configure'. Note however that your compiler choice and flags (environment variables 'CC' and 'CFLAGS') need to be chosen to match the setup of the original GAP compilation. For example you have to specify 32-bit or 64-bit mode correctly!</p>
<h4>2.4 <span class="Heading">Rebuilding the documentation</span></h4>
<p>The <strong class="pkg">Digraphs</strong> package comes complete with pdf, html, and text versions of the documentation. However, you might find it necessary, at some point, to rebuild the documentation. To rebuild the documentation, please use the function <code class="func">DigraphsMakeDoc</code> (<a href="chap2.html#X870631C38610AC25"><span class="RefLink">2.4-1</span></a>).</p>
<h4>2.5 <span class="Heading">Testing your installation</span></h4>
<p>In this section we describe how to test that <strong class="pkg">Digraphs</strong> is working as intended. To test that <strong class="pkg">Digraphs</strong> is installed correctly use <code class="func">DigraphsTestInstall</code> (<a href="chap2.html#X86AF4DAE80B978DA"><span class="RefLink">2.5-1</span></a>) or for more extensive tests use <code class="func">DigraphsTestStandard</code> (<a href="chap2.html#X7A20088B7C406C4A"><span class="RefLink">2.5-2</span></a>).</p>
<p>If something goes wrong, then please review the instructions in Section <a href="chap2.html#X7DA3059C79842BF3"><span class="RefLink">2.1</span></a> and ensure that <strong class="pkg">Digraphs</strong> has been properly installed. If you continue having problems, please use the <span class="URL"><a href="https://github.com/digraphs/Digraphs/issues">issue tracker</a></span> to report the issues you are having.</p>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ DigraphsTestInstall</code>( )</td><td class="tdright">( function )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> or <code class="keyw">false</code>.</p>
<p>This function can be called without arguments to test your installation of <strong class="pkg">Digraphs</strong> is working correctly. These tests should take no more than a few seconds to complete. To test more comprehensively that <strong class="pkg">Digraphs</strong> is working correctly, use <code class="func">DigraphsTestStandard</code> (<a href="chap2.html#X7A20088B7C406C4A"><span class="RefLink">2.5-2</span></a>).</p>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ DigraphsTestStandard</code>( )</td><td class="tdright">( function )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> or <code class="keyw">false</code>.</p>
<p>This function can be called without arguments to test all of the methods included in <strong class="pkg">Digraphs</strong>. These tests should take less than a minute to complete.</p>
<p>To quickly test that <strong class="pkg">Digraphs</strong> is installed correctly use <code class="func">DigraphsTestInstall</code> (<a href="chap2.html#X86AF4DAE80B978DA"><span class="RefLink">2.5-1</span></a>). For a more thorough test, use <code class="func">DigraphsTestExtreme</code> (<a href="chap2.html#X7885EF3E785D4298"><span class="RefLink">2.5-3</span></a>).</p>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">‣ DigraphsTestExtreme</code>( )</td><td class="tdright">( function )</td></tr></table></div>
<p>Returns: <code class="keyw">true</code> or <code class="keyw">false</code>.</p>
<p>This function should be called with no argument. It executes a series of very demanding tests, which measure the performance of a variety of functions on large examples. These tests take a long time to complete, at least several minutes.</p>
<p>For these tests to complete, the digraphs library <code class="code">digraphs-lib</code> must be downloaded and placed in the <code class="code">digraphs</code> directory in a subfolder named <code class="file">digraphs-lib</code>. This library can be found on the <strong class="pkg">Digraphs</strong> website.</p>
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung ist noch experimentell.
