Jupyter Notebook in Cognite Data Fusion
Jupyter Notebook is integrated with Cognite Data Fusion (CDF) and you can create interactive notebook documents that can contain live code, equations, visualizations, and media.
The features described in this section are currently in beta testing and are subject to change.
You can store the notebooks permanently or temporarily:
-
Permanently — all files are stored in Cognite Data Fusion and you can share them with other users. You can't change the default files and folders.
-
Temporarily — all files are stored temporarily in your browser. Save your notebooks externally to avoid losing them when clearing the browser cache.
All notebooks operate in a secure and private sandbox environment and have no direct access to your computer.
To learn more, refer to the Getting started guide for JupyterLab.
Create a notebook and store it permanently
To create a notebook and store it permanently:
-
Navigate to Data management > Build solutions > Jupyter Notebook.
-
In the Stored in Cognite Data Fusion section, select the Notebooks folder, and then select the data set folder you want to work with.
Each sub-folder in the Notebooks folder is mapped to a data set that you need
read
/write
access to. Only data sets where you have the proper access level will be listed. If the Notebooks folder is empty, request the necessary capabilities and create a data set to add your folder. -
Select + and select the notebook Python file (.ipynb).
-
Save the changes before leaving Jupyter Notebook.
Each Python file (.ipynb) has an authentication helper to run the code with the current user's credentials, ensuring that they can work with data relevant to their role and projects.
from cognite.client import CogniteClient
# Authenticate under current user credentials
client = CogniteClient()
If several users are working on the same file, Jupyter Notebook doesn't resolve conflicts and you risk losing changes.
Only files with the .ipynb extension are saved in Cognite Data Fusion. Other file types are deleted when you leave Jupyter Notebook.
Create a notebook and store it temporarily
To create a notebook and store it temporarily:
-
Navigate to Data management > Build solutions > Jupyter Notebook.
-
On the starting page, select + and select the file to create.
-
Save the changes before leaving Jupyter Notebook.
Each Python file (.ipynb) has an authentication helper to run the code with the current user's credentials, ensuring that they can work with data relevant to their role and projects.
from cognite.client import CogniteClient
# Authenticate under current user credentials
client = CogniteClient()
If several users are working on the same file, Jupyter Notebook doesn't solve conflicts and you risk losing changes.