> 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/overview/standard-workflow-in-hypersim.md).

# Standard Workflow in HYPERSIM

This section explains the complete workflow for creating, preparing, and executing a model in real time with HYPERSIM.

{% stepper %}
{% step %}

### Create or open an HYPERSIM model

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

To open an **existing model:**

1. In **File > Options**, click **Browse for File...**
2. A file browser opens at the default location: `C:\Users\<USERNAME>\Documents\HYPERSIM`. Select the desired `.ecf` file to open the HYPERSIM model.

To open an **example** **model:**

1. In **File > Options**, select an example and then click **Open Example**.
2. A file browser opens at the default location: `C:\Users\<USERNAME>\Documents\HYPERSIM`. Choose this folder or choose a custom director in which to save the example model. HYPERSIM will create a **copy** of the example in the selected directory. Once the file is saved, the main modeling interface appears and you can begin working with the model.

To create a **new model:**

1. In **File > Options**, click **New Default Document**.
2. A file browser opens at the default location: `C:\Users\<USERNAME>\Documents\HYPERSIM`. Save the new model in this folder or choose a custom directory. Once the file is saved, the main modeling interface appears and you can begin building your schematic.

{% hint style="danger" %}
**Avoid cloud‑synced folders** (e.g., OneDrive, Dropbox) to prevent corruption, version conflicts, and access problems.

**Avoid folder paths with spaces or special characters**, which may cause compatibility issues.

**Prefer short directory paths** to prevent “path too long” errors that disrupt tool workflows.
{% endhint %}
{% endstep %}

{% step %}

### Add, modify, or delete blocks

1. Drag and drop components from the **Parts Library** (area 3 on the below image) into the **Schematic** (area 2 on the image).

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

{% hint style="info" %}
The **Schematic** is the main workspace where your model is designed and blocks are placed, while the **Parts Library** lists all available blocks that can be dragged into the schematic. The **Toolbar ribbon** (area 1 on the image) provides access to simulation controls, tools, and configuration options and the **Log consoles** (area 4 on the image) display simulation logs, compile information, and messages.
{% endhint %}

{% hint style="danger" %}
The [**POW (Point‑On‑Wave)**](https://www.opal-rt.com/docs/hypersim/library-blocks-reference/network-tools/point-on-wave-synchronization.md) block is **mandatory** in any HYPERSIM model that includes **electrical network components**, as it provides the **single synchronization reference** for data acquisition and timed events. Only **one** POW block may be used per model.

For reliable triggering, connect the POW to a **stable bus** - one where no faults occur - since it detects synchronization from a **voltage threshold crossing**. Faulted buses can distort the waveform and cause inaccurate or unstable synchronization.
{% endhint %}

2. Connect components by clicking from one connector to the next to draw a wire. Once connected, click the wire to verify the connection: the wire is highlighted in yellow, and all associated connectors on the blocks are highlighted in blue.

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

3. Right‑click a wire to access its menu. You can for example change the signal to a 3-Phase signal by selecting **Line Type**, then **3‑Phase Signal**, or delete the signal by selecting **Delete**.

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

To remove a single branch, use the **Zap** tool in the **Home** tab of the **Toolbar ribbon**.

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

{% step %}

### Add sensors

HYPERSIM sensors are used to acquire signals in ScopeView and to connect the simulation to **I/O interfaces** through their data points.

* To view or edit a component’s sensors, right‑click the component and select **Open Sensors Form**.
* The **Sensors Form** lists all signals available for monitoring or for I/O connection.

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

* Use the **Selected** checkbox to activate or deactivate each sensor.
  {% endstep %}

{% step %}

### Assign the simulator to the model

1. In the **HYPERSIM** tab, click **Settings**.

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

2. In the **Simulation Settings** window, select your simulator under **Target**, and **Real‑time** under **Simulation Mode**. Click **OK**.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-d8d72afae2798a94dc6539d71b526684acac7b19%2Fsimulation-mode.png?alt=media" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Configure I/Os

The model can interact directly with external hardware or a DUT through the simulator’s I/O modules or communication protocol drivers.

Configure the **I/O interface** first. Its connectable points are then exposed in the **I/O Selector**, where they can be connected to component sensors.

See [**Configure I/Os**](https://github.com/Opal-RT-Technologies/product-docs-hypersim/tree/release-2026.4/configure-ios/README.md) for configuration details.
{% endstep %}

{% step %}

### Start the simulation

In the **HYPERSIM** tab, click **Start**. HYPERSIM® will automatically assign tasks to the appropriate CPU cores, compile the model, and launch the simulation. This process may take anywhere from a few seconds to a few minutes, depending on the model size.

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

Once the simulation is running, the **Start** button becomes grayed out, and the **Stop** button becomes active, allowing you to halt execution if required. For now, **do not** stop the simulation.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-3883d83a22eae109ba76b851a5e5ca51b7a793c2%2Fstop-pause-simulation.png?alt=media" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### Monitor results with ScopeView

1. In the **HYPERSIM** tab, click **ScopeView** to launch ScopeView.

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

2. In the ScopeView window, all selected sensors from your model automatically appear in the **Available Signals** panel.
3. Click the signals you want to acquire and configure the acquisition parameters as needed.
4. Click **Start** to begin data acquisition.

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

You can now monitor live simulation results through the selected signals.
{% endstep %}

{% step %}

### Stop the simulation

To stop the simulation, go to the **HYPERSIM** tab and click **Stop**. This halts the execution and resets the model.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-0764304396424893cf8a23f5e4ccddc238f86e39%2Fstop-simulation.png?alt=media" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}


---

# 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/overview/standard-workflow-in-hypersim.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.
