annotate README @ 7948:af10baa63915 ss-3-1-50

3.1.50 snapshot
author John W. Eaton <jwe@octave.org>
date Fri, 18 Jul 2008 17:42:48 -0400
parents 5eb3db6e4042
children 25b85c36208f
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
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
3 Copyright (C) 1996, 1997, 1998, 2002, 2007 John W. Eaton
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
4
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
5 Overview
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
2993
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
8 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
9 computations. It provides a convenient command line interface for
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
10 solving linear and nonlinear problems numerically.
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
11
2993
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
12 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
13 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
14 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
15 option) any later version.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
16
2993
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
17 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
18 WITHOUT ANY WARRANTY; without even the implied warranty of
91589ab98e37 [project @ 1997-05-21 21:44:54 by jwe]
jwe
parents: 2885
diff changeset
19 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
20 COPYING for more details.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
21
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
22 Availability
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
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
25 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
26 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
27 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
28 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
29 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
30 sites around the world.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
31
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
32 Installation and Bugs
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
7088
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
35 Octave requires approximately 925MB of disk storage to unpack and
2484
ccaffe93c32f [project @ 1996-11-07 23:24:46 by jwe]
jwe
parents: 2330
diff changeset
36 compile from source (significantly less if you don't compile with
7088
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
37 debugging symbols). Once installed, Octave requires approximately
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
38 350MB of disk space (again, considerably less if you don't build
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
39 shared libraries or the binaries and libraries do not include
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
40 debugging symbols).
2484
ccaffe93c32f [project @ 1996-11-07 23:24:46 by jwe]
jwe
parents: 2330
diff changeset
41
3148
8cdcb8945695 [project @ 1998-02-06 21:25:11 by jwe]
jwe
parents: 2993
diff changeset
42 To compile Octave, you will need a recent version of GNU Make. You
7088
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
43 will also need a recent version of g++ or other ANSI C++ compiler.
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
44 You will also need a Fortran 77 compiler or f2c. If you use f2c, you
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
45 will need a script like fort77 that works like a normal Fortran
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
46 compiler by combining f2c with your C compiler in a single script.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
47
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
48 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
49 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
50 GNU Make is very portable and easy to install.
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
51
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
52 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
53 specific installation instructions, including directions for
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
54 installing Octave from a binary distribution.
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
55
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
56 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
57 well as a list of known problems and possible fixes.
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
58
2580
fa7dd5fc7c59 [project @ 1996-12-10 06:30:41 by jwe]
jwe
parents: 2484
diff changeset
59 Documentation
fa7dd5fc7c59 [project @ 1996-12-10 06:30:41 by jwe]
jwe
parents: 2484
diff changeset
60 -------------
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
61
7088
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
62 Octave's manual has been revised for version 3.0, but it is lagging a
2580
fa7dd5fc7c59 [project @ 1996-12-10 06:30:41 by jwe]
jwe
parents: 2484
diff changeset
63 bit behind the development of the software. In particular, there is
7088
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
64 currently no complete documentation of the C++ class libraries. If
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
65 you notice ommissions or inconsistencies, please report them as bugs
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
66 to bug@octave.org. Specific suggestions for ways to improve Octave
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
67 and its documentation are always welcome. Reports with patches are
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
68 even more welcome.
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
69
2582
c6385e7b5e8f [project @ 1996-12-10 07:41:44 by jwe]
jwe
parents: 2580
diff changeset
70 Additional Information
c6385e7b5e8f [project @ 1996-12-10 07:41:44 by jwe]
jwe
parents: 2580
diff changeset
71 ----------------------
c6385e7b5e8f [project @ 1996-12-10 07:41:44 by jwe]
jwe
parents: 2580
diff changeset
72
c6385e7b5e8f [project @ 1996-12-10 07:41:44 by jwe]
jwe
parents: 2580
diff changeset
73 Up to date information about Octave is available on the WWW at the
7088
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
74 URL http://www.octave.org, including archives of the help, bug, and
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
75 maintainers mailing lists.
2582
c6385e7b5e8f [project @ 1996-12-10 07:41:44 by jwe]
jwe
parents: 2580
diff changeset
76
7088
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
77
2330
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
78 John W. Eaton
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
79 jwe@bevo.che.wisc.edu
12ff450cbb1f [project @ 1996-07-19 01:39:22 by jwe]
jwe
parents:
diff changeset
80 University of Wisconsin-Madison
7088
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
81 Department of Chemical & Biological Engineering
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
82
5eb3db6e4042 [project @ 2007-10-31 20:35:10 by jwe]
jwe
parents: 7016
diff changeset
83 Last updated: Thu, 11 Oct 2007 19:26:42 EDT