Documentation Home Page HYPERSIM Home Page
Pour la documentation en FRANÇAIS, utilisez l'outil de traduction de votre navigateur Chrome, Edge ou Safari. Voir un exemple.

Target Manager

All targets are configured through the Target Manager configuration pane. Users can manage the target's HYPERSIM version, license, advanced compilation/simulation parameters and various other parameters.

The Target Manager is accessed through the HYPERSIM ribbon.

Basics

There are two nodes available by default through the Target Manager interface:

  • Targets

  • Default Code Generation

Parameter

Description

Parameter

Description

Name / IP

The IP address of the target

Description

The description of the target is written by the user when adding a new target in HYPERSIM Target Manager.

Active

image-20240524-152444.png

HyCore and HyServer are running, the target can be used.

It detects the user and the mode. The following information can be seen in the tooltip:

  • user=UserName;

  • mode=APPLICATION or SERVICE

HyCore is running but HyServer is not reachable.

HyCore is not running. The target is unreachable.

Running Version

Architecture

The target Operating System.

Build

The current HYPERSIM version used by the target.

Protocol

see https://opal-rt.atlassian.net/wiki/spaces/PDOCHS/pages/20190803/Target+Manager#Protocol-versions-and-backward-compatibility

License (days)

It indicates how many days remain in the target license before it expires.

Target Manager Interface

Each target listed has a hierarchical tree view menu that reveals all the items listed below:

Localhost

  • Advanced features Compilation and Task Mapping settings

 

Targets

  • Versions show both a current and historical log of versions installed on this machine

  • Simulation shows both a current and historical log of versions installed on this machine

  • Advanced features Compilation and Task Mapping settings

  • Network shows network configuration settings that are used by ScopeView for local simulations

  • Diagnostic provides a detailed report of the target's current state and is often requested by the support team to help diagnose issues

  • License shows a current and historical log of licensing for this machine

  • Default Code Generation holds settings related to code generation storage paths



Diagnostic

Sometimes issues can occur when installing HYPERSIM on a target or starting a simulation that cannot easily be identified by the user. When contacting our Support team about this type of problem, they may need the report generated by the diagnostic.

After the diagnostic has been run, its output can be saved to a text file to be sent for support.

The report ends with a passed/failed summary providing cues for troubleshooting as in the figure above. Scrolling back to the corresponding section will provide more information on the cause of the error and suggestions for solutions.

 


The diagnostic should not be executed on a target where a simulation is running as it may impact the simulation state, performance or results.


Versions

This page handles the HYPERSIM versions on the target.

All interactions with the target are logged in the Log tab.

Local running version

Host HYPERSIM version.

Last refresh

Date of the last time the status of the target and its information was refreshed.

Note: a warning appears if the target is not running the same version as the host as required.

Install version

Installs the current HYPERSIM host version onto the target, selects it, and restarts the target's services.

If this version is already installed on the target, the current installation is removed and reinstalled.

Restart services

Restart HYPERSIM services on the target (hycore and hyserver).

Refresh list of installed versions

Reloads all target HYPERSIM versions and updates the table.

Status

Provides detailed information on the target for debugging purposes.



For each table entry, a right-click contextual menu gives the following options:

Uninstall this version from the target

Removes all files for this version on the target.

Use this version as server on target

Select that version on the target.

Protocol versions and backward compatibility

A protocol version has been introduced in HyCore in 2021.2, to better define the interactions between the host and the target. This version is updated when the target API is changed or when the technologies used for communications change. This feature aims at simplifying the target management when multiple users wish to use the same target in different versions.

HYPERSIM version

Protocol

Samba

RMI

gRPC

SystemD

Major change

HYPERSIM version

Protocol

Samba

RMI

gRPC

SystemD

Major change

2021.2

1.0.0

Initial introduction

2021.3

1.0.0



2022.1

2.0.6

HyServer: Start simulation with decimation parameters.

Samba is not used anymore for file transfers to target

2022.2

3.0.0

Replaced all usage of the target from RMI to gRPC, except target manager

2023.1

4.0.0

RMI removal

2023.2

5.0.0

Internal changes during simulation setup on target

2023.3

5.1.0

An additional method for switching target version on certain target configurations

2024.1

6.0.0

HyCore and HyServer services are now launched by systemd on OPAL-RTLinux

This table explains that a 2022.2 or older HYPERSIM PC version will not be able to communicate with targets where HyCore 2023.1 or higher is running, as RMI technology has been removed, for stability and security reasons. The 2022.1 and 2022.2 versions support both protocols, meaning they can be used to transition from these versions.

To upgrade from 2021.X to 2023, please install 2022.X on host and target, and then install 2023 or higher. Repeat the same step in order to upgrade to 2024 or higher.

To rollback a target in a given version X to an older version, please use the same version X on the PC target manager. Use the 2022 PC to rollback further if needed.

To restart services or export a license to target in 2024.1, please use the same version on host.

Advanced

The values set here are default values imported when creating a new model but can be overridden in the Simulation Settings for the current model.

The possible default setting values depend on the target's operating system.



Compilation Default Values

Standard compilation options for C/Python code.

Task Mapping Default Values: These values are used by the task mapping algorithm.

Communication overhead

Portion of simulation time step granted to communication between processors.

I/O overhead

Portion of simulation time step granted to communication with I/O interfaces. 

Processor performance

Value used by the task mapping algorithm to estimate the tasks based on the hardware specifications.

The higher the number, the lower the estimate for each task.

License



This pane manages the target's licenses. For details of the installation process, see: Installing HYPERSIM on a Target from Windows.

All interactions with the target are logged in the Log tab.

Machine ID area

Required when requesting a new license.

Get target information and license file (1)

Contacts target and auto-completes area 5.

Save as ... (2)

Exports machine ID to a .txt file.

Request a new license

Opens the form to send a license request to our support team. Requires an internet connection.

License properties

Lists all features of the license file.

Select license file

Browses for a new license file.

Install selected license

Compares the selected license to the already installed license if any and allow for installation.


Network



This pane configures the communication interface between Scopeview and the target.

If Scopeview is configured to print data continuously (with Cont checked, as in the image below), it may need to be configured to communicate with the host if many network interfaces are available.

Identifying the IP where data packets are to be transferred is done through this pane.

Automatic

Uses the default network interface to determine the IP address.

Info

In this mode, Datalogger Live Acquisition and FPGAScope won't work.



Fixed

Selects the input IP address.

Search in range

Selects the first IP address which can communicate with ScopeView. Once communication is lost, IP is recalculated using that range.

Network interface

Use the selected network interface to automatically determine the IP.



Info

Target services will be restarted after applying changes.

Default Code Generation

The unique code directory is enabled by default. The local target code directory (for localhost) is automatically set to the path below:

  • Local code directory:

    %{USER_HOME}\HYPERSIM\code







OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | opal-rt.com | +1 514-935-2323