Skip to content

Latest commit

 

History

History
137 lines (89 loc) · 3.58 KB

USER_GUIDE.md

File metadata and controls

137 lines (89 loc) · 3.58 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.)

Or from the command line, run nteract notebook.ipynb

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:

  • Save:

      File
    ⮑  Save

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

  • Save As:

      File
    ⮑  Save As

    Keyboard shortcut: Shift ⌘ 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
    ⮑  Insert Code Cell Above
    ⮑  Insert Code Cell Below

    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

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

    Text cells support the commonmark spec along with inline mathematics, block mathematics, and tables.

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.

Cell Shortcuts

Command macOS Windows/Linux
Insert Cell Above Shift ⌘ A Shift Ctrl A
Insert Cell Below Shift ⌘ B Shift Ctrl B
Delete Cell Shift ⌘ D Shift Ctrl D
Change Cell Type to Markdown Shift ⌘ M Shift Ctrl M
Change Cell Type to Code Shift ⌘ Y Shift Ctrl Y
Copy Cell Shift ⌘ C Shift Ctrl C
Paste Cell Shift ⌘ V Shift Ctrl V
Cut Cell Shift ⌘ X Shift Ctrl X

General Shortcuts

  • Autocomplete Suggestions: Ctrl Space
  • Documentation/Tips Expansion: Ctrl Period(.) (on Windows/Linux) or ⌘ Period(.) (on MacOS)

Command Line

Usage: nteract <notebooks> [options]

Examples:

Open multiple notebooks: nteract notebook1.ipynb notebook2.ipynb

Open new notebook with specific kernel: nteract --kernel javascript

Open new notebook with specific filename: nteract mynotebook.ipynb

Environment Variables

  • NTERACT_DESKTOP_DISABLE_AUTO_UPDATE - Set to "1" to disable auto-updates.
  • DEBUG - Set to "true" to enable additional logging.
  • ELECTRON_ENABLE_LOGGING - Set to "1" and launch from a terminal to pipe Javascript console logs to that terminal.