Skip to main content
  1. HyperX Support
  2. Glossary
  3. File Organization

Project Bundle

HyperX Projects - which live within Databases - contain the imported finite element model and all subsequent data organization and Sizing/Analysis results. In many cases, it can be useful to pass Projects back and forth between team members in order to review work, compare results, change computers, etc. HyperX has a utility for bundling a selected Project and related supporting files to make them easier to share.

This process compiles a Project into a single, shareable bundle (*.hxp) file. The bundle can be provided to a teammate or shared to a common server. Anyone who'd like to view this Project can directly "unbundle" the .hxp file in their own HyperX instance. When a Project is unbundled, all supporting FEM and Working Folder (as selected by the bundler) files are unpacked and placed in the proper locations on the new machine - in reference to the Project location.

This eliminates the potentially error-prone, manual aspects of mirroring a Project setup in a new place, and ensures that the unbundler can readily click "Size" or "Analyze" and immediately receive the exact same results as the original user.

About

  • A Bundle file (*.hxp) contains a selected Project and all (chosen) related files. Including:

    • FEM Input/Output files.

    • The Project Working Folder.

    • Plugins used by the Project.

  • A *.hxp file is unbundled from a new HyperX instance. During the unbundle process, all FEM files, the working folder, and Plugins are placed in the same places relative to the .hxp file as they were relative to the original Project.

Create a Bundle

  1. To access the "Bundle Project" utility, click the Project Data button on the Database tab of the Ribbon.

    Project_data-fromRibbon.png

  2. Select "Create Project Bundle".

    Project-package.png

  3. Configure the following options:

    • Files (formerly Archive) - Choose which files are included in the bundled Project share file.

      • FEM Input Files - Select to include your FEM input files in the bundled file.

        • FEM Output Files - Select to include corresponding FEM output files in the bundled file.

        Including FEM Files, particularly output files, tends to drastically increase the size of the share file. The benefit, however, is that the FEM does not need to be re-run after unbundling and loads are consistent between team members

      • Working Folder - Select to include the Project Working Folder (which contains all temporary and results files corresponding to the existing analysis results) in the bundled file.

        • Include Loads Files - If you've already run a Sizing or Analysis, loads from the FEM have been imported into your Database and processed accordingly. Selecting this option will include the corresponding load files in the bundled file.

        Similar to FEM Files, including the Working Folder and/or Loads Files can drastically increase the size of the share file. However, doing so means ultimate consistency between team members - same Sizing/Analysis results files, same loads imported, etc.

      • Include Plugin Packages - Select to include any Plugin .dll files that are referenced by the Project in the bundled file.

    • Packages - Select Packages to include with the Project in the bundled file. You can use the dropdown menu on each Package to see its Source, the Modules it contains, which Packages require it. Note that if a Package is a dependency for another Package, it cannot be removed from the Project Bundle without first removing the Package that requires it.

      • Pin - Use this toggle to pin the Package version in the bundled Project. See "Updating Packages" here for more information.

      • Scrub Sources - A Source is a folder that contains Packages. This option, when enabled, removes Package Sources from the bundle so the bundled Project can only load the Packages explicitly included via this form. This option can prevent unintentionally exposing Packages that you don't want to share when you bundle a Package from a shared Source.

    • Options - Additional selections for configuring the bundled file.

      • Remove all other Projects from the Database - Select to ensure only the current Project is included in the bundled file (de-select to include all Projects in the Database).

        • Delete Unused Properties and Materials - Select to ensure that any Property or Material in the Database that isn't referenced by the current Project(s) will be deleted/not included in the bundled file.

      • Map FEM Files to Relative Paths - Select to assign FEM input and output files to paths relative to the unbundled Database. This allows the freedom to unbundle the Project and FEM files in any location without having to worry about fixed file paths to maintain.

    • Additional File - Attach additional files of any kind to include in the bundled file.

  4. Click "Bundle" to generate the shareable Project Bundle in a selected location.

Unbundle a Project

A *.hxp file can be unbundled on a new machine using the Project Options menu on the Database tab of the Ribbon.

Unpackage.png

  1. Select "Open Project Bundle".

  2. In the resulting form, select the file you'd like to unbundle (i.e. the Source Archive). Use the ... icon to open the file browser and navigate to the *.hxp file.

  3. Select a Destination Folder (where the Database containing your Project will live once it is unbundled). Use the ... icon to open the file browser and navigate to the preferred location on your machine.

  4. Use the checkboxes to select what you'd like to unbundle. Note that only data that was previously bundled can be unbundled- i.e. if the bundle does not contain the Working Folder, no Working Folder will be unbundled.

  5. Click "Open Bundle" to unbundle the file.

Note

During this process that all supporting files are placed in the proper locations relative to the selected destination folder.

Recently Viewed

Didn’t find what you’re looking for?

Submit a Request

Didn’t find what you’re looking for?

Create a New Post