Manage packages for notebook environment

Open the Environment tool

You have the following options:

• Click the Environment icon on the left-hand sidebar.

• Select Main menu | Tools | Environment.

• Use the command palette.

Change environment

1. Click Change next to the current environment name.

2. In the Change environment dialog, select another environment.

3. Click the Apply and restart kernel button to close the dialog and apply the changes.

   

Find and install packages

You can add packages to the environment of your notebook.

1. On the Explore tab, type the package name in the search field and press Enter.

2. After you get the search results, do one of the following:

   • Click the intended package to open it on a new tab. This allows you to view the package details and choose the version to install.

     

   • Hover over the package and click the Install icon to install it immediately.

     

3. After the package is installed, click restart kernel in the notification popup to complete the environment update.

Remove an installed package

1. Go to the Installed tab.

2. From the package list, hover over the one you want to remove and click the Remove icon.

   

3. Click OK in the popup to confirm your action.

4. After the package is removed, click restart kernel in the notification popup to complete the environment update.

Update an installed package

1. Go to the Installed tab.

2. From the package list, click the one you want to update. You can see its details on a new tab.

3. Click the version picker, select another version from the list, and click the Update button.

   

4. Click OK in the popup to confirm your action.

5. After the package is updated, click restart kernel in the notification popup to complete the environment update.

Use initialization scripts

For some additional tools and dependencies, you can run initialization scripts right in the Datalore editor.

1. Click init.sh. This will open the file in the editor pane.

2. Edit the file by adding the required initialization script.

3. Restart the machine: select Main menu | Run | Stop machine and click Restart machine in the popup in the lower right corner of the editor.

Use the environment.yml file

Every notebook is created with an automatically generated environment.yml file, which records the selected environment configuration and all changes to it made via the Environment tool. You can save this file to copy a specific environment configuration and use it in other notebooks.

1. Open the Attached data tool from the left-hand sidebar of the editor.

2. Download the environment.yml file.

3. Apply the saved file:

   • To use the same environment in another notebook, add the saved environment.yml file to the Notebook filescontrol>.

   • To use the same environment across all notebooks in a selected workspace, add the saved environment.yml file to the Workspace files.

4. Refresh the attachment file list to make sure the newly added file replaced the old one.

5. Restart the computation to have the packages from the new environment.yml file installed.

Packages added from the environment.yml file are persistent and can be viewed and managed in the Environment tool.

Use the init.sh file

You can use a init.sh file to customize the environment of your notebook via shell commands. You can also save this file to copy a specific environment configuration and use it in other notebooks.

1. Open the Attached data tool from the left-hand sidebar of the editor.

2. In the tool, click Edit init.sh to install additional dependencies. This will open the file in the editor on the right side of the screen.

3. Edit the file by adding the required shell commands.

4. Open the Attached data tool from the left-hand sidebar of the editor.

5. Download the init.sh file.

6. Apply the saved file:

   • To use the same environment in another notebook, add the saved init.sh file to the Notebook files.

   • To use the same environment across all notebooks in a selected workspace, add the saved init.sh file to the Workspace files.

7. Refresh the attachment file list to make sure the newly added file replaced the old one.

8. Restart the computation to have the packages from the new init.sh file installed.

Packages that are added using init.sh files are not saved to the environment.yml file and are not accessible from the Environment tool.