Skip to content

Latest commit

 

History

History
97 lines (63 loc) · 2.45 KB

USER_GUIDE.md

File metadata and controls

97 lines (63 loc) · 2.45 KB
Raw

nteract

nteract is a literate coding environment that supports Python, R, JavaScript and other Jupyter kernels. It wraps up the best of the web based Jupyter notebook and embeds it as a desktop application. Now, you can open notebooks natively on your system. Double-click on a .ipynb file to open and begin using the notebook. It Just Works™

Installation

To get started, download the latest release for your OS.

Authoring Notebook Files (.ipynb)

Create a New Notebook

A new notebook can be created by accessing the menu,

  File
    -->  New
          -->  <Language Kernel> (e.g. Python 3, R, Julia etc.)

Opening a Notebook

There are several ways to open a notebook in nteract:

  • From the menu:
  File
    -->  Open

Keyboard shortcut ⌘O on macOS and Ctrl-O on Windows/Linux

  • Double-click a notebook file 🎉 Note: currently this works only in macOS

  • From the Command Line (assuming you have shell commands installed), run nteract notebook.ipynb:

Saving a Notebook

A notebook can be saved in the following ways:

  File
    ⮑  Save

Keyboard shortcut: ⌘S on macOS and Ctrl-S on Windows/Linux

  File
    ⮑  Save As

Keyboard shortcut: ⇧⌘S on macOS and Shift-Ctrl-S on Windows/Linux

Notebook Cells

Adding a Cell

Code Cells

A code cell can be created by accessing the menu,

  Edit
    ⮑  New Code Cell

Keyboard shortcut: Shift ⌘N on macOS or Shift Ctrl-N on Windows/Linux

A code cell can also be created by clicking <> on the cell hover menu.

Text Cells

A text cell can be created by accessing the menu,

  Edit
    ⮑  New Text Cell

Keyboard shortcut: Shift ⌘M on macOS or Shift Ctrl-M on Windows/Linux

A text cell can also be created by clicking M on the cell hover menu.

Text cells support the commonmark spec.

Note: commonmark does not include the GFM (Github flavored markdown) table syntax.

Running a Cell

A cell can be run from the keyboard by pressing Shift ⏎ or by selecting the ▶︎ button from the cell toolbar.

N.B. To run all cells at once, access the menu:

  Cell
    ⮑  Run All

Moving a Cell

A cell can be moved anywhere in the notebook by clicking and dragging to desired position.