[isaacsim.core.version] Isaac Sim Version#
Version: 2.1.0
Overview#
The isaacsim.core.version extension provides tools to query Isaac Sim version and build information. It enables developers to programmatically access detailed version components from Isaac Sim applications, including major, minor, patch versions, prerelease tags, and build metadata.
Key Components#
Version Object#
The Version class serves as a structured data container for parsed version information. It breaks down complex version strings into individual components:
version = Version()
# Contains attributes: core, prerelease, major, minor, patch, pretag, prebuild, buildtag
Each attribute stores a specific part of the version string, making it easy to access individual components for comparison, display, or version-specific logic implementation.
Version Parsing#
The parse_version function converts raw version strings into structured Version objects:
version_obj = parse_version("1.2.3-alpha.1+build123")
# Breaks down the string into major=1, minor=2, patch=3, prerelease info, etc.
This parsing follows semantic versioning patterns, extracting meaningful components from complex version strings that may include prerelease identifiers and build metadata.
Version Retrieval#
The get_version function directly accesses Isaac Sim’s VERSION file to retrieve current application version information:
core, prerelease, major, minor, patch, pretag, prebuild, buildtag = get_version()
This provides immediate access to the running application’s version details without requiring manual file reading or parsing.
Functionality#
The extension handles version strings that follow semantic versioning conventions, supporting complex formats with prerelease tags and build metadata. The parsed components enable version comparison logic, compatibility checks, and feature detection based on specific Isaac Sim releases.
Version information is accessed directly from Isaac Sim’s internal VERSION file, ensuring accuracy and consistency with the actual application build being executed.
Enable Extension#
The extension can be enabled (if not already) in one of the following ways:
Define the next entry as an application argument from a terminal.
APP_SCRIPT.(sh|bat) --enable isaacsim.core.version
Define the next entry under [dependencies] in an experience (.kit) file or an extension configuration (extension.toml) file.
[dependencies]
"isaacsim.core.version" = {}
Open the Window > Extensions menu in a running application instance and search for isaacsim.core.version.
Then, toggle the enable control button if it is not already active.
Python API#
Version parsing and management utilities for Isaac Sim.
- class Version#
Bases:
objectA data structure for storing parsed version information.
This class represents a structured version object that holds the different components of a version string after parsing. It provides separate attributes for major, minor, and patch version numbers, as well as prerelease and build metadata.
The version components are initially empty strings and are populated by parsing functions like
parse_version(). This allows for easy access to individual version parts for comparison, display, or other version-related operations.Version strings typically follow semantic versioning patterns like “1.2.3-alpha.1+build123”, which get broken down into their constituent parts and stored in the respective attributes of this class.
- get_version() tuple[str, str, str, str, str, str, str, str]#
Retrieve version from the App VERSION file.
- Returns:
Tuple containing core version, pre-release tag and build number, major version, minor version, patch version, pre-release tag, build number, and build tag.