DataSpell 2024.1 Help

Manage your workspace

On the Welcome screen, you can choose whether you want to work with projects, or open DataSpell workspace. You can add directories and projects to the workspace, as well as connect to Jupyter servers.

Adding directories and projects to the workspace

Add an existing directory or project

  1. Do one of the following:

    • Click the Attach new of existing directory link in the Workspace tool window.

    • Select File | Add Directory or Project from the main menu.

    • Click in the toolbar of the Workspace tool window.

    Adding an existing directory to the workspace
  2. Find the desired directory in your file system. To add a project, select the project directory.

Add a new directory

  1. Do one of the following:

    • Go to File | New Top-Level Directory

    • Right-click anywhere in the Workspace tool window and select New | New Top-Level Directory from the context menu

  2. Specify the directory name and location:

    Adding a new directory to the workspace

For more information about creating a new project, refer to Create a project.

Add a Git repository

  1. Do one of the following:

    • Go to Git | Clone.

    • Right-click the workspace tree or a directory and select Get from Version Control from the context menu

  2. Select Git:

    Open a project from VCS
  3. Specify the path to the repository and select the directory to which it will be cloned. Do not select the default DataSpell installation directory as the target local directory. Alternatively, you can select GitHub on the left, login using your credentials, and select any repository you want to work with.

  4. Click Clone.

Once you add a directory or a project, it appears in the Workspace tool window. You can open files that reside in it, or create new files (see how to add new Jupyter notebooks and Python files).

DataSpell will use the default virtual environment to execute notebooks and scripts in the newly added directory or project. You can switch to another environment or create a new one.

Connect to a Jupyter server

  1. Click the Add Jupyter Connection icon on the toolbar of the Workspace tool window to establish a connection to a Jupyter server.

  2. In the New Jupyter Connection dialog, select the connection type:

    • Start a local Jupyter server: run a Jupyter server in a local directory that will be attached to your workspace.

    • Connect to a running local Jupyter server: establish a connection to any locally run Jupyter server. The option is enabled if there is at least one active Jupyter server on your machine. Run jupyter notebook list in the Terminal window to check if there are any.

    • Connect to Jupyter server using URL: establish a connection to a remote Jupyter server. The target URL should contain a server name or its address, and the access token.

    Add a remote connection to a Jupyter server

    Once the connection has been established, the server and its structure are shown in the Workspace tool window.

    Remote Jupyter server in the Workspace tool window

Once you have connected to a remote server, you can open, edit, run, and copy remote notebooks.

Organizing directories and projects in the workspace

Remove a directory or a project

  • Right-click the target directory and select Detach Directory from the context menu.

Copy a directory

  1. To copy a directory, right-click it in the Workspace tool window, choose Copy, then right-click the target local or remote directory and select Paste.

  2. If required, type a new name for the notebook, and then click OK to confirm:

    Confirm copying the folder

Move a directory

  1. To move a directory, you can do one of the following:

    • Right-click it in the Workspace tool window, choose Cut, then right-click the target local or remote directory and select Paste.

    • Drag-and-drop it to the target local or remote directory.

  2. Click Refactor to confirm:

    Confirm moving the notebook

Managing notebooks in directories and projects

Rename a notebook

  • To rename a notebook, select the target file in the Workspace tool window, right-click it, choose Refactor | Rename, and specify a new filename.

Copy a notebook

  1. To copy a notebook, right-click it in the Workspace tool window, choose Copy, then right-click the target local or remote directory and select Paste.

  2. If required, type a new name for the notebook, and then click OK to confirm:

    Confirm copying the notebook

Move a notebook

  1. To move a notebook, you can do one of the following:

    • Right-click it in the Workspace tool window, choose Cut, then right-click the target local or remote directory and select Paste.

    • Drag-and-drop it to the target local or remote directory.

  2. Click Refactor to confirm:

    Confirm moving the notebook
Last modified: 29 March 2024