> 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/simulation-control-monitoring-and-logging/use-snapshot-during-simulation.md).

# Use Snapshot during Simulation

## Overview

The **Snapshot** feature is available from the **HYPERSIM ribbon**, in the **Simulation** section, and can only be used while a simulation is running.

A **snapshot** captures the complete state of a simulation at a specific time step. It stores node voltages, branch currents, and the internal states and historical data of components that require them, such as transmission lines and UCMs. A snapshot can later be restored to resume the simulation from the saved state.

Snapshots are particularly useful for studying transient events that are difficult or time-consuming to reproduce, such as machine startup sequences. By eliminating the need to repeatedly simulate the same pre-event conditions, they streamline manual testing and are an essential tool for automated test workflows.

{% hint style="danger" %}
The data stored in a snapshot file can be reused in subsequent simulations, provided that the changes made to the model do not affect its topology.
{% endhint %}

## Use the snapshot feature

For this demonstration, use the HYPERSIM model **Transmission & Distribution/HVAC\_735k\_38Bus**, which requires a short settling period to reach steady-state conditions after simulation startup. The example is best executed in **real time**, as this makes the effect of applying snapshots easier to observe. In **non-real-time** simulations, execution is typically too fast to allow snapshots to be applied and their impact observed during data acquisition.

{% stepper %}
{% step %}

### Choose the snapshot options

Simulation data can be stored either in memory or in a file, depending on the selected configuration.

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

{% step %}

### Take the snapshot

To better illustrate the feature, edit the **Trip** breaker component (located at the bottom of the model) and remove its second timing entry so that only a single switching event remains.

Open ScopeView, load the template associated with this model, and **start the simulation**. Allow the system to stabilize, taking periodic acquisitions without triggering events to observe the transition toward steady state.

**ScopeView parameters :**

* 5.0 seconds acquisition
* 20k sampling rate
* Sync. checked
* Terminal voltage Y-axis range : 0.99 - 1.01 pu

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

Once the system is stable, select **Take Snapshot** to save the current simulation state. The ScopeView graph should look like this. (The other graphs aren't needed for the purpose of this example.)

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-70d88e31f334598e7ac1a905718473c66ed125ff%2Fsnapshot-example-1.png?alt=media" alt=""><figcaption><p>Terminal Voltage of Generators</p></figcaption></figure>

Enable the **Trigger** option in the ScopeView controls and perform an acquisition. The captured waveform should look similar to the example shown below.

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

{% step %}

### Load the snapshot

To observe the effect of the **Snapshot** feature, start an acquisition and then quickly click **Load Snapshot** on the **HYPERSIM** ribbon. The resulting acquisition should resemble the figure below.

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

As shown, the event is triggered at **0.2 s**, as defined in the **Trip** component, causing the system to become disturbed. At approximately **1.55 s**, the snapshot is loaded, forcing the simulation back to the state that was saved when the snapshot was taken. This abrupt change in the waveforms confirms that the simulation state has been successfully restored.
{% endstep %}
{% endstepper %}

## Limitations

* Snapshots do not store block parameters
* Snapshots require the exact same task mapping to be reapplied in an ulterior simulation, when using the "File" option


---

# 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/simulation-control-monitoring-and-logging/use-snapshot-during-simulation.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.
