> 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/model-and-simulation/edit-a-model-schematic/import-and-export-a-project/project-folder-structure-and-contents.md).

# Project Folder Structure and Contents

## HYPERSIM project structure <a href="#hypersim-project-structure" id="hypersim-project-structure"></a>

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

<table data-search="false"><thead><tr><th width="240.111083984375">File Extension/Folder Name</th><th>Description</th></tr></thead><tbody><tr><td><strong>.ecf</strong></td><td>The .ecf file is the model design in a binary format.</td></tr><tr><td><strong>.ecf.lock</strong></td><td>The .ecf.lock appears when the model design in already opened.</td></tr><tr><td><strong>.svt</strong></td><td>The .svt file extension stands for ScopeView Template: similar to the .xml format.</td></tr><tr><td><strong>.csv or .sig and .iop</strong></td><td><p>Both .csv and .sig files gather all selected sensors of your design.</p><p>The .sig format is a binary format that contains sensor information. It is complemented by a .iop file that contains the Data Logger and the I/O Interface configurations. Use the HYPERSIM ribbon to save the sig file. The matching .iop file will also be generated.</p><p>Since HYPERSIM 2021.1, the sensors can be exported to CSV format. The sensor configuration is then editable through CSV editors, such as Microsoft Excel®.</p></td></tr><tr><td><strong>firmware</strong></td><td><p>This folder contains all bitstream and IO configuration files:</p><ul><li>The .bin file is the bitstream itself in a binary format.</li><li>The .opal contains the IO configuration available with the bitstream .bin mentioned previously.</li></ul></td></tr><tr><td><strong>projectmane_hyp</strong></td><td>HYPERSIM Project Content</td></tr></tbody></table>

## projectmane\_hyp folder

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

<table><thead><tr><th width="240.11114501953125">File Name</th><th>Description</th></tr></thead><tbody><tr><td><strong>compatibilityVersion.txt</strong></td><td><p>This file is used for model-forward compatibility for HYPERSIM versions.</p><p><strong>Note</strong>: make sure to include this file when exporting or sharing the project.</p></td></tr><tr><td><strong>netlist.txt</strong></td><td>This text file contains the netlist definition and is updated after design analysis.</td></tr><tr><td><strong>SimulationSettings.xml</strong></td><td>This file contains all simulation settings used in the project.</td></tr></tbody></table>

## configurationsIO folder <a href="#configurationsio-folder" id="configurationsio-folder"></a>

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

This folder contains all files related to IO configurations.

<table data-search="false"><thead><tr><th width="240">File or Folder Name</th><th>Description</th></tr></thead><tbody><tr><td><strong>aliases</strong></td><td>Internal use only.</td></tr><tr><td><strong>OpalBoardsAddons</strong></td><td></td></tr><tr><td><strong>Parameters</strong></td><td>Internal use only.</td></tr><tr><td><strong>SyncExchangerRegistry</strong></td><td><ul><li><p>DriverConfigs: detailed description of every driver:</p><ul><li>Archives: a folder containing configurations of deleted drivers.</li><li>file_1.opal; file_2.opal: driver configuration files used in the synchExchangerRegistry.opal file described below.</li></ul></li><li>SyncExchangerRegistry.opal: list of used IO Interfaces; has a reference to the .opal in DriverConfigs as such: the GUID saved in the exchangerId field of each DriverDefinition item represents the name of the file in the DriverConfigs folder where the configuration of the respective driver is saved:</li></ul></td></tr><tr><td><strong>dataPoints.xml</strong></td><td>Mapping from IO interface to HYPERSIM datapoint</td></tr><tr><td><strong>default.opal</strong></td><td>Global information of the project, and has reference to the SyncExchangerRegistry\SyncExchangerRegistry.opal used</td></tr></tbody></table>

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

## libs folder <a href="#libs-folder" id="libs-folder"></a>

This folder contains all UCM components developed specifically for the project.

## mapping folder <a href="#mapping-folder" id="mapping-folder"></a>

This folder is created at the Map Tasks step. it is empty unless the user sets processor IDs for one or several tasks in the Tasks Manager.

* preallocatedTasks.xml: This file contains all information related to task manager configuration. It is created when the user applies a task configuration in the Tasks Manager.

## view folder <a href="#view-folder" id="view-folder"></a>

This folder contains all custom views used by UCM or subcircuits developed in the project.


---

# 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/model-and-simulation/edit-a-model-schematic/import-and-export-a-project/project-folder-structure-and-contents.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.
