These How-To's are introductions to using HyperX Scripting API. Following them will walk a user through some common tasks that they will face as they begin to use the Scripting API.
Tip
Each HyperX install comes with Sample Scripts to help you get started with Scripting. They can be a helpful reference as you work through these examples.
Many of these How-To's show a couple of ways to perform the task, one with the standard Scripting API and then ones with the Script Runner and/or the hyperx python package(which we recommend as it makes a lot of these tasks much easier). They are summarized below:
-
How To Setup Your Environment details a few ways to set up your Scripting environment with Python or C#
-
How To Open and Close a Database details a few ways to interact with Databases with the Scripting API.
-
How To Query Model Organization shows how to print out the Zone and Joint names in all of the Sets and Structures in the Database.
-
How To Create Organizational Entities shows how to create organizational entities such as Sets and Structures.
-
How To Assign Entity Properties describes how to assign Properties to Zones via the Scripting API.
-
How To Size Zones and Joints describes how to automate Sizing Zones and Joints with the Scripting API and Script Runner.
-
How To Create Lists With and Without the Python Wrapper demonstrates the power of the
hyperxpython package by creating C# style lists with and without the wrapper.