Skip to content

Commit

Permalink
Merge pull request #1233 from astrofrog/doc-fix-961
Browse files Browse the repository at this point in the history
Revising FAQ on launching glue from an ipython notebook
  • Loading branch information
astrofrog committed Feb 10, 2017
2 parents e0cfc2a + 8e47dbe commit fcfe403
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions doc/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,22 +36,22 @@ Take a look at this video. For more details, consult the :ref:`tutorial <getting
How do I use Glue with the IPython notebook?
--------------------------------------------

For IPython version >= 1.0, Glue can be started from the IPython HTML notebook
without blocking, so that both the notebook and the Glue UI can run at once.
This requires starting the notebook such that it cooperates with Qt. To do this,
start the notebook with::
For IPython version >= 4.0, Glue can be started from a Jupyter notebook without
blocking, so that both the notebook and the Glue UI can run at once. This
requires running the following magic function::

ipython notebook --gui qt
%gui qt

And then starting glue (probably by calling :ref:`qglue <qglue>`) from the
And then starting glue (probably by calling :ref:`qglue <qglue>` or creating an
instance of :class:`~glue.app.qt.application.GlueApplication`) from the
notebook.

If you encounter an error like this::

ValueError: API 'QString' has already been set to version 1

set the ``QT_API`` environment variable to either ``pyqt`` or ``pyside``,
depending on which version of Qt you have installed::
set the ``QT_API`` environment variable to either ``pyqt``, ``pyqt5``, or
``pyside``, depending on which version of Qt you have installed::

QT_API=pyside ipython notebook --gui qt

Expand Down

0 comments on commit fcfe403

Please sign in to comment.