1 | Dear User:
|
---|
2 |
|
---|
3 | This archive contains files which provide Grobner basis support for
|
---|
4 | the free computer algebra system Maxima. The older versions of the
|
---|
5 | package are distributed with Maxima in the subfolder of the Maxima
|
---|
6 | installation tree, like:
|
---|
7 |
|
---|
8 | maxima/5.xx.x/share/contrib/Grobner
|
---|
9 |
|
---|
10 | This version is meant to be a backward-compatible replacement for this
|
---|
11 | package. It features an implementation of the Faugere's F4 algorithm.
|
---|
12 |
|
---|
13 | == INSTALLATION INSTRUCTIONS ==
|
---|
14 |
|
---|
15 | In order to use the package,
|
---|
16 | 1. Copy the files in this directory to your favorite location;
|
---|
17 | or better, checkout the contents of this repository with SVN.
|
---|
18 | 2. Edit the file "grobner.mac" to modify the location of the Lisp
|
---|
19 | files, to reflect your choice made in previous step.
|
---|
20 | 3. Start your Maxima and load the file "grobner.mac"
|
---|
21 | 4. Optionally, compile the Lisp files, so that the next file
|
---|
22 | you load "grobner.mac", the compiled (.fasl) versions of
|
---|
23 | the files will be loaded. The compilation instructions
|
---|
24 | vary slightly depending on Lisp version.
|
---|
25 |
|
---|
26 | This version has been verified to work under this Maxima version:
|
---|
27 |
|
---|
28 | ----------------------------------------------------------------
|
---|
29 | Maxima 5.34.1 http://maxima.sourceforge.net
|
---|
30 | using Lisp SBCL 1.2.4-1.fc21
|
---|
31 | ----------------------------------------------------------------
|
---|
32 |
|
---|
33 | It should also be portable across other ANSI Common Lisp implementations.
|
---|
34 |
|
---|
35 | The file grobner.demo is a Macsyma-style demo file for most of the operations
|
---|
36 | provided by the package. In order to run it, go to the Maxima level and
|
---|
37 | type:
|
---|
38 |
|
---|
39 | demo("grobner.demo");
|
---|
40 |
|
---|
41 | or
|
---|
42 |
|
---|
43 | batch("grobner.demo");
|
---|
44 |
|
---|
45 | and watch the demonstration.
|
---|
46 |
|
---|
47 | Maxima documentation for this package has not been written yet, but
|
---|
48 | there is a sizable amount of documentation in the LISP source.
|
---|
49 |
|
---|
50 | == COMPILATION INSTRUCTIONS FOR SBCL ==
|
---|
51 |
|
---|
52 | === When using ASDF (preferred way):
|
---|
53 | ----------------------------------------------------------------
|
---|
54 | > (require :asdf)
|
---|
55 | > (load "ngrobner.asd")
|
---|
56 | > (asdf:install-system :ngrobner)
|
---|
57 | ----------------------------------------------------------------
|
---|
58 | The compiled files (extension .fasl for SBCL) will be typically
|
---|
59 | placed in a standard location determined by the ASDF configuration. On my system it is:
|
---|
60 | ----------------------------------------------------------------
|
---|
61 | /home/marek/.cache/common-lisp/sbcl-1.2.4-1.fc21-linux-x64/home/marek/Repos/MaximaGrobner/branches/f4grobner/
|
---|
62 | ----------------------------------------------------------------
|
---|
63 | given that the SVN repository was copied to /home/marek/Repos/MaximaGrobner.
|
---|
64 |
|
---|
65 | === When not using ASDF (for whatever reason):
|
---|
66 |
|
---|
67 | Step 1. Start SBCL in the directory which is a copy of this directory.
|
---|
68 | Step 2. Execute Lisp commands:
|
---|
69 | ----------------------------------------------------------------
|
---|
70 | * (load "ngrobner-package.lisp")
|
---|
71 | * (ngrobner::compile-ngrobner)
|
---|
72 | ----------------------------------------------------------------
|
---|
73 |
|
---|
74 | The resulting compiled files (extension .fasl for SBCL) will end up in
|
---|
75 | the same folder as the Lisp files. Then can be moved any directory
|
---|
76 | where Maxima can find them, as determined by the variable
|
---|
77 | file_search_lisp. This variable needs to be modified in "grobner.mac"
|
---|
78 | accordingly. After that, every time you load "grobner.mac" the
|
---|
79 | compiled version will be used.
|
---|
80 |
|
---|
81 | == 5AM TESTS ==
|
---|
82 |
|
---|
83 | The system is set up for using the FiveAM unit testing framework.
|
---|
84 | One performs the tests by loading a single file:
|
---|
85 | ----------------------------------------------------------------
|
---|
86 | * (load "5am-tests")
|
---|
87 | ----------------------------------------------------------------
|
---|
88 | Note that this requires ASDF and QuickLisp.
|
---|
89 |
|
---|
90 | == ADDITIONAL COMMENTS ==
|
---|
91 |
|
---|
92 | The files were derived the sources of a package CGBlisp, version 2,
|
---|
93 | also authored by me, which will eventually be released at my Web site
|
---|
94 | (see below). An older version of CGBlisp is available at the Web
|
---|
95 | site.
|
---|
96 |
|
---|
97 | Enjoy.
|
---|
98 | --Marek Rychlik
|
---|
99 |
|
---|
100 | 5-24-2002
|
---|
101 | Revised: 1-25-2009
|
---|
102 | Revised: 1-25-2015
|
---|
103 |
|
---|
104 | E-mail: rychlik@u.arizona.edu
|
---|
105 | URL: http://marekrychlik.com
|
---|