jakobkroeker / fr Goto Github PK

                             The FR package

This is the README file for the GAP package "FR".

This package implements Functionally Recursive and Mealy automata in
GAP. These objects can be manipulated as group elements, and various
specific commands allow their manipulation as automorphisms of infinite
rooted trees. Permutation quotients can also be created and manipulated
as standard GAP groups or semigroups.

This release (1.0) is the first containing all the planned functionality,
though some rough edges will still need to be smoothed. In particular,
the TODO file describes plans for future development, including
computations of presentations for self-similar groups, interval arithmetic
for complex dynamics, etc.

The package is distributed in source form, and require a running GAP 4.5 or later
with installed packages.

Alternatively the required packages 
Alnuth, autpgrp, polycyclic-2.10.1 and FGA
can be downloaded and extracted into the $GAP_ROOT/pkg folder 
from http://www.gap-system.org/Packages/

 For updates, check

     http://www.uni-math.gwdg.de/laurent/FR/ (tar.gz formats)
and
     https://github.com/laurentbartholdi/fr (git)

To use the package, start GAP and type

LoadPackage("FR");

The "FR" package banner should appear on the screen.

For details on how to use the FR package, please consult the documentation.
Though this is usually not necessary, it may be recompiled, after the command
`LoadPackage("FR")', by invoking

DOC@fr();

at the GAP prompt. The documentation will then be available in the `doc'
subdirectory (view the file `manual.pdf' via a PDF viewer).

An optional external module (DLL) provides floating-point functions used
by the "iterated monodromy groups" part of FR. Its presence or absence
does not affect the remainder of FR. To compile it, first make sure that
your system has C and JAVA compilers, and that the libraries
libcblas and libgcj are installed. Then compile by running

'./configure && make' in FR's root directory.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or any
later version.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program, in the file COPYING.  If not, see
<http://www.gnu.org/licenses/>.

  Laurent Bartholdi, Göttingen, 2 September 2012