HYPERSIM: Surge Arrester Block and Custom Library Creation

Hi Team,

I have a couple of questions regarding HYPERSIM:

1.I am looking for a Surge Arrester / Lightning Arrester block in HYPERSIM. Do we have a ready-to-use block available in the HYPERSIM library? I came across a Surge Arrester block in the Schematic Editor documentation, but I would like to know whether there is a standard library component that can be directly used in HYPERSIM models.
Ref: https://opal-rt.atlassian.net/wiki/spaces/PSED/pages/67864740/Surge+Arrester

2.


Is it possible to create custom library blocks and add them to the HYPERSIM library for reuse across multiple projects? Similar to MATLAB/Simulink, I am interested in creating reusable components or subsystems and making them available as part of a custom library.

Any guidance or relevant documentation would be greatly helpful.

I tried adding a new library item, but it does not appear in the library after restarting the application.

Is there any additional configuration required to register or link custom libraries in HYPERSIM? If so, could you please share the recommended procedure for making custom library items visible by default and available within the application on restarting?

  1. Ready-to-Use Surge Arrester / Lightning Arrester Block in HYPERSIM
    Yes, HYPERSIM has standard, ready-to-use Surge Arrester (Metal-Oxide Varistor / MOV) components built directly into its library.

Component Overview:

The block implements a metal-oxide surge arrester used to protect electrical equipment against overvoltages by modeling non-linear V\text{--}I characteristics.

It supports single-phase (1ph_arrester) and three-phase (3ph_arrester) configurations.

Parameters include rated voltage, number of phases, reference currents, and customizable V\text{--}I lookup tables or segment parameters (k and \alpha).

Library Location:

You can find it in the HYPERSIM Schematic Editor under the Passives (or Power System / Passives) library group, as well as under the Universal Database (UDB_arresters.clf).

Documentation Reference:

The Confluence page you referenced (
Surge Arrester
) is indeed the official documentation for HYPERSIM’s native Surge Arrester block. You can directly drag and drop it from the library sidebar into your HYPERSIM model.

  1. Creating & Reusing Custom Library Blocks in HYPERSIM
    Yes, you can create custom library blocks (subcircuits/subsystems) in HYPERSIM and save them into custom library files (.clf) for reuse across multiple projects.

Step-by-Step Workflow:
Create the Subcircuit / Subsystem:

Assemble the components and logic in your schematic.

Add Port Connectors (Control Input/Output ports or Power/Network pins) for external connections.

Highlight the components, right-click, and select Create Subcircuit Block… (or use the Subcircuit Wizard in the options toolbar).

Define Custom Parameters & Mask (Generic View / Form Editor):

Right-click the subcircuit and select Open Parameter Form…

Declare the variables/parameters you want users to configure at the top level.

Inside the subcircuit, link internal block parameters to these mask variables (e.g., setting a parameter to =var_name).

Custom forms and masks can be tailored using the built-in Form Editor or CustomView (supporting sliders, drop-down menus, tooltips, and parameter constraints).

Save into a Custom Library (.clf file):

In the Subcircuit Wizard or block options, check Save subcircuit in a library or click Options > Make unique type.

Specify the library name and save the block into a Component Library File (.clf).

You can open this .clf file in any HYPERSIM project or configure HYPERSIM to open your custom library automatically at startup for team-wide sharing.

Advanced Reusable Blocks (UCMs / C-Code / DLLs):

For proprietary algorithms or C-code/DLL black boxes, HYPERSIM also supports User-Coded Models (UCM) encapsulated inside a masked Subcircuit and saved in a .clf library.