|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | 03-May-2022 | - |
| doc/ | H | 03-May-2022 | - | 15,573 | 12,259 |
| lib/ | H | 03-May-2022 | - | 21,240 | 19,069 |
| src/ | H | 03-May-2022 | - | 43,252 | 33,404 |
| tbl/ | H | 03-May-2022 | - | 28,059 | 27,844 |
| tst/ | H | 03-May-2022 | - | 5,117 | 4,735 |
| CHANGES.guava | H A D | 03-May-2022 | 12.3 KiB | 293 | 258 |
| COPYING.guava | H A D | 03-May-2022 | 50 KiB | 986 | 808 |
| HISTORY.guava | H A D | 03-May-2022 | 2 KiB | 48 | 35 |
| Makefile.in | H A D | 03-May-2022 | 2.7 KiB | 75 | 55 |
| PackageInfo.g | H A D | 03-May-2022 | 12.2 KiB | 308 | 281 |
| README.guava | H A D | 03-May-2022 | 4.9 KiB | 132 | 100 |
| README.md | H A D | 03-May-2022 | 360 | 8 | 5 |
| configure | H A D | 03-May-2022 | 1.2 KiB | 42 | 30 |
| init.g | H A D | 03-May-2022 | 1.3 KiB | 30 | 28 |
| makedoc.g | H A D | 03-May-2022 | 2 KiB | 68 | 58 |
| read.g | H A D | 03-May-2022 | 1.4 KiB | 34 | 31 |
README.guava
1 The GUAVA Coding Theory Package
2 -------------------------------
3
4GUAVA is a package that implements coding theory algorithms
5in GAP. With GUAVA, codes can be created and manipulated
6and information about these codes can be calculated.
7
8GUAVA consists of various files written in the GAP language,
9and an external program from J.S. Leon for dealing with
10automorphism groups of codes and isomorphism testing
11functions. Several algorithms that need the speed are
12integrated in the GAP kernel. Please send your bug reports
13and feature requests to support@gap-system.org. You can
14also create an "issue" at the GUAVA github repository.
15See the section "Bug reports" below.
16
17For an overview of the history of the GUAVA project see the
18file "HISTORY.guava" in the main GUAVA package directory.
19
20 Installing GUAVA
21 ----------------
22A fresh installation of GAP 4.7 or higher will include Guava
23automatically in the system `pkg' directory (typically
24something like /usr/lib/gap4r7/pkg on unix machines.) The
25backtrack programs which compute code automorphism groups
26may need to be compiled (see below).
27
28If GUAVA is not present (a call to LoadPackage("guava")
29fails at a GAP prompt.) You may need to install GUAVA (as
30a GAP4 Package) as a separate step. Unpack the archive
31file in a directory in the `pkg' hierarchy of your version
32of GAP4. (This might be the `pkg' directory of the GAP4
33home directory; it is however also possible to keep an
34additional `pkg' directory in your private directories, see
35section "Installing GAP Packages" of the GAP4 reference
36manual for details on how to do this.)
37
38After unpacking GUAVA the GAP-only part of GUAVA is
39installed. The parts of GUAVA depending on J. S. Leon's
40backtrack programs package (for computing automorphism
41groups and code equivalence) need to be compiled separately.
42For Windows machines it will probably be necessary to
43install additional software -- instructions are available
44at the Guava website.
45
46In a UNIX or MacOS environment. You should proceed as
47follows:
48
49Go to the newly created `guava' directory and call
50`./configure <path>' where <path> is the path to the GAP
51home directory. So for example, if you install the package
52in the main `pkg' directory call
53
54 ./configure ../..
55
56(For rpm-based 64-bit linux machines, such as suse or
57redhat, you may need
58
59 ./configure ../.. --enable-libsuffix=64
60
61instead.)
62
63This will fetch the architecture type for which GAP has been
64compiled last and create a `Makefile'. Now call
65
66 make
67
68to compile the binaries and to install them in the
69appropriate place.
70
71This completes the installation of GUAVA for a single
72architecture. If you use this installation of GUAVA on
73different hardware platforms you will have to compile the
74binaries for each platform separately. This is done by
75calling `configure' and `make' for the package anew
76immediately after compiling GAP itself for the respective
77architecture. If your version of GAP is already compiled
78(and has last been compiled on the same architecture) you
79do not need to compile GAP again; it is sufficient to call
80the `configure' script in the GAP home directory.
81
82 Loading GUAVA
83 -------------
84
85After starting up GAP, the GUAVA package needs to be
86loaded. Load GUAVA by typing at the GAP prompt:
87
88 gap> LoadPackage( "guava" );
89
90If GUAVA isn't already in memory, it is loaded and its
91beautiful banner is displayed.
92
93If you are a frequent user of GUAVA, you might consider
94putting this line in your `gaprc' file, or add GUAVA to the
95"PackagesToLoad" preference in your gap.ini file (the
96location of the ini file can be determined by typing
97
98 gap> GAPInfo.UserGapRoot;
99
100at the gap prompt.
101
102Additionally, you may wish to test the installation by
103reading in the Guava test file:
104
105 gap> Test(Filename(DirectoriesPackageLibrary("guava", "tst"), "guava.tst"));
106
107 Bug reports
108 -----------
109
110The preferred method for bug reports and feature requests
111is to raise an issue at the GUAVA GitHub repository:
112
113 https://github.com/gap-packages/guava/issues
114
115Alternatively, you are welcome to send bug reports and
116other requests via email to support@gap-system.org.
117Remember we will need to be able to reproduce the problem;
118so please include:
119
120 * The version of GAP you are using; either look at the header when
121 you start up GAP, or at the gap> prompt type: GAPInfo.Version;
122 * The operating system you are using e.g. Linux, SunOS 5.8 = Solaris
123 2.8, IRIX 6.5, MacOS, Windows, ...
124 * The compiler (if any) you used to compile the binaries and the options
125 you used. Type: gcc -v or: cc -version.
126 * A script that demonstrates the bug, along with a description of why
127 it's a bug (e.g. by adding comments to the script - recall
128 comments in GAP begin with a #).
129
130 - Joe Fields (fieldsj1@southernct.edu)
131 April, 2018
132
){kind=link}
){kind=link}