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