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.

eHS File Centric Migration

Introduction

Starting with HYPERSIM 2024.4, eFPGASIM 2.20 has adopted a File-Centric approach for model management, moving away from its previous Database-Centric approach.

HYPERSIM 2024.3 and lower

In previous versions of HYPERSIM, the FPGA-Based Circuit component was storing its model in the Unified Database. A copy of the model was be automatically exported when loading the circuit. It could be found under the design’s folder ( modelName_hyp/configurationsIO/OpalBoardsAddons/model*.json). The model could still be edited via the Schematic Editor since it was present in the database.

HYPERSIM 2024.4 and higher

In recent versions of HYPERSIM, the component is strongly linked to a .ehs3 file, which is an upgraded version of the previously existing .json/.ehs file. In order to improve versioning and share-ability, this file was moved out of the _hyp folder. Creating, assigning and loading these ehs3 files can be done by right clicking the component on the schematic inside HYPERSIM, under the “eHS” context menu. Please read the FPGA-Based Circuit page for the detailed options and best practices.

This new approach gives the user more control on the versioning and portability of the model. It will now be easier to store a model in a versioning system such as Git or SVN, and reuse the model in another circuit.

Migrating from database centric to file centric

If the HYPERSIM design was made in a version with the database centric approach, HYPERSIM will automatically migrate the component’s data.

Whenever HYPERSIM realises the existence of the FPGA based circuit component (whether by loading the sensors when opening the circuit, when double clicking the device for the first time, or by analysing the circuit), the following operations will be automatically performed.

  • the original FPGA circuit json file is found ;

  • the eFPGASIM API is used to convert the old json file into an ehs3 file. The resulting file is placed next to the design file (ecf) ;

  • The component is disconnected from the json and reconnected onto the ehs3 file ;

  • A notification will be shown to know where the model was created.

file_centric_migration.png

No manual operation is needed. HYPERSIM will automatically load the circuit during the next analyse if it was not done manually after opening the model.

Note: Loading the circuit will still create this OpalBoardsAddons json file which existed in the database centric workflow. This file is needed and therefore regenerated during this process to correctly apply the circuit inside HYPERSIM, but is not necessary when versioning the model, as it will be regenerated when needed.

OPAL-RT TECHNOLOGIES, Inc. | 1751, rue Richardson, bureau 1060 | Montréal, Québec Canada H3K 1G6 | opal-rt.com | +1 514-935-2323
Follow OPAL-RT: LinkedIn | Facebook | YouTube | X/Twitter