Rich output and the IPython Notebook

[vbraun]

This framework separates the construction of rich output (images, mathjax, 3d scenes, ...) from the viewer details. Displaying rich output is handled by interchangeable plugins that encapsulate the differences between various notebooks, the command line, etc.

As a side effect, mathjax output in the ipython notebook works now.

Depends on #16996
Depends on #16640
Depends on #17284

CC: @novoselt @ohanar @gagern

Component: graphics

Author: Volker Braun

Branch: a173e92

Reviewer: R. Andrew Ohana, Emmanuel Charpentier

Issue created by migration from https://trac.sagemath.org/ticket/17234

[jdemeyer]

Dependencies: #16996, #16640

[jdemeyer]

Changed dependencies from #16996, #16640 to #16996, #16640, #17284

[vbraun]

Branch: u/vbraun/rich_output_and_the_ipython_notebook

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

1bac881

WIP

[sagetrac-git]

Commit: 1bac881

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

9e1c355

WIP

[sagetrac-git]

Changed commit from 1bac881 to 9e1c355

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

b902167

WIP

[sagetrac-git]

Changed commit from 9e1c355 to b902167

[sagetrac-git]

Changed commit from b902167 to 14c147e

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

14c147e

WIP

[sagetrac-git]

Changed commit from 14c147e to 3411efa

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

3411efa

test

[sagetrac-git]

Changed commit from 3411efa to 14c147e

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

[sagetrac-git]

Changed commit from 14c147e to f78a5d3

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

fc4e54a	WIP
830e463	rebase, minor fixes
07adf45	save builtins._
f78a5d3	WIP: SageNB jmol

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

7296703	WIP
ed9bc27	rebase, minor fixes
f8f8386	save builtins._
a88a042	WIP: SageNB jmol
5dc0090	Make SageNB j(s)mol work

[sagetrac-git]

Changed commit from f78a5d3 to 5dc0090

[sagetrac-git]

Changed commit from 5dc0090 to 7633dc3

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

db74693	make sagenb temp filen world-readable
a13e0f1	Add canvas3d graphics support
7633dc3	hook up the Java3d (sage3d) viewer

[sagetrac-git]

Changed commit from 7633dc3 to 037d0eb

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

037d0eb

Finish lightwave support

[sagetrac-git]

Changed commit from fcbc588 to a173e92

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

a173e92

Do not change permissions on doctest sample files

[vbraun]

comment:61

Passed tests on the buildbot!

[EmmanuelCharpentier]

Changed reviewer from R. Andrew Ohana to R. Andrew Ohana, Emmanuel Charpentier

[EmmanuelCharpentier]

comment:62

a173e92 builds without a hitch and passes (p)testlong with no failure ; the Ipython notebook is functional and displays Mathjax and asci art ==> positive review.

The (temporary) loss of 3D plotting is a (small) nuisance, though. Are there already tickets to watch for this functionality ?

I also note that plot3d(..) or p1=plot3d(...) ; p1 does display in the Ipython notebook, as long as no argument of plot3d has to be passed to show() and friends. Is this "vestigial" (or "embryonic") 3D displaying the intended behaviour ?

[kcrisman]

comment:63

The (temporary) loss of 3D plotting is a (small) nuisance, though.

I assume you mean only in the IPython notebook, not in the sagenb?

[EmmanuelCharpentier]

comment:64

Replying to @kcrisman:

The (temporary) loss of 3D plotting is a (small) nuisance, though.

I assume you mean only in the IPython notebook, not in the sagenb?

Yes, indeed. My curiosity was towards the notebook functionality : the Ipython notebook, wit its one-file container, is a real boon.

But, for me at least, not having typeset math (or at least decent ascii_art display) is a pain. So I'm eager to see an Ipython notebook with typesetting functionality.

[vbraun]

Changed branch from u/vbraun/rich_output_and_the_ipython_notebook to a173e92

[gagern]

comment:66

The changes committed here interfere heavily with my work from #7298 for animations displayed in the HTML5 <video> tag, and raise new questions for #16650 about APNG integration. I'd be very happy if the people involved in landing this code here could have a look at those tickets as well, advise how to proceed there and perhaps re-evaluate some design decisions made here.

[gagern]

Changed commit from a173e92 to none

[novoselt]

comment:67

Volker - what is the relation between stuff here and EMBEDDED_MODE? The latter is still spread over the source.

[vbraun]

comment:68

This ticket wasn't about removing the remaining 55 occurrences of EMBEDDED_MODE, thats another job... It should be removed, but its going to take time.

[gvol]

comment:69

I would like to use this to typeset the output in Emacs, but I need some sort of delimiters on the latex, so that I don't try to typeset backtraces, the result of print statements, etc. In fact, it would be nice to have both plain text and latex outputs properly delimited so that I can switch between the two. e.g. display the plain text until the latex rendering is finished.

Does it make sense to add a OutputDelimitedLatex class and update BackendIPythonCommandline? I run an ipython shell from inside Emacs.

[gvol]

comment:70

Replying to @gvol:

Does it make sense to add a OutputDelimitedLatex class and update BackendIPythonCommandline? I run an ipython shell from inside Emacs.

I have a very experimental branch at u/iandrus/emacs-typeset-output with the basics of what I'm thinking of. It's definitely not finished, but if the general approach seems reasonable, I'll polish it up and open a ticket etc.

[vbraun]

comment:71

IMHO emacs-mode should define its own backend, possibly by inheriting from the ipython command line backend. Thats why there are pluggable backends. Then you can format OutputLatex in precisely the way the emacs-mode needs without stepping on anybody else's toes.

[gvol]

comment:72

Replying to @vbraun:

IMHO emacs-mode should define its own backend, possibly by inheriting from the ipython command line backend. Thats why there are pluggable backends. Then you can format OutputLatex in precisely the way the emacs-mode needs without stepping on anybody else's toes.

Thanks. I opened #18115 with the new approach. It seems to work, but I've probably forgotten something.