Each HyperX install includes various Scripts to help get you started with Scripting. These Scripts are split between three categories:
-
Public/Toolbox - Scripts which provide useful functionality and require little to no Database setup to execute successfully. These are distributed in Package form in the following Source:
$(InstallDir)/Packages/Sources/CA. -
Sample - Simple Scripts which do not provide significant functionality, but which serve as starting points for you to write your own Scripts. They contain examples such as Scripts with picker forms or cancel buttons. These are distributed as Python files placed in
C:/HyperX/Scripts/SampleScripts, and are distributed in Package form in the following Source:$(InstallDir)/Packages/Sources/CA-Sample. -
Experimental - Scripts which provide more complex functionality, but which may require additional Database or Python environment set up to run successfully. These are distributed in Package form at the following Source:
$(InstallDir)/Packages/Sources/CA-Experimental.
Note
All Sample Scripts are enabled for the HyperX Script Runner.
All Scripts have an associated README.md file that describes the script's usage and applicability. Open the Script Package details in the Package Manager to view the Script change logs and READMEs.
You can open the Package Manager from the Database tab of the Ribbon.
The first step to using the Included Scripts is to install them from the Package Manager. Add the three Sources for the Scripts from above in the HyperX Package Manager Settings (see "Adding a Package Source" here) and click "Apply" to save. Back in the Package Manager, you will see several more Packages you can install by clicking the "Install" button on each Package.
Once installed, all Scripts from these Packages can be found in the Script Runner which can be opened from the Run tab of the Ribbon. Using the "Scripts" section you can navigate through each folder to find all of the Scripts included with your install and corresponding changelogs and documentation.
You can also find these Scripts on a per-Package basis by viewing the "Modules" for a selected Script Package.
The video below walks through implementing a series of Collier-Aerospace-created Scripts in order to enforce symmetric Design Results across a vehicle. View to visually understand the script setup process, shown above, as well as implement the symmetry workflow.
Tip
The Database and additional files used in the following video can be found here: SymmetryLinkingScriptsDemo.hxp
|
Script Name |
Package Source |
Overview |
|---|---|---|
|
Assign by Set |
Experimental |
This Script helps users view, configure, and assign Set-specific and Zone-specific settings. |
|
Assign Analysis Overrides |
Experimental |
This Script applies Analysis Overrides in bulk. This Script is also applicable when using the "Export Linked Analysis Overrides" Script, which produces Analysis Overrides. |
|
Assign Min Sizing Bound Overrides |
Experimental |
This Script applies min bound Sizing Overrides in bulk. This Script is applicable when enforcing unique (or linked) min Sizing bounds per Zone. |
|
Export Linked Analysis Overrides |
Experimental |
This Script produces a UI to guide you through a symmetry/linking process where you can filter by Sets and Structures, group Zones by name or centroid, and export Analysis Overrides as a CSV file. This Script is useful when you need to link the Design Results of Zones across a Project. The Script enforces symmetry or linking by taking the results from the heaviest Zone in the group. It is up to the user to ensure that the design from the heaviest Zone produces positive margins of safety for all Zones in the group after Analysis. |
|
Export Analysis Overrides |
Experimental |
This Script exports the Analysis Overrides for the Zones in the active Project to a CSV file. |
|
Create Joints |
Public/Toolbox |
This Script creates Joints in Structures, given FEM property name and individual Joint IDs. |
|
Create Panel Segments |
Public/Toolbox |
This Script is designed to create Technique 2 DSM segments (Panel Segments) based on CSV input. |
|
Create Sets By Structure and Zone Name |
Public/Toolbox |
This Script automates the process of searching in the HyperX Structure Tree and creating Sets based on the search results. It is applicable in scenarios where you need to create Sets of Zones based on their names like "Skin 001 Outer" so you can create Sets with Zones that all have "Skin" in the name. |
|
Create Sets and Structures |
Public/Toolbox |
This Script reads a CSV file with all Structures and Sets and their constituent Zone IDs & Joint IDs and adds them to the Database. This Script is intended to consume the Structure and Set definitions from the "Export HX Set Definitions" and "Export Structures" Scripts. |
|
Create Zones by Elements |
Public/Toolbox |
This Script creates Zones based on a CSV file of Zone definitions by ID, Name, Structure, and Elements. It is applicable in scenarios where you need to recreate Zone definitions that might not correspond with the FEM property assignment. This Script is intended to consume the Zone definitions from the "Export Zone Definitions" Script. |
|
Assign Properties to Entities |
Public/Toolbox |
This Script assigns existing Properties to HyperX Entities, given provided CSV input. It is applicable in scenarios where you need to assign Properties to Entities in a HyperX Project. |
|
Rename Zones with Zone Id |
Public/Toolbox |
This Script replaces the PID part of the Zone name with the Zone ID. |
|
Edit Rundeck File Paths |
Public/Toolbox |
This Script replaces specified text in all Rundeck input and result file paths with new user-provided text. It is applicable in scenarios where you need to modify the file paths in all of a HyperX Project's Rundecks. |
|
Rename and Renumber Zones |
Public/Toolbox |
This Script renames and renumbers existing Zones in a HyperX Project, given a provided CSV mapping file. |
|
Renumber Zones by First Element Id |
Public/Toolbox |
This Script renumbers all Zones in a HyperX Project based on the ID of the first Element in each Zone. It is applicable in scenarios where you need to renumber Zones in a HyperX Project based on their first Element ID to ensure that the Zones are numbered correctly because they are not numbered correctly when using the Zone Splitter. |
|
Renumber Zones |
Public/Toolbox |
This Script renumbers all Zones in a selected set in a HyperX Project. It is applicable in scenarios where you need to renumber Zones in a HyperX Project starting from a specific Zone id. |
|
Project Runner |
Public/Toolbox |
General utility for running Projects across Databases. Support for running Projects in sequence or in parallel. |
|
Sensitivity Study |
Public/Toolbox |
This Script performs a sensitivity study on a HyperX Set by trading Design Properties. It is applicable in scenarios where you need to understand the impact of different Design Properties on the total Set weight and minimum margin. |
|
Export Joint Property Assignments |
Public/Toolbox |
This Script exports the assigned Analysis, Design, and Load Properties for each Joint in the Project. It also includes Structure and Set assignment. It is applicable in scenarios where you need to export Joint Property assignments in a HyperX Project where Joints have results. |
|
Export Panel Segments |
Public/Toolbox |
This Script exports all technique 2 DSM segments (Panel Segments) in a HyperX Project to a chosen CSV file. |
|
Export Property Assignment |
Public/Toolbox |
This Script exports to a chosen CSV file all Entities (Zones/Joints) and their assigned Properties contained within the active Project. |
|
Export HX Set Definitions |
Public/Toolbox |
This Script exports a CSV file with all Sets and their constituent Zone IDs & Joint IDs contained within a HyperX Project. |
|
Export Structures |
Public/Toolbox |
This Script exports to a chosen CSV file all Structures and their constituent Zone IDs & Joint IDs contained within a HyperX Project. |
|
Export Zones in Sets |
Public/Toolbox |
This Script exports Zones in selected Sets to a CSV file for use in Zone assignment Scripts. |
|
Export Zone Centroids |
Public/Toolbox |
This Script exports the centroids of all Zones in the active HyperX Project to a chosen CSV file. |
|
Export Zone Definitions |
Public/Toolbox |
This Script exports a CSV file of Zone definitions by ID, Name, Structure, and Elements. |
|
Export Laminate Allowables |
Public/Toolbox |
This Script exports laminate allowables for all Materials in a given HyperX Database to a CSV file. |
|
Export Projects |
Public/Toolbox |
This Script exports a CSV file with all Project names contained within a HyperX Database to the temporary directory. |
|
Plugin Zone Override Helper |
Public/Toolbox |
Prints information useful for creating a ZoneAnalysisSettings.csv file by hand: Expected file location, Plugin Analysis Setting IDs, and Plugin Data Type IDs. |
|
Report Project Stats |
Public/Toolbox |
This Script reports the number of Sets, Structures, Zones, Panels, Beams, Panel Segments, and Joints in the active HyperX Project. It is applicable in scenarios where you need to quickly get a count of various entities in a HyperX project. |
|
Export MS, Controlling Criterion, and Controlling Design Case per Zone |
Public/Toolbox |
This Script exports to a CSV file the Margin of Safety (MS), Controlling Criterion, and Controlling Design Case for each Zone in a HyperX Project. It is applicable in scenarios where you want to automate extraction of these basic Analysis Watch Window metrics. |
|
Export Rundeck IDs to CSV |
Public/Toolbox |
This Script exports Rundeck IDs along with the name of the Rundeck to a CSV file. It is applicable in scenarios where you need to export Rundeck IDs and names from a HyperX Project for generating design load spreadsheets. |
|
Import Joint Property Assignments |
Public/Toolbox |
This Script assigns existing Analysis, Design, and Load Properties specified in a CSV file to the indicated Joints in a HyperX Project. |
|
Import Laminate Allowables |
Public/Toolbox |
This Script imports laminate allowables for all materials in a given HyperX Database from a CSV file. It is applicable in scenarios where you need to import laminate allowable information into a HyperX Project. |
|
Cancel Demo |
Developer Samples |
This Script demonstrates renaming the first Structure in a HyperX Project, with an option to cancel the operation. This is an example of the ability to cancel an operation. |
|
Create Properties |
Developer Samples |
This Script demonstrates Property creation and assignment using a few different strategies. |
|
Create Failure Modes |
Developer Samples |
This Script demonstrates finding Failure Mode categories, Failure Mode creation, and editing criteria and settings. |
|
List Picker |
Developer Samples |
This Script demonstrates how a Script can prompt for user selection. |
|
Multiple Python Files |
Developer Samples |
This Script demonstrates how the Script source code can span multiple Python files. The Script imports a function from a nearby file and uses it to print text to the console. The Package configuration necessarily tells the package to |
|
Print Sizing Results |
Developer Samples |
This Script prints the Sizing results of all Zones in the active HyperX Project. It is applicable in scenarios where you need to quickly view the Sizing results for all Zones in a HyperX Project. |
|
Project Setup |
Developer Samples |
This Script shows the process of taking a new Project, importing a FEM, and Analyzing. The Script can also be modified to work with a fresh Database created using a Template. |
|
Template Script |
Template Script |
A template Script for use with the HyperX Scripting API and Script Runner. Copy this directory and modify as needed. |