> 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/device-symbols-and-libraries/use-symbol-editor.md).

# Use Symbol Editor

## Overview

Symbols are created and edited using the **Device Symbol Editor**, which can be opened from the **Options** ribbon using **New Part**, or from a device's context menu by selecting **Edit Symbol**.

In addition to creating device symbols, the Symbol Editor can be used to create and modify general graphical elements, such as title blocks and simple mechanical drawings for use in HYPERSIM schematics. It provides a comprehensive object-oriented drawing environment that combines standard drawing tools with specialized features for symbol development.

{% columns %}
{% column %}

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

{% column valign="middle" %}

<p align="center">transformed as</p>
{% endcolumn %}

{% column %}

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

One of the most common uses of the Symbol Editor is the customization of **subcircuit symbols**. When a subcircuit is created, HYPERSIM automatically generates a default rectangular symbol. This symbol can be customized at any time by right-clicking the subcircuit symbol and selecting **Edit Symbol**, which opens it in the Symbol Editor.

## **Create a new HYPERSIM Part** <a href="#creating-a-new-hypersim-part" id="creating-a-new-hypersim-part"></a>

To create a new part, click **New Part** on the **Options** ribbon. The Symbol Editor opens in its own window within HYPERSIM and includes a dedicated ribbon. The ribbon title displays the name of the part currently being edited.

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

To create or modify a symbol, use the tools in the **Draw Graphics** and **Graphics Properties** sections. These tools enable you to draw the graphical elements that make up the symbol and define their properties, such as color, line style, line width, and fill settings.

Common design commands are also available from the element **right-click context menu**.

### Adjust the grid

To open the **Grid** dialog box, right-click anywhere in the drawing area and select **Grids** or click on **Grid** on the Operations section. This dialog allows you to configure both the **visible grid spacing** and the **snap grid settings** used by the drawing tools. Adjusting these settings can help improve drawing accuracy and make it easier to align and position objects within the design.

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-159891186546f377965ca5700c21dae3cef1a8d4%2Fpart-editor-grid-window.png?alt=media" alt="" width="280"><figcaption></figcaption></figure>

<table><thead><tr><th width="200.3333740234375">Parameter</th><th>Description</th></tr></thead><tbody><tr><td><strong>Visible (grid)</strong></td><td>Determines whether visible grid lines are shown in the drawing workspace of the symbol editor window. The spacing between these grid lines is determined by the value in the "Grid" field.</td></tr><tr><td><strong>Grid (Spacing)</strong></td><td>Determines the spacing between the visible grid lines. The units are in screen dots at the default zoom level.</td></tr><tr><td><strong>Snap on</strong></td><td>Determines whether the corners of objects made with the drawing tools are moved to the nearest snap-to-grid point.</td></tr><tr><td><strong>Snap (Spacing)</strong></td><td>Determines the spacing between snap-to points for the drawing tools (not including pins). This does not affect objects that have already been placed. The units are in screen dots at the default zoom level.</td></tr><tr><td><strong>Pin Grid</strong></td><td>Determines the snap-to-grid for device pins.</td></tr></tbody></table>

### Add pin

* Pins are listed in the order in which their pin symbols were placed on the drawing. To verify the association between a pin name and its graphical representation, select a pin in the list and observe which pin is highlighted in the symbol.
* To change the pin order, click and drag a pin to the desired position in the list. For many built-in HYPERSIM devices, the order of pins in the generated netlist is significant. Unless modified through attributes or special scripts, this netlist order is determined by the order in which the pins are placed on the symbol.
* When creating custom devices, ensure that the pin order matches the expected netlist or model connection order to avoid connectivity and simulation errors.

## **Edit existing Parts** <a href="#editing-existing-parts-devices" id="editing-existing-parts-devices"></a>

### **Edit an existing part in a library** <a href="#editing-an-existing-part-in-a-library" id="editing-an-existing-part-in-a-library"></a>

{% columns %}
{% column width="41.66666666666667%" %}

<figure><img src="https://3623212549-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLxgTpoh7kyPmQ5vuyqD7%2Fuploads%2Fgit-blob-a24da03e4eb74e38701cefc254f32e28adfd1557%2Fedit-part-from-library.png?alt=media" alt="" width="246"><figcaption></figcaption></figure>
{% endcolumn %}

{% column width="58.33333333333333%" %}
Right-click on the desired item in the **Parts** in the Parts panel, then select **Edit Part** from the context menu.

A copy of the symbol definition is loaded into a device symbol editor window. No changes to the source library will be made until you save the symbol back to its original library.

Editing a symbol in a library does not automatically update designs that have used that symbol. You must use the Update from Lib command to perform updating actions on already placed devices. You can decide to save an edited part under a new name using the **File > Save As** command.
{% endcolumn %}
{% endcolumns %}

{% hint style="danger" %}
**Do not change pin** settings, delete pins, or modify pin ordering for devices from the built-in HYPERSIM libraries unless the device documentation explicitly permits such modifications. Doing so may result in incorrect device behavior or netlist generation.
{% endhint %}

### **Editing an existing part in the design** <a href="#editing-an-existing-part-in-the-design" id="editing-an-existing-part-in-the-design"></a>

To modify the symbol of a device already placed in a schematic without affecting its original library definition, right-click the device and select **Edit Symbol**. This command creates a copy of the symbol in a temporary library and opens it in the Symbol Editor. You can then make the required changes and close the editor when finished.

When you exit the editor, you will be prompted to confirm whether the modified symbol should replace the original symbol in the schematic. If other instances of the same device type are present, you may also be given the option to update those symbols as well.

This process is similar to using the **Update from Lib** command to update an existing device instance from an updated library and has many of the same options.

You can decide to save an edited part under a new name using the **File > Save As** command.

To ensure that symbol modifications are properly applied to the schematic, always save your changes and close the **Symbol Editor** when you are finished editing. If further modifications are required, reopen the Symbol Editor from the device and continue editing in a new session.

{% hint style="info" %}
If you switch from the **Symbol Editor** back to the design window without first saving the symbol (**File > Save** or **Ctrl+S**) and closing the Symbol Editor, the link between the edited device and the Symbol Editor session will be lost. Any subsequent changes made in the Symbol Editor will not be applied to the device in the schematic. Even if you later save the symbol and return to the already-open Symbol Editor window, the connection to the device drawing will not be reestablished.
{% endhint %}

## Protect your part with password

The **Symbol Editor** allows password protection to be applied to standard devices and subcircuit devices. To enable password protection, open the device in the Symbol Editor and select in the section **Operations,** the menu **Subcircuit > Subcircuit Password Protection**.

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

**Two password protection** options are available:

* **Access Password**: Restricts access to the device and its contents.
* **Modification Password**: Restricts editing of the device and its symbol.

When password protection is enabled, users must enter the appropriate password to access or modify the device. Once entered on a given computer, the device remains unlocked for subsequent HYPERSIM sessions.

To remove password protection, open the **Subcircuit Password Protection** dialog box and delete the password from the corresponding field.


---

# 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/device-symbols-and-libraries/use-symbol-editor.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.
