> 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/pe-add-on-opal-rt/get-started/create-your-first-project.md).

# Create Your First Project

{% stepper %}
{% step %}

## Create the project in VeriStand

Create a VeriStand Project by clicking **Default Project** and provide it with a representative name

<figure><img src="https://1300141755-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCyfrFRdgX5VC5iwM13Zm%2Fuploads%2FFkWLd12QIt2d3TMvUqg3%2Ffirst_project.png?alt=media&amp;token=acb9a9cf-288d-444b-b767-647288d9c206" alt="" width="512"><figcaption></figcaption></figure>
{% endstep %}

{% step %}
Add the Power Electronics Add-On to the System Definition \\

1. In the VeriStand Editor, click **Configure** to launch the System Explorer.
2. Expand the System Definition tree until the **Custom Devices** section is reached

<figure><img src="https://1300141755-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCyfrFRdgX5VC5iwM13Zm%2Fuploads%2FPr1va80SpfFLGXgE3OAF%2Ffirst_project_add_PE.png?alt=media&amp;token=63915cc8-d400-4b77-b3e4-89c748ac01d5" alt=""><figcaption></figcaption></figure>

3. Right-click the **Custom Devices** section and navigate to **OPAL-RT>>Power Electronics Add-On (OPAL-RT Circuit)**. Wait for the Main Page to load.
4. **Save** the System Definition.

The **Power Electronics Add-On (OPAL-RT Circuit)** block has now been integrated into the project

<figure><img src="https://1300141755-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCyfrFRdgX5VC5iwM13Zm%2Fuploads%2FW9EMrrV7egx34e5lLPnR%2Fimage.png?alt=media&amp;token=5d018be6-d560-493d-80d9-e114aa5f6f65" alt="" width="380"><figcaption></figcaption></figure>
{% endstep %}

{% step %}

## Create the circuit

1. In the **System Definition** Expand the **Power Electronics Add-On (OPAL-RT Circuit)** custom device and select the **Circuit** section to display the configuration page.
2. Fill the name field and click the **Create New Circuit** butto&#x6E;**.** Select a location and name for the new circuit model.

<figure><img src="https://1300141755-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCyfrFRdgX5VC5iwM13Zm%2Fuploads%2Ft8teABAmJltzHpplJmzm%2Fcreate.png?alt=media&amp;token=66066f60-2814-483a-9bda-38e5cdebcae8" alt=""><figcaption></figcaption></figure>

3. Wait for the **OPAL-RT Schematic Editor** to open a blank model.
   {% endstep %}

{% step %}

## Add simulator configuration

To add connections between the model and the analog and digital I/Os of the simulator, a **Simulator Setup** must be configured. This setup defines the type of I/O interface a Simulator provides, as well as the available hardware resources.

1. Open the Simulator Setup modal, either by clicking on the bottom-left button found in the work area or navigating to **Simulate > Simulator Setup**.

<figure><img src="https://1300141755-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCyfrFRdgX5VC5iwM13Zm%2Fuploads%2FoxKDd8j5UWuHgIjO7d68%2Fimage.png?alt=media&amp;token=38b6e49e-6f8d-405f-9685-4478c836e960" alt=""><figcaption></figcaption></figure>

2. By clicking the **+** card below this setup, a new setup is created. You are prompted to select **hardware** for the setup, the [**eHs Licence Class**](https://www.opal-rt.com/docs/pe-add-on-opal-rt/overview/simulator-requirements/license-requirements.md), and the [**firmware**](https://www.opal-rt.com/docs/pe-add-on-opal-rt/hardware-configurations-reference/default-hardware-configuration-fpga-firmwares.md).

<figure><img src="https://1300141755-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCyfrFRdgX5VC5iwM13Zm%2Fuploads%2FxzEcp0221WEWQXWglHnQ%2Fimage.png?alt=media&amp;token=927ec1d1-5d02-4f1d-96bb-2bd6072ca00c" alt="" width="307"><figcaption></figcaption></figure>

<figure><img src="https://1300141755-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCyfrFRdgX5VC5iwM13Zm%2Fuploads%2FX0pyNBnnGfN34tBGsh3i%2Fimage.png?alt=media&amp;token=2ecaaf2f-7d49-44a6-9080-73a8f8a23ad2" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

## Design the circuit

In this tutorial, we will guide you through building and saving a power electronic circuit for a **buck converter** as an example.

<figure><img src="https://1300141755-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCyfrFRdgX5VC5iwM13Zm%2Fuploads%2FWgngou2hYJSADp7VFWlK%2Fimage.png?alt=media&amp;token=cecb6c65-cb5f-4cfb-b1d8-942db1e11346" alt=""><figcaption><p>The buck converter circuit</p></figcaption></figure>

Set the inductor value as 1.0e-3 Henry, the capacitor value as 2.0e-6 Farad and the resistor as 12 ohm&#x73;**.**

<figure><img src="https://1300141755-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCyfrFRdgX5VC5iwM13Zm%2Fuploads%2FUlNsrZl3hDsvahSOZmiw%2Fbuckconverter.gif?alt=media&amp;token=89428d59-5de9-4826-bdcd-e1fbf2426c5d" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

## Add the circuit model to the System Definition

1. Expand the **Power Electronics Add-On (OPAL-RT Circuit)** custom device and select a **Circuit** section to display the configuration page.
2. Click the **Circuit File Path** file browser button and navigate to the circuit model file you ant to use. Wait for the parsing process to complete. (This may take several seconds).

<figure><img src="https://1300141755-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCyfrFRdgX5VC5iwM13Zm%2Fuploads%2F4aVem3jNzJdgEogXaGto%2Fadd_circuit_SD.png?alt=media&amp;token=dda967fd-e5dc-41be-bf98-0fab7bfa3d0c" alt=""><figcaption></figcaption></figure>

Notice that the **Sources**, **Gates**, and **Measurements** sections have now been updated with the components defined in the circuit.
{% 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/pe-add-on-opal-rt/get-started/create-your-first-project.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.
