GAP (orb) - Chapter 2: Installation of the orb-Package

Goto Chapter: Top 1 2 3 4 5 6 7 8 9 10 11 Bib Ind
[Top of Book] [Contents] [Previous Chapter] [Next Chapter]

[MathJax off]

2 Installation of the orb-Package
2.1 Recompiling the documentation

### 2 Installation of the orb-Package

To install this package just extract the package's archive file to the GAP `pkg` directory.

By default the orb package is not automatically loaded by GAP when it is installed. You must load the package with `LoadPackage("orb");` before its functions become available.

As of version 3.0, the orb package has a GAP kernel component which should be compiled. This component does not actually contain new functionality but will improve the performance of AVL trees and hash tables significantly since many core routines are implemented in the C language at kernel level.

To compile the C part of the package do (in the `pkg` directory)

        cd orb
        ./configure
        make

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).

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.

If you installed GAP 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 (when using version 4.5 of GAP or newer) 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!

#### 2.1 Recompiling the documentation

Recompiling the documentation is possible by the command "`gap makedoc.g`" in the `orb` directory. But this should not be necessary.

[Top of Book] [Contents] [Previous Chapter] [Next Chapter]
Goto Chapter: Top 1 2 3 4 5 6 7 8 9 10 11 Bib Ind

generated by GAPDoc2HTML