1#############################################################################
2##
3##  PackageInfo.g                  NQ                           Werner Nickel
4##
5##  Based on Frank Lübeck's template for PackageInfo.g.
6##
7
8SetPackageInfo( rec(
9
10PackageName := "nq",
11Subtitle := "Nilpotent Quotients of Finitely Presented Groups",
12Version := "2.5.4",
13Date    := "15/02/2019", # dd/mm/yyyy format
14License := "GPL-2.0-or-later",
15
16Persons := [
17  rec( LastName      := "Horn",
18       FirstNames    := "Max",
19       IsAuthor      := false,
20       IsMaintainer  := true,
21       Email         := "max.horn@math.uni-giessen.de",
22       WWWHome       := "https://www.quendi.de/math",
23       PostalAddress := Concatenation( "AG Algebra\n",
24                                       "Mathematisches Institut\n",
25                                       "Justus-Liebig-Universität Gießen\n",
26                                       "Arndtstraße 2\n",
27                                       "35392 Gießen\n",
28                                       "Germany" ),
29       Place         := "Gießen, Germany",
30       Institution   := "Justus-Liebig-Universität Gießen"
31     ),
32
33  rec( LastName      := "Nickel",
34       FirstNames    := "Werner",
35       IsAuthor      := true,
36       IsMaintainer  := false,
37       # MH: Werner rarely (if at all) replies to emails sent to this
38       # old email address. To discourage users from sending bug reports
39       # there, I have disabled it here.
40       #Email         := "nickel@mathematik.tu-darmstadt.de",
41       WWWHome       := "http://www.mathematik.tu-darmstadt.de/~nickel/",
42     )
43
44],
45
46Status         := "accepted",
47CommunicatedBy := "Joachim Neubüser (RWTH Aachen)",
48AcceptDate     := "01/2003",
49
50PackageWWWHome := "https://gap-packages.github.io/nq/",
51README_URL     := Concatenation(~.PackageWWWHome, "README"),
52PackageInfoURL := Concatenation(~.PackageWWWHome, "PackageInfo.g"),
53ArchiveURL     := Concatenation("https://github.com/gap-packages/nq/",
54                                "releases/download/v", ~.Version,
55                                "/nq-", ~.Version),
56ArchiveFormats := ".tar.gz .tar.bz2",
57SourceRepository := rec(
58  Type := "git",
59  URL := "https://github.com/gap-packages/nq"
60),
61IssueTrackerURL := Concatenation( ~.SourceRepository.URL, "/issues" ),
62AbstractHTML   := Concatenation(
63  "This package provides access to the ANU nilpotent quotient ",
64  "program for computing nilpotent factor groups of finitely ",
65  "presented groups."
66  ),
67
68
69PackageDoc := rec(
70  BookName  := "nq",
71  ArchiveURLSubset := [ "doc" ],
72  HTMLStart := "doc/chap0.html",
73  PDFFile   := "doc/manual.pdf",
74  SixFile   := "doc/manual.six",
75  LongTitle := "Nilpotent Quotient Algorithm",
76  Autoload  := false
77),
78
79Dependencies := rec(
80  GAP                    := ">= 4.9",
81  NeededOtherPackages    := [ ["polycyclic", "2.11"] ],
82  SuggestedOtherPackages := [  ],
83  ExternalConditions     := [ "needs a UNIX system with C-compiler",
84                              "needs GNU multiple precision library" ]
85),
86
87AvailabilityTest := function()
88    local   path;
89
90    # test for existence of the compiled binary
91    path := DirectoriesPackagePrograms( "nq" );
92
93    if Filename( path, "nq" ) = fail then
94        Info( InfoWarning, 1,
95              "Package ``nq'': The executable program is not available" );
96        return fail;
97    fi;
98    return true;
99end,
100
101BannerString     := Concatenation(
102  "Loading nq ", ~.Version, " (Nilpotent Quotient Algorithm)\n",
103  "  by Werner Nickel\n",
104  "  maintained by Max Horn (max.horn@math.uni-giessen.de)\n"
105  ),
106
107Autoload := false,
108
109TestFile := "tst/testall.g",
110
111Keywords := [
112  "nilpotent quotient algorithm",
113  "nilpotent presentations",
114  "finitely presented groups",
115  "finite presentations   ",
116  "commutators",
117  "lower central series",
118  "identical relations",
119  "expression trees",
120  "nilpotent Engel groups",
121  "right and left Engel elements",
122  "computational"
123  ],
124
125AutoDoc := rec(
126    TitlePage := rec(
127        Copyright := "\
128            <Index>License</Index>\
129            &copyright; 1992-2007 Werner Nickel<P/>\
130            The &nq; package is free software; \
131            you can redistribute it and/or modify it under the terms of the \
132            <URL Text=\"GNU General Public License\">http://www.fsf.org/licenses/gpl.html</URL> \
133            as published by the Free Software Foundation; either version 2 of the License, \
134            or (at your option) any later version.",
135        Acknowledgements := "\
136            The author of ANU NQ is Werner Nickel.\
137            \
138            <P/>The development of this program was started while the\
139            author was supported by an Australian National University PhD\
140            scholarship and an Overseas Postgraduate Research Scholarship.\
141            \
142            <P/>Further development of this program was done with support from the\
143            DFG-Schwerpunkt-Projekt \"`Algorithmische Zahlentheorie und Algebra\"'.\
144            \
145            <P/>Since then, maintenance of ANU NQ has been taken over by Max Horn. All\
146            credit for creating ANU NQ still goes to Werner Nickel as sole author.\
147            However, bug reports and other  inquiries should be sent to Max  Horn.\
148            \
149            <P/>The following are the original acknowledgements by Werner Nickel.\
150            \
151            <P/>Over the years a number of people have made useful suggestions\
152            that found their way into the code:  Mike Newman, Michael\
153            Vaughan-Lee, Joachim Neubüser, Charles Sims.\
154            \
155            <P/>Thanks to Volkmar Felsch and Joachim Neubüser for their careful\
156            examination of the package prior to its release for GAP 4.\
157            \
158            <P/>This documentation was prepared with the <Package>GAPDoc</Package>\
159            package by Frank Lübeck and Max Neunhöffer.",
160        Subtitle := "\
161            A &GAP; 4 Package<Br/>\
162            computing nilpotent factor groups of finitely presented groups<Br/>\
163            <Br/>\
164            Based on the ANU Nilpotent Quotient Program",
165        # HACK: We don't want a TitleComment, for now the best we can do is show an empty one
166        TitleComment := "",
167    ),
168),
169
170));
171