README
1The QPA package for GAP 4.5
2==================================
3
4Version 1.30; Septmber 18th, 2019
5Copyright (C) 2010 The QPA-team,
6 https://folk.ntnu.no/oyvinso/QPA/
7
8Introduction
9------------
10
11The "Quivers and Path Algebras" team has as a goal to develop a GAP
12package(s) for carrying out computations for finite dimensional
13quotients of path algebras over the fields that are available in
14GAP. The package we aim to develop for GAP is called QPA for Quivers
15and Path Algebras.
16
17QPA is designed as a GAP >= 4.5.x share package providing new functions in
18noncommutative algebra. For the current functions provided by QPA follow
19the URL
20 https://folk.ntnu.no/oyvinso/QPA/
21
22and look at WhatYouCanDoList.
23
24Contents
25--------
26
27The following should be included with this version of QPA.
28
29
30 CHANGES - files containing the history of changes in
31 QPA since version 1.05.
32 LICENSE - the license governing QPA usage
33 PackageInfo.g - contains metainformation about the package
34 README - this file
35 doc - the user manuals
36 examples - manual examples in separate files, chapterwise
37 init.g - package initialization
38 lib - the GAP source code
39 read.g - package initialization
40 tst - tests for the package
41 version - contains the version number of the latest version
42
43Installation
44------------
45
46Since the release of GAP version 4.7.8, the package QPA is distributed
47with GAP, so if you download this version or any later version QPA
48will be installed at the same time as GAP is installed. Follow the
49instructions for installing GAP on the web page
50
51 http://www.gap-system.org/Download/index.html
52
53After having successfully started GAP, give the command
54
55gap> LoadPackage("qpa");
56
57which loads QPA and you can start using QPA.
58
59For GAP version 4.7.7 or older, or you want a newer version of QPA than
60the one that is distributed with GAP, follow the following instructions:
61
621. Locate a pkg-directory where GAP searches for packages, see
63 9.2 GAP Root Directories in the GAP manual for more information.
642a. Download a release of QPA from
65 https://github.com/gap-packages/qpa/releases
66 and unpack it in the pkg-directory you located in 1.
672b. Alternatively, clone the git-repository of QPA by giving the following
68 command:
69 git clone https://github.com/gap-packages/qpa.git qpa
70 when you are in the pkg-directory you located in 1.
71 For making the documentation for QPA give the command
72 MakeQPADocumentation();
73 inside a gap-session with QPA loaded.
74 For later obtaining the latest version of QPA, give the command
75 git pull
76 when you are inside the qpa-directory.
77
78
79Using QPA
80----------
81
82To load the QPA-package, give the command
83
84 LoadPackage("qpa");
85
86To avoid having to load QPA each time you use GAP, you can add "qpa"
87to the user preference PackagesToLoad, as explained in
88
89https://www.mail-archive.com/forum@mail.gap-system.org/msg02528.html
90
91See the user manual in the doc directory for more information
92regarding the use of QPA, or follow the URL
93
94 https://folk.ntnu.no/oyvinso/QPA/manual.pdf
95
96to see the current manual/documentation of QPA (still work in
97progress, not brilliant at this point).
98
99Contact
100-------
101
102If you have a question or encounter any problems regarding QPA, you
103can either:
104
105 * contact one of the QPA-team members, see the webpage
106 https://folk.ntnu.no/oyvinso/QPA
107or
108 * report an issue at https://github.com/gap-packages/qpa/issues/new
109