Download a Notebook Without Cloning the IDE (Tutorial)—DRAFT
Last updated 2026-07-17At a Glance
When someone runs upload_files() (Python) | uploadFiles (R) from an IDE attached to a study, HISE saves the IDE state and records the notebook used for that upload. Previously, if another analyst or scientist wanted that notebook, they had to clone the IDE instance from the study's IDE Instances view and open the notebook in the cloned IDE.
This tutorial explains how to use the SDK to download that work-in-progress (WIP) notebook directly, without cloning the IDE. In this tutorial, a WIP notebook is a notebook HISE captures during an upload_files() call.
When to Use This Feature
Use this feature when you identify a notebook associated with an IDE upload, but you don't want to clone the full IDE. This is useful, for example, when another scientist has already uploaded files or visualizations to a study and you want to review or reuse the notebook containing that work.
Method Signature
The signature for this method is listed below. Click the tabs to toggle from Python to R.
Python signature
def get_ide_artifacts(ide: str | None = None,
trace: str | None = None) -> list[str]:R Signature
hisepy::get_ide_artifacts(
ide = NULL,
trace = "your-uuid-here"
)Parameters
The parameters for this method are listed in the following table. Click the tabs to toggle from Python to R.
NOTE
You must use one of the two parameters, but not both.
Parameter | Data type | Required or optional | Description | |||
|
| optional | IDE UUID | |||
|
| optional | Trace UUID |
Parameter | Data type | Required or optional | Description | |||
|
| required | An IDE instance UUID | |||
|
| required | A trace UUID |
NOTE
Use the no-clone workflow if you need only the notebook file itself. If you need the full IDE environment, workspace state, or a complete working copy of the original IDE, clone the IDE instead.
Instructions
Copy the trace or IDE UUID
Identify the study and IDE instance associated with the uploaded work you want to review,
Use your organizational email address to sign in to HISE.
Go to Collaboration space > Your Studies, and click the card for the study you want to see.
In the side navigation, click IDE Instances.
On the IDE Instances page, select the IDE instance that contains the notebook you want to download.
From the far-right column, copy the UUID.
Download the WIP notebook with the SDK
Open an IDE, import hisepy, and call
hp.get_ide_artifacts()with the UUID you copied in Step 1 as thetracevalue or theidevalue:
paths = hp.get_ide_artifacts(
ide="a9793cf3-361a-49cb-8b04-96db8a30477"
)
2. To inspect, review, or continue the work, open the downloaded notebook in your local environment or your own IDE workspace.