Manage notebooks

Last modified: 06 January 2025

Notebook is a Datalore file where you create and combine executable code, formulas, tables, charts, and texts.

Datalore consists of two basic components, and you use both to work with notebooks:

  • Home page

    This is where you create, upload, and manage notebooks. When on the Home page for the first time, you can only see one notebook, Getting started tutorial. Open this notebook to see how it looks in the editor and follow the procedures to make your first steps in Datalore.

    The Home page is also where you manage workspace resources, such as data sources or environment variables, which you can use in any of the notebooks from that workspace.

  • Editor page

    This is where you create and edit the content of your notebooks, which is organized in a variety of building blocks (cells). Read more in Learn editor basics.

In this article, you will learn how to manage notebooks in your workspaces, all procedures performed on the Home page.

View notebooks

You will view the notebooks right after selecting the workspace from the sidebar of the Home page. The list of the notebooks stored in the selected workspace looks as shown in the image below.

Viewing notebooks of the selected workspace

Quick actions:

  • Open a notebook: click the notebook you want to open in the editor.

  • Sort the notebooks: click the header of the column to sort the items accordingly.

  • Open a report: click the icon in the Report column. The icon is only visible for notebooks that are already published. Find more about report in this section.

Add a notebook

There are two ways to add a new notebook to a workspace. You can create a notebook, or you can import a notebook (.ipynb or .datalore) from your file system.

Create a notebook

  1. On the Home page, click the workspace where you want to create a notebook.

    note

    This is a very important step required to make sure you add the new notebook to the right workspace.

  2. Click the New notebook button in the upper right corner of the Home page.

    This will open the New notebook dialog.

  3. Provide a new title for your notebook in the Title field.

  4. On the Kernel tab:

    • Choose a kernel. Make your choice based on the language you want to use. The default Python kernel allows you to code in Python. Find more information about the kernels in Manage kernels.

    • Under Computation mode, select whether you want to use Jupyter mode or Reactive mode.

    • (Optional) Under Background computation, expand the list to set up background computation (disabled by default). Find more details in Use background computation.

    New notebook dialog

  5. To set up environment for your notebook, switch to the Environment tab of the New notebook dialog. Do the following:

    • Select a package manager.

    • Choose a base environment.

    Find more details in Choose a package manager for a new notebook.

    Environment tab

  6. To set up your machine options, switch to the Machine tab of the New notebook dialog. You can do the following:

    • Select whether to use only on-demand machines.

      warning

      This option is only available to Cloud plan users. Find the upgrade procedure in this topic.

    • Select a machine type for your computations.

    Find more details in Choose CPU and GPU machines.

    Machine tab

  7. Press Enter or click the Create notebook button to finish creating your notebook and open it in the editor.

The new notebook is added to the selected workspace. When you return from the editor to the Home page, you will be able to find it in the Notebooks list.

Import a notebook

  1. Click the Import button in the upper right corner of the Home page and select Import notebook from the menu. This will open the Import dialog.

  2. Use one of the following options:

    • Drag the notebook from your file system.

    • Click Select a notebook from your computer to add the notebook using the file browser.

    Upload notebook dialog

The added notebook will appear in the Notebooks list of the selected workspace.

Use the notebook menu

You have a number of options for notebook management, which vary depending on your access type. To access the options, right-click the notebook to open the menu.

note

Some of the options will not be available in the menu if you are managing a workspace shared with you by granting view access. Such options are marked in the table as Edit access only.

Action

Description

Open in new tab

Opens the notebook in the editor in another tab.

Share

Open the Share [notebook_title] dialog used to invite collaborators to work on this specific notebook. Find more details in this topic.

note

Sharing individual notebooks is only applicable to the Private workspaces.

Rename (Edit access only)

Used to edit the notebook title.

Toggle favorites

Marks the notebook as favorite. You can access all your favorite items from the left-hand panel of the Home page.

Move to trash (Edit access only)

Moves the notebook from the workspace to Trash. Unlike workspaces, notebooks moved to trash can be restored.

Copy

Creates a copy of the notebook for pasting into another workspace.

Paste

Pastes the previously copied or cut notebook into the currently viewed workspace or folder.

Export

Saves the notebook to your file system in one of the following formats (exact choice depends on the notebook language):

  • .ipynb

  • .zip

  • .py

  • .kts

  • .scala

  • .r

Find the procedure details in this topic.

note

Most of the actions described above are also available in the notebook editor under Main menu | File.

tip

For some of the options, you can use multi-select to apply them to more than one notebook.

Use folders

Folders can be a good solution, for example, when you want to organize your notebooks into several projects within one workspace.

  1. To create a folder, click the arrow icon next to the New notebook button and select New folder. Now, you can see your new folder on top of the notebook list.

  2. Use the drag-and-drop function to move notebooks into the folder. You can also populate your folders with just copies of your notebooks:

    1. Copy the notebook.

    2. Open the folder, right-click to call the popup menu, and select Paste.

  3. To rename, delete, or move the folder, right-click it and select the required action from the popup menu.

    Folder menu

note

Folders moved to trash can be restored.

Delete notebooks and manage trash

When deleting a notebook or a folder, you move it to Trash, where you can then restore it.

Access and manage Trash

Each workspace has its own Trash storage for deleted notebooks. You can access this storage if this is one of the workspaces you own or a workspace shared with you with edit access.

  1. Select Other from the menu of the expanded workspace.

    Selecting Other option

  2. In Other, switch to the Trash tab. This will open the list of trash notebooks.

    Workspace trash

Manage trashed items

  • (Optional) To empty the Trash list, click the Empty trash button in the upper right corner.

  • To remove or restore a trashed notebook, right-click the item and select one of the options:

    • Restore: to move the item from Trash to the workspace's Notebooks list.

    • Remove: to delete the item from the file system permanently

Managing trashed items

Keywords

Home page, Datalore overview, about Datalore, Datalore basic information, notebook management, Datalore notebooks, delete notebook, trash, remove notebook