<?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 (polymaking) - Chapter 1: Installation and Preface</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" />
</head>
<body>
<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="chap4.html">4</a> <a href="chapBib.html">Bib</a> <a href="chapInd.html">Ind</a> </div>
<div class="chlinkprevnexttop"> <a href="chap0.html">Top of Book</a> <a href="chap0.html">Previous Chapter</a> <a href="chap2.html">Next Chapter</a> </div>
<p><a id="X8794FBB27B46C08E" name="X8794FBB27B46C08E"></a></p>
<div class="ChapSects"><a href="chap1.html#X8794FBB27B46C08E">1. <span class="Heading">Installation and Preface</span></a>
<div class="ContSect"><span class="nocss"> </span><a href="chap1.html#X7A02C64B7A3777FF">1.1 <span class="Heading">A few words about the installation of polymake</span></a>
</div>
<div class="ContSect"><span class="nocss"> </span><a href="chap1.html#X851C596486F918F0">1.2 <span class="Heading">Setting variables for external programs</span></a>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap1.html#X794A38E981F9E76F">1.2-1 SetPolymakeDataDirectory</a></span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap1.html#X854645287BC9303E">1.2-2 SetPolymakeCommand</a></span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap1.html#X862304F37C28FE78">1.2-3 SetPolymakeClientPaths</a></span>
<span class="ContSS"><br /><span class="nocss"> </span><a href="chap1.html#X7943B579846BDB76">1.2-4 <span class="Heading">Setting variables permanently</span></a>
</span>
</div>
</div>
<h3>1. <span class="Heading">Installation and Preface</span></h3>
<p>To install the package, just unpack it in your packages directory (usually <code class="code">~/gap/pkg</code> for local installation). To use <strong class="pkg">polymaking</strong>, you need a working installation of the program polymake <span class="URL"><a href="http://www.math.tu-berlin.de/polymake/">http://www.math.tu-berlin.de/polymake/</a></span>. The package has been tested on linux and Mac OS X (10.4 and 10.5). But it should be as platform independent as <strong class="pkg">GAP</strong> and polymake.</p>
<p>The interaction with polymake is restricted to writing files and carrying out simple operations looking like <br /> <code class="code">polymake file KEYWORD1 KEYWORD2 KEYWORD3</code> <br /> on the command line. Scripts are not supported. From vertsion 0.7.2 on, there is limited client-support. All clients that are called like <br /> <code class="code">client outfile infile1 infile2 ... -option1 -option2</code> <br /> can now be called from <strong class="pkg">GAP</strong> via <code class="func">PolymakeClient</code> (<a href="chap2.html#X7B7BFA407F54D37E"><b>2.7-1</b></a>).</p>
<p><a id="X7A02C64B7A3777FF" name="X7A02C64B7A3777FF"></a></p>
<h4>1.1 <span class="Heading">A few words about the installation of polymake</span></h4>
<p><strong class="pkg">polymaking</strong> will try to guess the location of polymake. If this fails, a warning is issued at load time (<code class="keyw">InfoWarning</code> level 1). Note that the guessing procedure is suppressed when <code class="func">POLYMAKE_COMMAND</code> (<a href="chap3.html#X7B35A5217C8C7B04"><b>3.2-1</b></a>) is set manually (see <a href="chap1.html#X7943B579846BDB76"><b>1.2-4</b></a>). <br /> Note that polymake calls other external functions ("clients") to do some work for it. These functions must be either in the path from which GAP was called or in a path listed in the <code class="keyw">PATH</code> environment variable. You can set it using the shell command <br /> <code class="code">setenv PATH ${PATH}:<your polymakepath></code> <br /> The general rule is: If <strong class="pkg">polymaking</strong> finds polymake by itself, there is nothing to worry about.</p>
<p><a id="X851C596486F918F0" name="X851C596486F918F0"></a></p>
<h4>1.2 <span class="Heading">Setting variables for external programs</span></h4>
<p>As <strong class="pkg">polymaking</strong> uses the program polymake, it needs to know where this program lives. The communication with polymake is done by writing files for polymake and reading its output (as returned to standard output "the prompt"). Note that the interface does not read any polymake file.</p>
<p><a id="X794A38E981F9E76F" name="X794A38E981F9E76F"></a></p>
<h5>1.2-1 SetPolymakeDataDirectory</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">> SetPolymakeDataDirectory</code>( <var class="Arg">dir</var> )</td><td class="tdright">( method )</td></tr></table></div>
<p>Sets the directory in which all polymake files are created to <var class="Arg">dir</var>. The standard place for these files is a temporary directory generated when the package is loaded. This manipulates <code class="func">POLYMAKE_DATA_DIR</code> (<a href="chap3.html#X7C07B16B873BA46D"><b>3.2-2</b></a>).</p>
<p><a id="X854645287BC9303E" name="X854645287BC9303E"></a></p>
<h5>1.2-2 SetPolymakeCommand</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">> SetPolymakeCommand</code>( <var class="Arg">command</var> )</td><td class="tdright">( method )</td></tr></table></div>
<p>Sets the name for the polymake program to <var class="Arg">command</var>. This manipulates <code class="func">POLYMAKE_COMMAND</code> (<a href="chap3.html#X7B35A5217C8C7B04"><b>3.2-1</b></a>).</p>
<p><a id="X862304F37C28FE78" name="X862304F37C28FE78"></a></p>
<h5>1.2-3 SetPolymakeClientPaths</h5>
<div class="func"><table class="func" width="100%"><tr><td class="tdleft"><code class="func">> SetPolymakeClientPaths</code>( <var class="Arg">dirs</var> )</td><td class="tdright">( method )</td></tr></table></div>
<p>Defines directories which contain polymake client programs. <code class="code">SetPolymakeClientPaths(dirs)</code> sets <code class="func">POLYMAKE_CLIENT_PATHS</code> (<a href="chap3.html#X875BDBAE8075192A"><b>3.2-3</b></a>) to <var class="Arg">dirs</var> which has to be a list of directory objects.</p>
<p><a id="X7943B579846BDB76" name="X7943B579846BDB76"></a></p>
<h5>1.2-4 <span class="Heading">Setting variables permanently</span></h5>
<p>To permanently set the values of <code class="func">POLYMAKE_COMMAND</code> (<a href="chap3.html#X7B35A5217C8C7B04"><b>3.2-1</b></a>), <code class="func">POLYMAKE_CLIENT_PATHS</code> (<a href="chap3.html#X875BDBAE8075192A"><b>3.2-3</b></a>) and <code class="func">POLYMAKE_DATA_DIR</code> (<a href="chap3.html#X7C07B16B873BA46D"><b>3.2-2</b></a>), add the lines</p>
<table class="example">
<tr><td><pre>
POLYMAKE_DATA_DIR:=Directory("/home/mypolymakedatadir");
POLYMAKE_COMMAND:=Filename(Directory("/home/mypolymakebindir/"),"polymake");
POLYMAKE_CLIENT_DIRS:=[Directory("/home/myclients/"),Directory("/home/moreclients/")];
</pre></td></tr></table>
<p>to your <code class="file">.gaprc</code> file (see <a href="/usr/local/lib/gap4r4/doc/htm/ref/CHAP003.htm#SECT004"><b>Reference: The .gaprc file</b></a>). Note that these have to be <em>before</em> the <code class="code">LoadPackage("polymaking");</code> line. Or you can change the values of the above variables by editing <code class="file">lib/environment.gi</code></p>
<div class="chlinkprevnextbot"> <a href="chap0.html">Top of Book</a> <a href="chap0.html">Previous Chapter</a> <a href="chap2.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="chap4.html">4</a> <a href="chapBib.html">Bib</a> <a href="chapInd.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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
5e1854624d3bc613bdd0dd13d1ef9ac7
>
files
>
2720
