##// END OF EJS Templates
Merge pull request #3756 from minrk/wiredoc...
Merge pull request #3756 from minrk/wiredoc document the wire protocol in the messaging doc also update the digest scheme to use sha256 and make this configurable, since md5 is the previous default and has been shown to be bad. More messaging docs to update here: - [x] remove get/setattr on kernel - [x] remove crash messages - [x] completion requests do not behave as documented - [x] object_info is misdocumented (`name` is actually `oname` in object_info_request)

File last commit:

r9193:3e3e3382
r11721:42034aaf merge
Show More
Octave Magic.ipynb
370 lines | 133.7 KiB | text/plain | TextLexer

Using Octave Inside IPythonΒΆ

InstallationΒΆ

The octavemagic extension provides the ability to interact with Octave. It depends on the oct2py package, which may be installed using easy_install.

To enable the extension, load it as follows:

InΒ [18]:
%load_ext octavemagic

OverviewΒΆ

Loading the extension enables three magic functions: %octave, %octave_push, and %octave_pull.

The first is for executing one or more lines of Octave, while the latter allow moving variables between the Octave and Python workspace. Here you see an example of how to execute a single line of Octave, and how to transfer the generated value back to Python:

InΒ [19]:
x = %octave [1 2; 3 4];
x
Out[19]:
array([[ 1.,  2.],
       [ 3.,  4.]])
InΒ [20]:
a = [1, 2, 3]

%octave_push a
%octave a = a * 2;
%octave_pull a
a
Out[20]:
array([[2, 4, 6]])

When using the cell magic, %%octave (note the double %), multiple lines of Octave can be executed together. Unlike with the single cell magic, no value is returned, so we use the -i and -o flags to specify input and output variables.

InΒ [21]:
%%octave -i x -o y
y = x + 3;
InΒ [22]:
y
Out[22]:
array([[ 4.,  5.],
       [ 6.,  7.]])

PlottingΒΆ

Plot output is automatically captured and displayed, and using the -f flag you may choose its format (currently, png and svg are supported).

InΒ [23]:
%%octave -f svg

p = [12 -2.5 -8 -0.1 8];
x = 0:0.01:1;

polyout(p, 'x')
plot(x, polyval(p, x));
12*x^4 - 2.5*x^3 - 8*x^2 - 0.1*x^1 + 8
No description has been provided for this image

The plot size is adjusted using the -s flag:

InΒ [24]:
%%octave -s 500,500

# butterworth filter, order 2, cutoff pi/2 radians
b = [0.292893218813452  0.585786437626905  0.292893218813452];
a = [1  0  0.171572875253810];
freqz(b, a, 32);
No description has been provided for this image
InΒ [25]:
%%octave -s 600,200 -f png

subplot(121);
[x, y] = meshgrid(0:0.1:3);
r = sin(x - 0.5).^2 + cos(y - 0.5).^2;
surf(x, y, r);

subplot(122);
sombrero()
No description has been provided for this image

Future workΒΆ

After the next release of oct2py, we'll add the ability to interrupt/kill the current Octave session without restarting the Python kernel.