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.

Project Import-Export

The project import and export features are accessible through the HYPERSIM Ribbon Options.

Exporting a Project

Configuring the Export

The Project > Export or Import ribbon option opens an Export Wizard, which helps select the files needed to operate the project and to add some descriptions to them.

Some files are detected as necessary for the project. The description of these files is fixed, and they cannot be removed from the list.

The following files are currently auto-detected:

  • The ecf file
  • The hyp folder
  • Any file related to a UCM
  • Any file related to a device
  • The bitstream of an OpalBoards I/O interface

Some additional files may need to be added manually, for example :

  • CID files
  • ScopeView templates and references
  • Sensor configuration files

For convenience, the files located in the same folder as the .ecf file are shown in the list, but not selected.

Good practice for maintaining project portability:

For projects that require external configuration files (.pun, .dat, .edd ...), it is recommended that users place them next to the ecf file, as their location will be relative to the project.

The table has a tooltip, which users can hover their mouse over, to help understand the styling of the File Path column.

Using the refresh button looks once again through the project to find any new needed files, and updates the status of already-listed files. This operation may take a while for large models, as every device is being queried.

You may use the Add files and Add folder buttons to manually add files not automatically suggested. Adding a folder zips all the folder's content. 

The Select All toggle button selects or unselects every file not automatically detected.

The configuration of the wizard is saved when the view is closed. Should you have to export your project again in another session, you will not need to select files and add descriptions manually again.

Once your export is fully configured, the Export button zips all files and places them in the chosen destination.

Zip Output Structure

Once the project has been successfully exported, the zip file is created.

Here is the example of the export from the previous project :

The structure of the files is kept. The archive also contains 2 additional files:

  • If the project contained files that weren't next or under the ecf parent directory, an ExceptionFiles folder is included. Every file or folder shown as not being part of the project path will be zipped inside this folder.
  • REAMDE text file. This document contains the descriptions provided in the table. This document also shows various export information (Date, Author, HYPERSIM version ...), as well as the original location of the files archived, as it may be helpful to recreate the project manually if required.

Importing a Project

To import a project, users can:

  • Choose the zip file to be imported as a project
  • Select a destination folder, where the project will be unzipped

The zip file will then be unzipped and the design is automatically opened. If the project contained external files, HYPERSIM will offer to open the README file in the user default .txt file editor.

Two methods may help users in fixing a project which requires external files:

  • Moving the files within the ExceptionFiles folder back to their original place. This can only work if the original path is not user-dependent.
  • Moving the files outside of the ExceptionFiles folder, and change the circuit configuration to re-link to these new locations. This may be more time-consuming but will fix the next export, as it will match the Good practices outlined above.

Note: Importing a model with large binary files (such as bitstreams) can take several minutes per bitstream.

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