README.md
1[](https://travis-ci.com/gap-packages/automgrp)
2[](https://codecov.io/gh/gap-packages/automgrp)
3
4The AutomGrp package
5====================
6
7The AutomGrp package provides methods for computations with groups and
8semigroups generated by finite automata or given by wreath recursions, as well
9as with their finitely generated subgroups, subsemigroups and elements.
10
11This package is a free software and you can do pretty much anything you want
12with it. See LICENSE file for the exact terms.
13
14
15Authors
16-------
17
18The AutomGrp package is written by:
19
20Yevgen Muntyan
21Bellevue, WA, USA
22e-mail: muntyan@fastmail.fm
23
24Dmytro Savchuk
25Department of Mathematics and Statistics
26University of South Florida
27Tampa, FL, 33620
28e-mail: dmytro.savchuk@gmail.com
29www: http://savchuk.myweb.usf.edu/
30
31
32Installing the AutomGrp package
33-------------------------------
34
35Since AutomGrp is distributed with GAP, normally you should not have to install it,
36it will already be present. But if you e.g. want to use a newer version than what is
37shipped with GAP, you can do the following:
38
39First, download the latest version from <https://gap-packages.github.io/automgrp/>.
40This will give you an archive file with a name like `automgrp-X.Y.Z.tar.bz2`, where
41`X.Y.Z` stands in for the actual version number.
42To install the AutomGrp package, move the archive file `automgrp-X.Y.Z.tar.bz2` or
43`automgrp-X.Y.Z.tar.gz` (`automgrp-X.Y.Z-win.zip` if you are using a Windows system)
44into the `pkg` directory of your GAP installation, and unpack it. See section
45"ref:Installing GAP Packages" of the GAP 4 reference manual for details and
46additional options for installing GAP packages.
47
48Restart GAP and load the package by issuing at the GAP prompt the command:
49
50 LoadPackage( "AutomGrp" );
51
52
53Execute the following at the GAP prompt to test the installation:
54
55 Read( Filename( DirectoriesPackageLibrary( "automgrp", "tst" ), "testall.g" ) );
56
57
58Bug reports, comments, etc.
59---------------------------
60
61If you encounter problems or have questions or comments, please use the
62issue tracker at <https://github.com/fingolfin/automgrp/issues>.
63
64When sending a bug report, please include:
65
66* A GAP script that demonstrates the problem.
67
68* The exact version of GAP you are using, ideally the whole "banner"
69 GAP prints during startup.
70
71* The output of the following command in GAP:
72
73 PackageInfo("AutomGrp")[1].Version;
74
75* The operating system you are using e.g. Debian Linux, Windows, macOS, etc.
76
){kind=link}
){kind=link}