You are viewing the documentation for an earlier version of DataSpell.
Manage your workspace
Last modified: 15 September 2022
Whatever you do in DataSpell, you do that in the workspace. Your workspace can contain local notebooks and other files, attached directories, and attached projects.
Click the Attach new of existing directory link in the Workspace tool window.
Select File | Attach Directory from the main menu.
Click the icon on in the toolbar of the Workspace tool window.
Select the target directory in your systems. Click Ok to confirm your choice.
To attach a new directory to the workspace, select the File | New Workspace Directory from the main menu or right-click the workspace tree and select New | New Workspace Directory from the context menu. Then specify the directory name and its location.
Once you attach a directory, 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).
If you want to work with any projects created in IntelliJ IDEA based IDE, you can open them from disk.
Open your project from disk
From the main menu, select File |Open.
In the Open File or Project dialog that opens, specify the location of the desired project directory.
Click OK. The selected directory will be attached to the workspace.
Attach a Git repository
Do one of the following:
From the main menu, select Git | Clone.
Right-click the workspace tree or a directory and select Get from Version Control from the context menu
Select Git:
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.
Click Clone.
note
Note that you can also enable Git integration for a selected directory: just right-click it and choose Enable VCS Integration from the context menu.
Once you cloned a Git directory, DataSpell creates a Python virtual environment, so that you can work with your files, and attaches the directory to the workspace.
If any of the attached directories requires a previously configured environment that is not currently available, DataSpell shows a warning and provides two options: select an environment that fits the previous configuration or configure another Python interpreter (environment):
Note, when you have an environment based on the outdated version of Python, the following message appears:
Click Configure Python interpreter to set up a valid one.
Detach a directory
Right-click the target directory and select Detach Directory from the context menu.
Connect to a Jupyter server
Click the icon on the toolbar of the Workspace tool window to establish a connection to a Jupyter server.
In the New Jupyter Connection dialog, select the connection type:
Run local Jupyter server: run a Jupyter server in a local directory that will be attached to your workspace.
Connect to running 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 by URL: establish a connection to a remote Jupyter server. The target URL should contain a server name or its address, and the access token.
Once the connection has been established, the server and its structure are shown in the Workspace tool window.
Once you have connected to a remote server, you can open, edit, run, and copy remote notebooks.
Rename notebooks
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 notebooks
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.
If required, type a new name for the notebook, and then click OK to confirm:
Move notebooks
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.
Click Refactor to confirm:
Copy folders
To copy a folder, right-click it in the Workspace tool window, choose Copy, then right-click the target local or remote directory and select Paste.
If required, type a new name for the notebook, and then click OK to confirm:
Move folders
To move a folder, 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.
icon on in the toolbar of the Workspace tool window.
icon on the toolbar of the Workspace tool window to establish a connection to a Jupyter server.
