The QPA package for GAP 4.5
==================================

Version 1.22; July 20th, 2015
Copyright (C) 2010 The QPA-team, 	
             http://www.math.ntnu.no/~oyvinso/QPA/

Introduction
------------

The "Quivers and Path Algebras" team has as a goal to develop a GAP
package(s) for carrying out computations for finite dimensional
quotients of path algebras over the fields that are available in
GAP. The package we aim to develop for GAP is called QPA for Quivers
and Path Algebras.

QPA is designed as a GAP >= 4.5.x share package providing new functions in
noncommutative algebra. For the current functions provided by QPA follow
the URL
              http://www.math.ntnu.no/~oyvinso/QPA/

and look at WhatYouCanDoList.

Contents
--------

The following should be included with this version of QPA.


    CHANGES  	  - files containing the history of changes in 
               	    QPA since version 1.05.
    LICENSE  	  - the license governing QPA usage
    PackageInfo.g - contains metainformation about the package
    README        - this file
    doc      	  - the user manuals
    examples 	  - manual examples in separate files, chapterwise 
    init.g   	  - package initialization
    lib        	  - the GAP source code
    read.g   	  - package initialization
    tst      	  - tests for the package
    version       - contains the version number of the latest version

Obtaining
---------

QPA can be obtained from

    	http://www.math.ntnu.no/~oyvinso/QPA/
or from
    	https://github.com/gap-system/qpa/

The Groebner basis package GBNP is required to run QPA. The
GBNP Groebner basis can be obtain from its home at:

	http://www.win.tue.nl/~amc/pub/grobner/chap0.html

The GAPDoc package is necessary for generating the documentation
files. The GAPDoc package can be obtain from its home at:

  http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc/index.html

Installation
------------

For intalling and downloading: Assuming that GAP is installed on your
comupter, follow the following steps:

1.  Make a directory, say GAPdirectory.
2.  In the GAPdirectory, create a subdirectory gap, with again a 
    subdirectory pkg, that is, now you should have a directory 
    GAPdirectory/gap/pkg/.
3.  Move to the directory GAPdirectory/gap/pkg/
4.  Give the following command:
        git clone https://github.com/gap-system/qpa.git qpa
5.  QPA is using the GAP-package GBNP, go to this webpage and 
    download the latest version of this package. Unpack it in 
    the directory GAPdirectory/gap/pkg/.
6.  The directory GAPdirectory/gap/pkg/ should now have two subdirectories, gbnp and qpa.
7.  When starting GAP, use the command: gap -l ";/fullpath/GAPdirectory/gap/", 
    where "fullpath" is the complete directory path name for the directory 
    containing the subdirectory GAPdirectory. Or for convenience, define an 
    alias, for instance in .bashrc, alias gap='gap -l ";/fullpath/GAPdirectory/gap/"'.
8.  Making the documentation (install GAPDoc 1.3 for GAP 4.4.12, GAPDoc 1.5 for GAP > 4.4):
    (i)   Move to the directory GAPdirectory/gap/pkg/qpa/doc
    (ii)  Give the command: gap MakeQPADoc.gi (see below for setting up the gap command).

For the latest version of QPA, always download the GIT repository (assuming that you have
cloned the GitHub repository):
a) Move to the directory GAPdirectory/gap/pkg/qpa/
b) Give the following command:
      git pull
if you have a version of QPA installed already in GAPdirectory/gap/pkg/.

Using QPA
----------

Assuming that GAP is installed on your computer and that QPA is installed as
above, start QPA/GAP using the command: 

     gap -l ";/fullpath/GAPdirectory/gap/" 

where "fullpath" is the complete directory path name for the directory
containing the subdirectory GAPdirectory. Or for convenience, define
an alias, for instance in .bashrc, 

     alias gap='gap -l ";/fullpath/GAPdirectory/gap/"'  

To load the QPA-package, give the command

     LoadPackage("qpa");

To avoid having to load QPA each time you use GAP, consult the posting

https://www.mail-archive.com/[email protected]/msg02528.html

See the user manual in the doc directory for more information regarding
the use of QPA, or follow the URL

     http://www.math.ntnu.no/~oyvinso/QPA/manual.pdf

to see the current manual/documentation of QPA (still work in progress,
not brilliant at this point). 

Contact
-------

If you have a question or encounter any problems regarding QPA, you
can either:

 * contact one of the QPA-team members, see the webpage
              http://www.math.ntnu.no/~oyvinso/QPA
or
 * report an issue at https://github.com/gqp-system/qpa/issues/new