Mercurial > jwe > octave
annotate README.md @ 24169:7610fec6f2a7
Backed out changeset ab6a631abe52
The change was OK, but it should have been done with "hg rename"
instead of "hg remove" + "hg add".
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 24 Oct 2017 12:50:06 -0400 |
parents | |
children |
rev | line source |
---|---|
24169
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
1 GNU Octave -- a high-level language for numerical computations {#mainpage} |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
2 ============================================================== |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
3 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
4 Copyright (C) 1996-2017 John W. Eaton |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
5 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
6 Overview |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
7 -------- |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
8 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
9 GNU Octave is a high-level interpreted language, primarily intended |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
10 for numerical computations. It provides capabilities for the |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
11 numerical solution of linear and nonlinear problems, and for |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
12 performing other numerical experiments. It also provides extensive |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
13 graphics capabilities for data visualization and manipulation. GNU |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
14 Octave is normally used through its interactive interface (CLI and |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
15 GUI), but it can also be used to write non-interactive programs. |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
16 The GNU Octave language is quite similar to Matlab so that most |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
17 programs are easily portable. |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
18 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
19 GNU Octave is free software; you can redistribute it and/or modify it |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
20 under the terms of the GNU General Public License as published by |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
21 the Free Software Foundation; either version 3 of the License, or |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
22 (at your option) any later version. |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
23 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
24 GNU Octave is distributed in the hope that it will be useful, but |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
25 WITHOUT ANY WARRANTY; without even the implied warranty of |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
26 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
27 GNU General Public License for more details. |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
28 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
29 You should have received a copy of the GNU General Public License |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
30 along with Octave; see the file COPYING. If not, see |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
31 <https://www.gnu.org/licenses/>. |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
32 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
33 Availability |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
34 ------------ |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
35 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
36 The latest released version of Octave is always available from |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
37 <https://ftp.gnu.org/gnu/octave/> and many mirror sites around the |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
38 world. You may also find links to binary distributions at |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
39 <https://www.octave.org/download.html>. The current development |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
40 sources may be found under the Source Code tab on |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
41 [Savannah](https://savannah.gnu.org/projects/octave/). |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
42 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
43 Installation |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
44 ------------ |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
45 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
46 Octave requires approximately 1.4 GB of disk storage to unpack and |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
47 compile from source (significantly less, 400 MB, if you don't compile |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
48 with debugging symbols). Once installed, Octave requires |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
49 approximately 350 MB of disk space (again, considerably less, 70 MB, |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
50 if you don't build shared libraries or the binaries and libraries do |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
51 not include debugging symbols). |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
52 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
53 To compile Octave, you will need a recent version of: |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
54 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
55 - [GNU Make](https://www.gnu.org/software/make/) |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
56 - [GNU G++](https://gcc.gnu.org/) or another C++11 compiler |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
57 - [GNU Fortran](https://gcc.gnu.org/fortran/), another Fortran 77 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
58 compiler, or [f2c](http://www.netlib.org/f2c/) |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
59 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
60 Octave's Makefiles use features of GNU Make that are not present in |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
61 other versions of make. If you use `f2c`, you will need a script |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
62 like `fort77` that works like a normal Fortran compiler by combining |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
63 `f2c` with your C compiler in a single script. |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
64 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
65 See the notes in the files `INSTALL.OCTAVE` and the system-specific |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
66 `README` files in the `etc` directory of the Octave source |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
67 distribution for more detailed installation instructions. |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
68 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
69 Bugs and Patches |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
70 ---------------- |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
71 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
72 The file `BUGS` explains the recommended procedure for reporting bugs |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
73 on the [bug tracker](http://bugs.octave.org) or contributing patches. |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
74 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
75 Documentation |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
76 ------------- |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
77 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
78 * [Octave's manual](https://www.octave.org/doc/interpreter/) is a |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
79 comprehensive user guide covering introductive and more advanced |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
80 topics. |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
81 * [Octave's wiki](https://wiki.octave.org) is a user community page, |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
82 covering various topics and answering |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
83 [FAQ](https://wiki.octave.org/FAQ). |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
84 * [Octave's Doxygen](https://www.octave.org/doxygen/) documentation |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
85 explains the C++ class libraries. |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
86 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
87 Partially, the up-to-dateness of the documentation is lagging a bit |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
88 behind the development of the software. If you notice omissions or |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
89 inconsistencies, please report them at our bug tracker. Specific |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
90 suggestions for ways to improve Octave and its documentation are |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
91 always welcome. Reports with patches are even more welcome. |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
92 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
93 Additional Information |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
94 ---------------------- |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
95 |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
96 Up to date information about Octave is available on the WWW at |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
97 <https://www.octave.org>, or ask for help via email |
7610fec6f2a7
Backed out changeset ab6a631abe52
John W. Eaton <jwe@octave.org>
parents:
diff
changeset
|
98 <help@octave.org>. |