Notebook Structure

A notebook in Cytomic Orion follows the same layout as a Jupyter notebook. This image shows the parts that make up a notebook:

General structure of a notebook

  • Notebook toolbar (1): Provides the most commonly-used actions to interact with the notebook.

    • Show/hide table of contents : Shows/hides the table of contents built from the headers included in Markdown cells.

    • Save : Stores the notebook content on the server.

    • Convert to PDF : Hides code cells and saves cell output to a PDF or HTML file, including tables, charts, diagrams and other static items.

    • Run cell : Sends the cell content to the kernel and collects the output.

    • Run all cells : Sends the content of all cells sequentially and collects the output for each cell.

    • Run presentation : Runs all of the notebook cells and turns the notebook into a presentation. See Run a Notebook.

    • Interrupt the kernel : Interrupts the cell execution.

    • Restart and clear output : Stops the kernel, starts it again, and clears all the existing cell outputs.

    • Add cell : Creates a new cell below the selected cell.

    • Cell type: Specifies whether the cell is a code or Markdown cell.

    • Copy cell : Copies the cell to the clipboard.

    • Cut cell : Copies the cell to the clipboard and deletes it from the notebook.

    • Paste cell : Inserts, in the notebook, the cell you previously copied to the clipboard.

    • Move cell up : Moves the cell position one step up.

    • Move cell down : Moves the cell position one step down.

    • Hide cells : Deletes the Python code to show only the outputs of the run cells.

    • Create quick answer : Adds a quick answer to the library. See Quick Answer Management.

    • Notebook name (2): To change the name of the notebook, click the text box. A dialog box opens that prompts you to enter the new name. Click OK. The new name is assigned to the notebook.

    • Kernel status (3): Specifies whether the notebook execution engine is stopped (Idle) or running a cell (Busy).

  • Notebook cell (4): A cell is the basic unit of a notebook. A cell consists of a text box that accepts one or more code lines and a group of icons to perform quick actions:

    • : Makes a copy of the selected cell below it.

    • : Moves the selected cell up.

    • : Moves the selected cell down.

    • : Adds a new cell above the selected cell.

    • : Adds a new cell below the selected cell.

    • : Deletes the selected cell.

  • Quick answers list (5): Quick answers are small code snippets that speed up analyst investigation tasks. See Quick Answer Management.

  • Search box (6): Enter a full or partial quick answer name to add the quick answer to the notebook.

  • View mode (7): Switch between code entering mode (Code) and output presentation mode (Presentation). For more information, see Run a Notebook.