HyperMesh Python API User Guide

HyperMesh Python API allows you to automate your workflows in the HyperMesh client and leverage the hundreds of Python libraries that are included in the installation. Via the hwx.gui module, you can develop custom GUIs and link them to your Python scripts. If you wish to include multiple custom solutions within a single, easily deployable package, you can package your code as an extension.

The HyperMesh Python API User Guide will take you through various aspects of the Python API layer for the HyperMesh client. It will help you understand the structure of the available modules, how to work with the API and where to find all the necessary information.

The Python command layer comes as an addition to the Tcl API that has been part of HyperMesh for most of its lifetime. Wherever appropriate, we will explain the parallels and commonalities between the Python API and Tcl API to help existing Tcl users transition over to Python. At the same time, we hope that new users will appreciate the historical background and how it shaped the first generation of HyperMesh Python API.

Contents:

• Session and Model class
  • hm.Session Class
  • hm.Model Class
• Entity Classes
• Entity Selection via Collections
  • Basic Operations
  • Advanced Methods
  • Interactive Selection
  • Arithmetic Operations
  • Collection Set
• HyperMesh Functions
  • Tcl vs Python Signatures
  • Argument Comparison Table
  • Implicit Conversion
  • Status Object
  • Query Functions
  • Split Functions
• Creating Custom GUI