Mercurial > pytave

annotate INSTALL.md @ 389:d4061763a56b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Delete and no longer build Python extension module * Makefile.am (_pytave.la): Delete all declarations. * configure.ac (PYTAVE_MODULE_INSTALL_PATH): Delete hack. * pytave.cc: Delete.
author Mike Miller <mtmiller@octave.org>
date Mon, 03 Apr 2017 12:11:25 -0700
parents a323f9fae46b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
1 Pytave Building Instructions
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
2 ============================
0
4da14cce0890 First launchpad.net check in.
David Grundberg <c04dgg@cs.umu.se>
parents:
diff changeset
3
153
ea2b598617f1 doc: Overhaul INSTALL file
Mike Miller <mtmiller@octave.org>
parents: 97
diff changeset
4 Pytave is built using GNU autotools.
49
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
5
153
ea2b598617f1 doc: Overhaul INSTALL file
Mike Miller <mtmiller@octave.org>
parents: 97
diff changeset
6 Use the configure script to detect Octave and Boost::Python paths.
ea2b598617f1 doc: Overhaul INSTALL file
Mike Miller <mtmiller@octave.org>
parents: 97
diff changeset
7
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
8 Run `./configure --help` for more info.
49
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
9
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
10 Dependencies
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
11 ------------
49
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
12
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
13 Configuring:
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
14
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
15 * a shell capable of running `configure`
0
4da14cce0890 First launchpad.net check in.
David Grundberg <c04dgg@cs.umu.se>
parents:
diff changeset
16
49
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
17 Building:
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
18
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
19 * GNU make
49
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
20
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
21 Linked and tested with:
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
22
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
23 * Python 2.7
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
24 * Boost::Python 1.58
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
25 * Octave 4.1 (development version)
0
4da14cce0890 First launchpad.net check in.
David Grundberg <c04dgg@cs.umu.se>
parents:
diff changeset
26
153
ea2b598617f1 doc: Overhaul INSTALL file
Mike Miller <mtmiller@octave.org>
parents: 97
diff changeset
27 Bootstrapping from Mercurial
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
28 ----------------------------
49
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
29
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
30 1. `hg clone https://bitbucket.org/mtmiller/pytave`
0
4da14cce0890 First launchpad.net check in.
David Grundberg <c04dgg@cs.umu.se>
parents:
diff changeset
31
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
32 2. `autoreconf --install`
48
5867e925d0dd always enable float matrices
Jaroslav Hajek <highegg@gmail.com>
parents: 35
diff changeset
33
153
ea2b598617f1 doc: Overhaul INSTALL file
Mike Miller <mtmiller@octave.org>
parents: 97
diff changeset
34 Building
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
35 --------
97
348090c479e2 Update INSTALL file with hints for Ubuntu 9.10.
David Grundberg <individ@acc.umu.se>
parents: 94
diff changeset
36
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
37 1. `./configure`
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
38
153
ea2b598617f1 doc: Overhaul INSTALL file
Mike Miller <mtmiller@octave.org>
parents: 97
diff changeset
39 or
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
40
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
41 `./configure --prefix=/directory/where/you/want/the/module/file`
97
348090c479e2 Update INSTALL file with hints for Ubuntu 9.10.
David Grundberg <individ@acc.umu.se>
parents: 94
diff changeset
42
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
43 2. Run `make` to build the extension module
49
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
44
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
45 3. To copy the pytave dynamic library to the prefix, run
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
46 `make install`
49
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
47
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
48 Running from build directory
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
49 ----------------------------
49
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
50
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
51 Pytave is made up of three parts. The `pytave` package, the
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
52 `pytave/pytave` module and the `pytave/_pytave` extension. When the user
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
53 uses `import pytave`, the pytave package `__init__` script loads both
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
54 the module and the extension. It is important that they both can be
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
55 found.
0
4da14cce0890 First launchpad.net check in.
David Grundberg <c04dgg@cs.umu.se>
parents:
diff changeset
56
153
ea2b598617f1 doc: Overhaul INSTALL file
Mike Miller <mtmiller@octave.org>
parents: 97
diff changeset
57 1. Follow the build instructions to compile the extension.
49
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
58
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
59 2. Start the Python interpreter with a Python path set to a path
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
60 containing `_pytave.so` and the `package` directory. A common way
49
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
61 to do this with the bash shell is to execute this command:
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
62
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
63 PYTHONPATH=.libs:package python
0
4da14cce0890 First launchpad.net check in.
David Grundberg <c04dgg@cs.umu.se>
parents:
diff changeset
64
153
ea2b598617f1 doc: Overhaul INSTALL file
Mike Miller <mtmiller@octave.org>
parents: 97
diff changeset
65 3. In the interpreter you can now access Octave through Python:
ea2b598617f1 doc: Overhaul INSTALL file
Mike Miller <mtmiller@octave.org>
parents: 97
diff changeset
66
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
67 import numpy
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
68 import pytave
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
69 pytave.feval(1, "cos", 0)
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
70 b = pytave.addpath(".")
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
71 pytave.feval(1, "testfile", 42)
153
ea2b598617f1 doc: Overhaul INSTALL file
Mike Miller <mtmiller@octave.org>
parents: 97
diff changeset
72
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
73 Note that there is no `testfile.m` file in the distribution. This is
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
74 simply a demonstration of how to execute an arbitrary Octave m-file.
49
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
75
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
76 Running test suite in build directory
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
77 -------------------------------------
49
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
78
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
79 1. Run `make check`
97
348090c479e2 Update INSTALL file with hints for Ubuntu 9.10.
David Grundberg <individ@acc.umu.se>
parents: 94
diff changeset
80
153
ea2b598617f1 doc: Overhaul INSTALL file
Mike Miller <mtmiller@octave.org>
parents: 97
diff changeset
81 There are known errors in the test suite.
0
4da14cce0890 First launchpad.net check in.
David Grundberg <c04dgg@cs.umu.se>
parents:
diff changeset
82
49
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
83 Creating a source dist
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
84 ----------------------
49
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
85
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
86 1. Run `make distcheck`
49
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
87
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
88 Hint about foreign systems
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
89 --------------------------
0
4da14cce0890 First launchpad.net check in.
David Grundberg <c04dgg@cs.umu.se>
parents:
diff changeset
90
49
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
91 If you are running on a system incapable of executing the configure
2a2f1e2f2be3 revert accidental rewrite of INSTALL
Jaroslav Hajek <highegg@gmail.com>
parents: 48
diff changeset
92 scripts (e.g. a Microsoft Windows system), you may want to try
159
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
93 installing the MinGW and MSYS packages, and build everything inside that
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
94 environment. This isn't for the faint of heart though, since you
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
95 need/want to build Octave too. It is probably easier than trying to
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
96 build without configure scripts, that's all. There are no guarantees
a323f9fae46b doc: Reformat INSTALL and README in Markdown
Mike Miller <mtmiller@octave.org>
parents: 153
diff changeset
97 that it will build at all, it has not been tested.