annotate README @ 5103:e2ed74b9bfa0 after-gnuplot-split

[project @ 2004-12-28 02:43:01 by jwe]
author jwe
date Tue, 28 Dec 2004 02:43:01 +0000
parents b2ce28713791
children 4c8a2e4e0717
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2993
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
1 GNU Octave -- a high-level language for numerical computations.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
2
3900
ce8e45b027d0 [project @ 2002-04-13 01:22:01 by jwe]
jwe
parents: 3285
diff changeset
3 Copyright (C) 1996, 1997, 1998, 2002 John W. Eaton
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
4
3900
ce8e45b027d0 [project @ 2002-04-13 01:22:01 by jwe]
jwe
parents: 3285
diff changeset
5 Last updated: Fri Apr 12 20:23:53 2002
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
6
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
7 Overview
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
8 --------
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
9
2993
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
10 GNU Octave is a high-level language, primarily intended for numerical
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
11 computations. It provides a convenient command line interface for
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
12 solving linear and nonlinear problems numerically.
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
13
2993
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
14 GNU Octave is free software; you can redistribute it and/or modify it
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
15 under the terms of the GNU General Public License as published by the
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
16 Free Software Foundation; either version 2, or (at your option) any
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
17 later version.
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
18
2993
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
19 GNU Octave is distributed in the hope that it will be useful, but
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
20 WITHOUT ANY WARRANTY; without even the implied warranty of
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the file
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
22 COPYING for more details.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
23
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
24 Availability
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
25 ------------
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
26
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
27 The latest released version of Octave is always available via
3900
ce8e45b027d0 [project @ 2002-04-13 01:22:01 by jwe]
jwe
parents: 3285
diff changeset
28 anonymous ftp from ftp.octave.org in the directory /pub/octave.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
29 Complete source and binaries for several popular systems are
2993
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
30 available. Source distributions of Octave are also available from
3285
6929a31e7624 [project @ 1999-10-13 21:59:11 by jwe]
jwe
parents: 3148
diff changeset
31 ftp.gnu.org in the directory /pub/gnu, as well as many mirror
2993
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
32 sites around the world.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
33
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
34 Installation and Bugs
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
35 ---------------------
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
36
2484
ccaffe93c32f [project @ 1996-11-07 23:24:46 by jwe]
jwe
parents: 2330
diff changeset
37 Octave requires approximately 125MB of disk storage to unpack and
ccaffe93c32f [project @ 1996-11-07 23:24:46 by jwe]
jwe
parents: 2330
diff changeset
38 compile from source (significantly less if you don't compile with
ccaffe93c32f [project @ 1996-11-07 23:24:46 by jwe]
jwe
parents: 2330
diff changeset
39 debugging symbols or create shared libraries). Once installed, Octave
ccaffe93c32f [project @ 1996-11-07 23:24:46 by jwe]
jwe
parents: 2330
diff changeset
40 requires approximately 65MB of disk space (again, considerably less if
2580
fa7dd5fc7c59 [project @ 1996-12-10 06:30:41 by jwe]
jwe
parents: 2484
diff changeset
41 you don't build shared libraries or the binaries and libraries do not
fa7dd5fc7c59 [project @ 1996-12-10 06:30:41 by jwe]
jwe
parents: 2484
diff changeset
42 include debugging symbols).
2484
ccaffe93c32f [project @ 1996-11-07 23:24:46 by jwe]
jwe
parents: 2330
diff changeset
43
3148
8cdcb8945695 [project @ 1998-02-06 21:25:11 by jwe]
jwe
parents: 2993
diff changeset
44 To compile Octave, you will need a recent version of GNU Make. You
8cdcb8945695 [project @ 1998-02-06 21:25:11 by jwe]
jwe
parents: 2993
diff changeset
45 will also need g++ 2.7.2 or later. Version 2.8.0 or egcs 1.0.x should
8cdcb8945695 [project @ 1998-02-06 21:25:11 by jwe]
jwe
parents: 2993
diff changeset
46 work. Later versions may work, but C++ is still evolving, so don't be
8cdcb8945695 [project @ 1998-02-06 21:25:11 by jwe]
jwe
parents: 2993
diff changeset
47 too surprised if you run into some trouble.
2580
fa7dd5fc7c59 [project @ 1996-12-10 06:30:41 by jwe]
jwe
parents: 2484
diff changeset
48
3148
8cdcb8945695 [project @ 1998-02-06 21:25:11 by jwe]
jwe
parents: 2993
diff changeset
49 It is no longer necessary to have libg++, but you do need to have the
8cdcb8945695 [project @ 1998-02-06 21:25:11 by jwe]
jwe
parents: 2993
diff changeset
50 GNU implementation of libstdc++. If you are using g++ 2.7.2,
8cdcb8945695 [project @ 1998-02-06 21:25:11 by jwe]
jwe
parents: 2993
diff changeset
51 libstdc++ is distributed along with libg++, but for later versions,
8cdcb8945695 [project @ 1998-02-06 21:25:11 by jwe]
jwe
parents: 2993
diff changeset
52 libstdc++ is distributed separately. For egcs, libstdc++ is included
8cdcb8945695 [project @ 1998-02-06 21:25:11 by jwe]
jwe
parents: 2993
diff changeset
53 with the compiler distribution.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
54
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
55 YOU MUST HAVE GNU MAKE TO COMPILE OCTAVE. Octave's Makefiles use
2484
ccaffe93c32f [project @ 1996-11-07 23:24:46 by jwe]
jwe
parents: 2330
diff changeset
56 features of GNU Make that are not present in other versions of make.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
57 GNU Make is very portable and easy to install.
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
58
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
59 See the notes in the files INSTALL and INSTALL.OCTAVE for more
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
60 specific installation instructions, including directions for
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
61 installing Octave from a binary distribution.
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
62
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
63 The file BUGS contains a recommended procedure for reporting bugs, as
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
64 well as a list of known problems and possible fixes.
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
65
2580
fa7dd5fc7c59 [project @ 1996-12-10 06:30:41 by jwe]
jwe
parents: 2484
diff changeset
66 Documentation
fa7dd5fc7c59 [project @ 1996-12-10 06:30:41 by jwe]
jwe
parents: 2484
diff changeset
67 -------------
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
68
2580
fa7dd5fc7c59 [project @ 1996-12-10 06:30:41 by jwe]
jwe
parents: 2484
diff changeset
69 Octave's manual has been revised for version 2.0, but it is lagging a
fa7dd5fc7c59 [project @ 1996-12-10 06:30:41 by jwe]
jwe
parents: 2484
diff changeset
70 bit behind the development of the software. In particular, there is
fa7dd5fc7c59 [project @ 1996-12-10 06:30:41 by jwe]
jwe
parents: 2484
diff changeset
71 currently no complete documentation of the C++ class libraries or the
fa7dd5fc7c59 [project @ 1996-12-10 06:30:41 by jwe]
jwe
parents: 2484
diff changeset
72 support for dynamic linking and user-defined data types. If you
fa7dd5fc7c59 [project @ 1996-12-10 06:30:41 by jwe]
jwe
parents: 2484
diff changeset
73 notice ommissions or inconsistencies, please report them as bugs to
5041
b2ce28713791 [project @ 2004-10-01 18:12:10 by jwe]
jwe
parents: 3900
diff changeset
74 bug@octave.org. Specific suggestions for ways to improve Octave and
b2ce28713791 [project @ 2004-10-01 18:12:10 by jwe]
jwe
parents: 3900
diff changeset
75 its documentation are always welcome.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
76
2885
a65b62d2f630 [project @ 1997-04-26 18:56:10 by jwe]
jwe
parents: 2847
diff changeset
77 Implementation
a65b62d2f630 [project @ 1997-04-26 18:56:10 by jwe]
jwe
parents: 2847
diff changeset
78 --------------
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
79
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
80 Octave is being developed with the Free Software Foundation's make,
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
81 bison (a replacement for YACC), flex (a replacement for lex), gcc/g++,
3148
8cdcb8945695 [project @ 1998-02-06 21:25:11 by jwe]
jwe
parents: 2993
diff changeset
82 and libstdc++ on an Intel Pentium II system running Linux/GNU. It
8cdcb8945695 [project @ 1998-02-06 21:25:11 by jwe]
jwe
parents: 2993
diff changeset
83 should be possible to install it on any machine that runs GCC/G++. It
8cdcb8945695 [project @ 1998-02-06 21:25:11 by jwe]
jwe
parents: 2993
diff changeset
84 may also be possible to install it using other implementations of
2484
ccaffe93c32f [project @ 1996-11-07 23:24:46 by jwe]
jwe
parents: 2330
diff changeset
85 these tools, but it will most certainly require much more work. Do
ccaffe93c32f [project @ 1996-11-07 23:24:46 by jwe]
jwe
parents: 2330
diff changeset
86 yourself a favor and get the GNU development tools, either via
3285
6929a31e7624 [project @ 1999-10-13 21:59:11 by jwe]
jwe
parents: 3148
diff changeset
87 anonymous ftp from ftp.gnu.org or by writing the Free Software
2484
ccaffe93c32f [project @ 1996-11-07 23:24:46 by jwe]
jwe
parents: 2330
diff changeset
88 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
89
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
90 The underlying numerical solvers are currently standard Fortran ones
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
91 like Lapack, Linpack, Odepack, the Blas, etc., packaged in a library
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
92 of C++ classes (see the files in the libcruft and liboctave
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
93 subdirectories). If possible, the Fortran subroutines are compiled
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
94 with the system's Fortran compiler, and called directly from the C++
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
95 functions. If that's not possible, they are translated with f2c and
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
96 compiled with a C compiler. Better performance is usually achieved if
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
97 the intermediate translation to C is avoided.
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
98
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
99 The library of C++ classes may also be useful by itself.
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
100
2582
c6385e7b5e8f [project @ 1996-12-10 07:41:44 by jwe]
jwe
parents: 2580
diff changeset
101 Additional Information
c6385e7b5e8f [project @ 1996-12-10 07:41:44 by jwe]
jwe
parents: 2580
diff changeset
102 ----------------------
c6385e7b5e8f [project @ 1996-12-10 07:41:44 by jwe]
jwe
parents: 2580
diff changeset
103
c6385e7b5e8f [project @ 1996-12-10 07:41:44 by jwe]
jwe
parents: 2580
diff changeset
104 Up to date information about Octave is available on the WWW at the
3900
ce8e45b027d0 [project @ 2002-04-13 01:22:01 by jwe]
jwe
parents: 3285
diff changeset
105 URL http://www.octave.org, including archives of the help-octave,
ce8e45b027d0 [project @ 2002-04-13 01:22:01 by jwe]
jwe
parents: 3285
diff changeset
106 bug-octave, and octave-sources mailing lists.
2582
c6385e7b5e8f [project @ 1996-12-10 07:41:44 by jwe]
jwe
parents: 2580
diff changeset
107
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
108 --
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
109 John W. Eaton
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
110 jwe@bevo.che.wisc.edu
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
111 University of Wisconsin-Madison
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
112 Department of Chemical Engineering