Feature Spotlight: IPython Notebook inside an IDE

Happy Friday everyone,

This week I’d like to shed some light on the recently introduced IPython Notebook integration in latest PyCharm 4 which was announced a couple of weeks ago:

ipynb2This feature is considered to be the most important among other cool features that appeared in the latest release, and there is a reason behind it – IPython Notebook is very popular computational environment, and is an extremely useful solution for a wide range of tasks. There is no need to explain how great it is for scientists and data analysts and how convenient it is for learning programming or just showing off some topics or code snippets complemented with texts, graphics, mathematics and plots. It works great for so many people!

The PyCharm team is committed to make great things even better and to provide an extra value for Python programmers at large, so we eventually decided that we can integrate with IPython Notebook and deliver the solution that combines the advantages of IPython Notebook with extra benefits that the most intelligent Python IDE can offer.

Shortly, PyCharm allows you to open and modify *.ipynb files and run them using a standard IPython Notebook kernel. So lets take a look on how it works inside PyCharm.

Setting things up

Note: If you’re new to PyCharm, I recommend you to read the Quick Start Guide and Getting Started with PyCharm tutorials first.

Consider you already have IPython Notebook files somewhere on your filesystem and would like to work with them using PyCharm. For that, just open the directory containing the files with File | Open when using PyCharm:

open

Note: With PyCharm you can create new *.ipynb files from scratch. In this example I use File | Open for simplicity.

After that you’ll be able to open the files for editing from the Project View:

project_view

To make things working, you first need to specify the project interpreter that will be used for running the code in your *.ipynb files. You can do it in Settings(Preferences for Mac OS) | Project | Project Interpreter. Here you’ll need to check the desired interpreter by choosing from the list of autodetected interpreters or discover it manually. PyCharm also helps you to quickly create virtual environments and manage them. When you’ve selected the right interpreter or virtual environment please make sure you have all the necessary packages installed. For my demo, I already have IPython installed on the virtual environment with other dependencies necessary for IPython Notebook. In case some packages are not installed, please use the integrated package manager to install what is needed:

interpreter

Running code

Now we’re all set and ready to start coding with IPython Notebook. Click on the cell and then click on the run icon in the special IPython Notebook toolbar right on top of the editor:

toolbar

PyCharm will offer to start the IPython Notebook Kernel automatically and will provide you with an URL where the IPython Notebook kernel will run:

start

Click OK and in short time you’ll be notified that IPython Notebook started at the URL provided:

started

From this point you can work with IPython Notebook as usual. PyCharm supports all the basic functionality of ordinary IPython Notebook. The latest format of IPython Notebook files is also supported. You can add new cells, cut and paste them, run arbitrary cells, and change their type. We’ve tried to preserve the similar behavior of ordinary IPython Notebook as much as possible – you can edit and review mathematical formulas in LaTeX, output plots and different graphics, and do other usual actions:

ipynb1

In this blog post I’m not going to cover each aspect of the IPython Notebook integration – instead, I’ll answer the 2 most frequent general questions about this new functionality:

What’s the reason to use PyCharm over classic IPython Notebook?
The main advantage is that PyCharm brings the intelligence and all the additional advantages of an IDE when working with IPython Notebook files. That means you get a code autocompletion, error detection, on-the-fly code fixes and suggestions, navigation and refactorings, local history, VCS support, and a lot more. So basically you get all the neat stuff that makes any developer who uses PyCharm more productive:

ipythonnotebook_whatsnew@2x

There’s also a number of extra features that are not present in classic IPython Notebook, but will be implemented in future versions, like running all cells in one click.

What’s not supported yet?
There is a number of IPython Notebook features that are not supported yet, like interrupt/reload kernel actions, html injections, export to .py files, and some other. After releasing the first version of IPython Notebook integration, we’ve got a bunch of suggestions, bugs and feature requests in our issue tracker. And we’re planning to significantly improve this integration for the next version of PyCharm.

I’d like to encourage you to start using the IPython Notebook integration right away and if you have any problems or suggestions, please file them to our tracker. It’ll help us fix the problems and implement new features even faster.

And here’s some more great news: IPython Notebook integration is supported in PyCharm Community Edition, which means everybody can use it for free!

In this blog post we touched just a tip of the IPython Notebook integration iceberg. Please try it in action and give us your feedback in our forum and the public issue tracker!

Here you can find a complete tutorial for using IPython Notebook with PyCharm.

See you next week!
-Dmitry

About Dmitry Filippov

Product Marketing Manager at JetBrains
This entry was posted in Cool Feature. Bookmark the permalink.

21 Responses to Feature Spotlight: IPython Notebook inside an IDE

  1. David says:

    “For my demo, I already have IPython installed on the virtual environment with other dependencies necessary for IPython Notebook. In case some packages are not installed, please use the integrated package manager to install what is needed:”

    I use IPython Notebooks, but I haven’t used PyCharm before. I downloaded and installed it so I could follow along with this article, but this is the point at which I stopped.

    Since I’m using IPython Notebooks independently, I assume I have all the necessary dependencies installed, but PyCharm’s Project Interpreter page doesn’t list it as a package. When I invoke IPython from the command line, it calls a script which sets up the environment and calls ipython.exe, but neither the script nor ipython.exe seem to be the “package” that PyCharm wants.

    As someone who has not used PyCharm before, I just thought I’d give you a heads up that this article doesn’t really help me get started, and doesn’t provide a link to where I might find out more about the “integrated package manager”. I’ll check out the “complete tutorial” listed at the end of the article to see if that’s more helpful.

    I understand that the focus of this article is probably existing PyCharm users who just want to learn how to use this new feature, but I suspect even some of them might not be familiar with the integrated package manager and how to create a project interpreter. I could be wrong.

    • Dmitry Filippov says:

      Hi David,

      thank you for your feedback on this article!
      Indeed, there is no any guideline for those who are new to PyCharm in this post.
      I’m going to update this post adding links to some basic getting started tutorials in the beginning.
      There’re 2 jump starting tutorials for PyCharm:
      1. http://confluence.jetbrains.com/display/PYH/Exploring+the+IDE.+Quick+Start+Guide – Explains some general concepts.
      2. http://confluence.jetbrains.com/display/PYH/Getting+Started+with+PyCharm – Step-by-step guide creating and running a project from scratch.

      You can read about the “integrated package manager” here:
      http://confluence.jetbrains.com/display/PYH/Exploring+the+IDE.+Quick+Start+Guide
      See “Project Interpreter, Local interpreter, Virtual environment, Packages and paths” sections.

      IPython is a wrapper around a Python interpreter and normally is being installed as a package for a Python interpreter. So please ensure that you’ve selected a correct Python interpreter with IPython installed and that the other packages required to run IPython Notebook are also installed: Jinja2, pyzmq, tornado.
      You can review and install everything using the integrated package manager.
      There can be several interpreters on your system and probably your PyCharm uses an interpreter without ipython by default. So please choose the right one and install everything missing.
      Hope this helps!

  2. Kyle Kelley says:

    From reading this, it sounds like you’re actually running a full notebook server when you could connect directly using ZeroMQ to a running kernel and use all the existing open specs for communication and display. My primary reason for wanting this is so you don’t have to run a full blown IPython/tornado server on someone’s local machine (to lower overall risks).

    • ktisha says:

      Hi Kyle,

      in case you have running Ipython server you could specify it’s URL in Settings->Tools->Ipython Notebook. PyCharm will connect to a running instance using ZeroMQ.

  3. Bastian says:

    Is it possible to do that with intellij idea 14 ?

  4. Daniel says:

    Great set of features. Looking forward to the plugin for IDEA 14. Will it be released in the next 2 weeks?

  5. Martin Bless says:

    That’s breathtaking! Thank you for these great features and – keep on!

  6. Jon Tirsen says:

    This is really awesome. When I change the Python code the notebook doesn’t get reloaded. Does anyone know how to restart the Python process to reload the code?

  7. Hojjat says:

    Hi Dmitry,

    Thanks for the cool tutorial! I have some problems with the IPython notebook in PyCharm, which I hope you can help:

    1) when I insert a latex formula, it shows that as an image with broken link in the cell!
    2) I cannot run python codes in the cell.
    3) Instead of “ln[.]” where “.” is the line number, I have “ln[*]”!

    Thanks!

  8. Pingback: Google’s Deep Dream in PyCharm | JetBrains PyCharm Blog

  9. Riki says:

    I’m using PyCharm 4.5.4 and facing some problem with ipython. Actually nothing comes out in the output. My guess is that it is associated with PyCharm’s ipython plugin. iPython works very well with web browser. I’m using anaconda’s python packages. Everything is installed for ipython.

    IPython Notebook run gives:
    /Users/riki/Applications/anaconda/bin/python /Users/riki/Applications/anaconda/bin/ipython notebook –no-browser –ip 127.0.0.1 –port 8888
    [W 01:47:47.415 NotebookApp] ipywidgets package not installed. Widgets are unavailable.
    [I 01:47:47.436 NotebookApp] Serving notebooks from local directory: /Users/riki/PythonProjects
    [I 01:47:47.436 NotebookApp] 0 active kernels
    [I 01:47:47.436 NotebookApp] The IPython Notebook is running at: http://127.0.0.1:8888/
    [I 01:47:47.436 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).
    [W 01:47:49.849 NotebookApp] 404 GET /api (127.0.0.1) 25.85ms referer=None
    [I 01:47:49.879 NotebookApp] Kernel started: 1071a698-99ca-4218-b8dd-28e7168ef2f8
    [W 01:47:49.894 NotebookApp] 404 GET /api/kernels/1071a698-99ca-4218-b8dd-28e7168ef2f8/shell (127.0.0.1) 2.03ms referer=None
    [W 01:47:49.898 NotebookApp] 404 GET /api/kernels/1071a698-99ca-4218-b8dd-28e7168ef2f8/iopub (127.0.0.1) 1.53ms referer=None

    Python console gives:
    /Users/riki/Applications/anaconda/bin/python -u /Applications/PyCharm.app/Contents/helpers/pydev/pydevconsole.py 50572 50573
    /Users/riki/Applications/anaconda/lib/python3.4/site-packages/IPython/utils/traitlets.py:5: UserWarning: IPython.utils.traitlets has moved to a top-level traitlets package.
    warn(“IPython.utils.traitlets has moved to a top-level traitlets package.”)
    Python 3.4.3 |Anaconda 2.3.0 (x86_64)| (default, Mar 6 2015, 12:07:41)
    Type “copyright”, “credits” or “license” for more information.

    IPython 4.0.0 — An enhanced Interactive Python.
    ? -> Introduction and overview of IPython’s features.
    %quickref -> Quick reference.
    help -> Python’s own help system.
    object? -> Details about ‘object’, use ‘object??’ for extra details.
    PyDev console: using IPython 4.0.0

    import sys; print(‘Python %s on %s’ % (sys.version, sys.platform))
    sys.path.extend([‘/Users/riki/PythonProjects’])

    Python 3.4.3 |Anaconda 2.3.0 (x86_64)| (default, Mar 6 2015, 12:07:41)
    [GCC 4.2.1 (Apple Inc. build 5577)] on darwin

  10. Alex says:

    ALL these tutorials are FU*CKING OUTDATED! ALL of them!

    This is a commercial product! I paid for it and the support simply stinks!
    There’s not a single document around regarding this IDE that is true to the current version of the product, which obviously changed many elements of its UI/UX to which I’m entirely new to, and therefore completely lost!

  11. Graham says:

    After a bit of a struggle all working well now. Looks good generally, but the margins on the left and right are sooooo large it makes it impossible to use properly on a small laptop screen.

    Can these margins be shrunk? otherwise it’s back to the browser unfortuantely :(

    • Dmitry Filippov says:

      Thank you for the feedback. Currently it’s not possible to adjust margins. With the next PyCharm release we’re going to rework Jupiter integration.

Leave a Reply

Your email address will not be published. Required fields are marked *