> For the complete documentation index, see [llms.txt](https://www.opal-rt.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/automate-with-python-script/use-the-sequencer-tool/user-interface.md).

# Sequencer User Interface

## Description

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-beb1d50c1d20f9c81b0e9429da6d4bc4d1166ed5%2Fsequencer-tool-UI.png?alt=media" alt="" width="375"><figcaption></figcaption></figure>

The sequencer user Interface is divided into 4 main areas:

1. Menu bar
2. Toolbar
3. Editor
4. Console Outputs

## Menu bar

<table><thead><tr><th width="199.5555419921875">Section</th><th>Description</th></tr></thead><tbody><tr><td><strong>File Management</strong></td><td><strong>New python script (Ctrl+N)</strong>: Creates a new Python script. Specify the script name with the extension .py and save the file.<br><strong>Open... (Ctrl+O):</strong> Opens an existing python script.<br><strong>Open Recent:</strong> Allows opening a script amongst the 10 most recently opened files.<br><strong>Save (Ctrl+S)/Save As..:</strong> Allows the user to save a script. By default, the script is saved in the current <strong>HYPERSIM Project Content</strong> directory, but it can also be saved to any other location in the file system.<br><strong>Save All (Ctrl+Shift+S):</strong> Allows you to save all the scripts that have been modified in the editor.<br><strong>Exit</strong>: Exit and Close HySequencer window.</td></tr><tr><td><strong>Edit</strong></td><td><p><strong>Ctrl+z:</strong> Undo last action.<br><strong>Ctrl+y:</strong> Redo last undone action.<br><strong>Ctrl+x:</strong> Cut selected text or item.<br><strong>Ctrl+c:</strong> Copy selected text or item.</p><p><strong>Ctrl+v:</strong> Paste from clipboard.<br><strong>Ctrl+a:</strong> Select all</p></td></tr><tr><td><strong>View</strong></td><td><strong>Theme:</strong> Allows you to change the editor’s background theme. Two modes are available: <strong>Light</strong> and <strong>Dark</strong>. By default, the editor uses Dark mode. Changing the theme does not affect script execution and is purely cosmetic.<br><strong>Toggle Developer Tools</strong>: Opens the built-in developer tools window, which provides advanced diagnostic information such as console logs, network activity, and performance data. This feature is intended for advanced users and support purposes; changes made here may affect the interface but do not modify project or sequence files.<br><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-f1d5b4577778754152acf65f6b80ed941c8f24cf%2Fsequencer-editor-devtools.png?alt=media" alt=""></td></tr><tr><td><strong>Run</strong></td><td>Run or stop your script from the menu, or use the keyboard shortcuts F5 (Run) and Shift+F5 (Stop).</td></tr><tr><td><strong>Environment</strong></td><td><p>Lets you add your own environment variables when running a sequence. These variables are added to (and used alongside) HYPERSIM’s environment variables.<br><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-04526976338abf47594c41ed7beb5b4492a8aaee%2Fsequencer-tools-variable_envt.png?alt=media" alt=""><br>To assign multiple values to a single variable, click <strong>Add Variable</strong>.</p><p>External Python scripts can be imported and recognized by auto-completion by adding the external folder path to the <strong>PYTHONPATH</strong> environment variable.</p></td></tr></tbody></table>

{% hint style="danger" %}
The Sequencer currently uses the Python version embedded within HYPERSIM. For any advanced usage using community or private libraries, it is recommended to use an **external tool** and follow the [Use Python API](https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/automate-with-python-script.md) documentation.
{% endhint %}

## Tool bar

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-5a451f4cdb66251a504bf5154bce90506ecb5172%2Fsequencer-tool-bar.png?alt=media" alt=""><figcaption></figcaption></figure>

<table data-header-hidden><thead><tr><th width="239.77789306640625">Command</th><th>Description</th></tr></thead><tbody><tr><td><strong>New Python Script (Ctrl+N)</strong></td><td>Create a new Python script file.</td></tr><tr><td><strong>Open File (Ctrl+O)</strong></td><td>Open an existing Python script.</td></tr><tr><td><strong>Save (Ctrl+S)</strong></td><td>Save the current script.</td></tr><tr><td><strong>Save All (Ctrl+Shift+S)</strong></td><td>Save all open scripts.</td></tr><tr><td><strong>Run Script (F5)</strong></td><td>Run the current script.</td></tr><tr><td><strong>Stop Script (Shift+F5)</strong></td><td>Stop the running script.</td></tr><tr><td><strong>Record Commands</strong></td><td>Start or stop capturing UI actions as Python code. The recorder logs supported actions performed in the HYPERSIM and ScopeView interfaces, then transcribes them into Python commands in the code editor.</td></tr></tbody></table>

## Editor

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-5bbfaf28ddb4d65b0f6108ef8d3650efe55b7ea0%2Fsequencer-editor.png?alt=media" alt="" width="563"><figcaption></figcaption></figure>

Each tab displays a single script. A script can be closed from the tab header by clicking on the cross. If a file contains unsaved modifications, a asterisk *'\*'* is displayed on the tab header next to the file name.

### Add commands

You can add commands and comments directly in this section.

The editor highlights Python errors and warnings to help you fix issues quickly. It also supports additional keyboard shortcuts (Press F1 to open the command palette).

The editor appends the HYPERSIM API in the PYTHONPATH variable. Therefore, the editor is able to suggest imports and API functions with the "Code completion" feature, available via the `Ctrl + Space` shortcut.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-934697f831f77d23fefebf038e0168331d6a6d46%2Fsequencer-edition-code-completion.png?alt=media" alt=""><figcaption></figcaption></figure>

### Record commands

For example, the amplitude has been modified in the mask parameters.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-6f3a7f4b6a19eb3d1b7159b389230f9ecb9dcf81%2Fsequencer-record-change-parameters.png?alt=media" alt="" width="308"><figcaption></figcaption></figure>

Once the **Apply** button is clicked, the Sequencer records the action and adds it to the current sequence.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-d3ea766656f5d32d3eabf45681c31eecc186e0df%2Fsequencer-record-example.png?alt=media" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
The values given from the Python API use the default back-end unit. This explains how the **250 VrmsLL** modification will be applied via the API with **204 VrmsLN**.
{% endhint %}

### Available Keyboard Shortcuts

<table><thead><tr><th width="189.99993896484375">Command</th><th>Action</th></tr></thead><tbody><tr><td><strong>Ctrl + H</strong></td><td>Find and replace text in the script</td></tr><tr><td><strong>Ctrl + D</strong></td><td>Find the next occurrence of the selected text</td></tr><tr><td><strong>Ctrl + G</strong></td><td>Go to a specific line</td></tr><tr><td><strong>Ctrl + Shift + L</strong></td><td>Select all occurrences of the selected text</td></tr><tr><td><strong>Ctrl + Shift + K</strong></td><td>Delete current line</td></tr><tr><td><strong>Ctrl + F2</strong></td><td>Rename all occurrences of the current symbol</td></tr><tr><td><strong>Ctrl + Space</strong></td><td>Display automatic input suggestions and documentation for cursor control</td></tr></tbody></table>

## Console output

This section displays the output of the script executed by the Sequencer.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-5eceaa985f96746fdb8eb976e3fb537481b702fb%2Fsequencer-console-output.png?alt=media" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://www.opal-rt.com/docs/hypersim/automation-api-and-scripting/automate-with-python-script/use-the-sequencer-tool/user-interface.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
