Last modified 2026-03-29

Update the SDK Version (Tutorial)

	Abbreviations Key
HISE	Human Immune System Explorer	SDK	software development kit
`hp`	hisepy	`str`	string
IDE	integrated development environment

At a Glance

This document explains how to call update_sdk_version(), which downloads the latest version of the HISE SDK to /home/workspace/sdk and updates that version within the current Conda environment. You must restart the kernel or terminal for the changes to take effect. The Python call updates only the hisepy SDK. Likewise, the R call updates only the R SDK.

We recommend updating your SDK version regularly. The SDKs are designed to be backward compatible when we add new features, and sometimes SDK version updates fix critical bugs found in older versions.

The udate_sdk_version() Python signature appears in the box below. This function takes no arguments.

hp.update_sdk_version()

Get Help

If you get stuck during an update_sdk_version() call, refer to the steps of this tutorial (examples are in Python unless otherwise specified). To use the baked-in help in your IDE, try one of the following commands.

Python	R	Output
`help(hp.update_sdk_version)`	`help(updateSDKVersion)`	Function signature, list of parameters, class, and a brief description of the method in a compact plain-text format
`hp.update_sdk_version?`	`?updateSDKVersion`	Method signature, docstring (description), file location, and file type in more readable format
`hp.update_sdk_version??`	`hise::updateSDKVersion`	Signature, docstring, file path, a verbose set of metadata, and the source code for the method

Still not working? Contact Support to file a ticket.

Instructions

Import libraries

To get started, set up your environment to interact with HISE programmatically and access all available SDK functions. For details, see Use Hise SDK Methods.

1. Navigate to HISE, and use your organizational email address to sign in.

2. Open a Python notebook in the IDE. For instructions, see Create Your First IDE Instance (Tutorial).

3. To import hisepy, enter the following code into a new cell in your notebook.

# Import the Python SDK to enable programmatic access to HISE functions
import hisepy as hp

Call the function

1. Update to the latest SDK version.

# Return confirmation that the SDK has been updated hp.update_sdk_version()

Step 3: Confirm that the SDK version persists

After you update to the latest SDK version, reboot your IDE to finish applying the change. Once the restart is complete, the updated SDK version now persists across IDE restarts, so you don’t need to reapply it manually each time you open the IDE.

1. To confirm that the newer SDK version is active, run a quick version check in your notebook or console.

# Check the active version
hp.__version__

If the reported version matches the latest SDK version you expect, your environment is up to date and will retain the current SDK version across future restarts.

Related Resources

Best Practices for HISE IDE Users

Attach an IDE to a Study (Tutorial)

Use HISE SDK Methods and Get Help

Create Your First HISE IDE Instance (Tutorial)