> 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/log-simulation-data-with-datalogger/log-simulation-data.md).

# Log Simulation Data

{% stepper %}
{% step %}

## Configure the Recorder parameters <a href="#step3choosesignalstolog" id="step3choosesignalstolog"></a>

In the **HYPERSIM** ribbon, click **Control Center** in the Data Logger section to open the Data logger window.

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

<table data-search="false"><thead><tr><th width="230.111083984375">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Recording mode</strong></td><td>The default data logger state when the simulation starts.<br><strong>Automatic:</strong> Acquisition starts when simulation starts.<br><strong>Manual:</strong> Acquisition starts when the user starts the signal group in the Signal Groups view.<br><strong>Show data logger console:</strong> Unchecked by default. Allows our support team to collect more information in case debugging is required.</td></tr><tr><td><strong>No data loss</strong></td><td>Enables the data logger to be master to the simulation if an offline simulation mode of execution is selected. It can’t be used in real-time mode. The simulation will run as fast as the data logger can save data.</td></tr><tr><td><strong>Configuration Mode</strong></td><td><strong>Basic:</strong> Default mode<br><strong>Advanced:</strong> Enables activating the data logger console</td></tr></tbody></table>
{% endstep %}

{% step %}

## Create, remove, reorder or rename signal groups

By default, the data logger is configured with one signal group. A signal group defines a set of signals to be acquired when a specified trigger condition occurs. Multiple signal groups can be configured, each with a unique trigger condition, enabling different acquisition strategies that may share or use distinct triggering signals. Each signal group's acquired data is stored in its own dedicated data file.

**To create** more signal groups, click the initial **Signal Groups** folder in the left panel. This panel provides a summary of each signal group configuration.

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

**To add** a signal group, click any of the **Add 1 item** buttons (1), depending on if you want to add it **Above** or **Below** the selected **Signal Group**. The arrow next to each button provides more options (duplicate signal groups and/or add multiple groups at once).

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

You can remove one or several groups (2), or reorder them by using the arrow buttons (3).
{% endstep %}

{% step %}

## Configure the signal groups parameters

Each signal group can be configured from the **Signal Group** table or from its own configuration window. Click a signal group in the left panel to access its settings.

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

<table data-search="false"><thead><tr><th width="229.66668701171875">Parameter</th><th width="419.22216796875">Description</th></tr></thead><tbody><tr><td><strong>Name</strong></td><td>Name of the signal group.</td></tr><tr><td><strong>Recording mode</strong><br><br><br></td><td>Default state when simulation is starting for the signal group.<br><strong>Inherit:</strong> The same state as the one described in the general Data Logger view.<br><strong>Automatic/Manual:</strong> The state which will override the one described in the general Data Logger view.</td></tr><tr><td><strong>Export format</strong></td><td>File extension created by the data logger: OPREC or CSV</td></tr><tr><td><strong>Output file auto naming</strong></td><td>Defines the output data file name automatically and prevents file name collisions. The name format is <strong>SignalGroupName_ecfName_TimeStamp</strong>. Example: <strong>SIGNAL_GROUP_1_HVAC_500kV_6Bus_20190423_105021</strong>.</td></tr><tr><td><br><br><strong>Output filename</strong></td><td><strong>If the auto-naming is deactivated</strong><br>Name of the file that contains the signals' data. Make sure all signal groups have unique file names. Otherwise, files overwrite one another. If a complete or relative path and file name are provided, all intermediate folders are created when required.</td></tr><tr><td><strong>Decimation factor</strong></td><td>Number of steps recorded = total number of steps divided by the decimation ratio. When set to 1, the samples from each calculation step are stored. When set to 2, the samples from each 2 calculations are stored, etc.</td></tr><tr><td><strong>Frame length</strong></td><td>Duration for which samples are stored once a trigger occurs.</td></tr><tr><td><strong>Frame length unit</strong></td><td>May be either a number of steps, a duration in various time units ranging from nanoseconds to hours, or a file size in megabytes</td></tr><tr><td><strong>Number of frames to record</strong></td><td>Specifies how many frames to record. Note that there is no data loss within a frame but it may happen between frames.</td></tr><tr><td><strong>Trigger level</strong></td><td>Level value that will activate the trigger.</td></tr><tr><td><strong>Trigger function</strong></td><td>The trigger is active on an edge or level event.</td></tr><tr><td><strong>Trigger polarity</strong></td><td><p><strong>Negative</strong> or <strong>positive</strong>.</p><p>When triggering an on-edge event, it specifies whether the trigger is to occur on a rising (<strong>positive</strong>) or falling (<strong>negative</strong>) edge around the specified trigger value.</p></td></tr><tr><td><strong>Pre-trigger percentage</strong></td><td>Percentage of the record length to be logged before the occurrence of the trigger condition. <strong>Example</strong>: For 25%, write 25.0.</td></tr><tr><td><strong>Trigger holdoff</strong></td><td>After the occurrence of a trigger condition, specifies the duration for which all subsequent trigger events will be ignored. Uses the unit specified in <strong>Frame length units.</strong></td></tr></tbody></table>
{% endstep %}

{% step %}

## Select signals to log <a href="#step3choosesignalstolog" id="step3choosesignalstolog"></a>

In the **HYPERSIM** ribbon, click **Sensor Summary** in the Sensors & I/Os section to select signals to be recorded.

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

{% step %}

## Start recording <a href="#step6startrecording" id="step6startrecording"></a>

In **Automatic mode**, recording starts automatically based on the trigger configuration.

In **Manual mode**, while the simulation is running, select a signal group and click **Start recording (1)** or **Stop recording (2)**.

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

Click on **Open Data Folder (3)** to open File Explorer and access the saved data files.
{% 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/simulation-control-monitoring-and-logging/log-simulation-data-with-datalogger/log-simulation-data.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.
