Home
User Guide
Learn about the features and functionality available in Compose.
Languages and IDE
Learn about the supported languages and utilities for coding in Compose.
Python Support
Compose supports Python 3.8 as a scripting language.
Install Additional Python Packages
Install Python packages using OML and other methods.

Welcome
What's New
Discover new features and enhancements.
Get Started
Discover Compose, including its language support and system requirements.
Tutorials
The Compose tutorials and associated example model files help introduce you to the basic functionality of the software.
User Guide
Learn about the features and functionality available in Compose.
- Invoke Compose
  Run the software using console, GUI, batch and start-up file methods.
- Languages and IDE
  Learn about the supported languages and utilities for coding in Compose.
  - OML Support
    Open Matrix Language is the primary math and scripting language for Compose.
  - Tcl Support
    Compose supports the Tcl scripting language, revision 8.5.9, for editing, execution, and debugging.
  - Python Support
    Compose supports Python 3.8 as a scripting language.
    - Install Additional Python Packages
      Install Python packages using OML and other methods.
    - Uninstall a Python Package
    - Resolve Python Compiling Errors
  - R Support
    Compose supports R as a scripting language for both edition and execution.
  - User Profile
    The User Profile tool facilitates a choice of languages for the Compose coding environment.
  - Compose IDE
    The Compose Integrated Development Environment offers many tools which can be used for authoring and debugging operations.
- Edit Scripts
  Learn how to open, create, and close scripts.
- Run Scripts
  Click Run to execute a script.
- Profile Scripts
  Run files and profile them at the same time.
- Create Plots
  In Compose, you can create 2-D and 3-D plots using OML plotting commands.
- Edit Properties of Plots
  In Compose, you can edit the properties of plots created with OML plotting commands.
- Debug Code
  Use the Debugger to find errors in the script.
- Compose Notebook
  The Compose Notebook is a web-based implementation of Compose’s OpenMatrix Language (OML) into a Jupyter Notebook. Notebooks (see www.jupyter.org) are a powerful way to execute and demonstrate scripted languages.
- Graphical User Interfaces
  Learn about the methods, functions and file input and output options for creating a GUI.
- CAE Applications
- HDF5 Viewer
  Use the HDF5 Viewer to import data and navigate through the hierarchy of .hdf5 files.
- MAT Explorer
  Use the MAT Explorer interface to explore and load variables from one or more .MAT files, providing a visual way to see the contents of selected .MAT files and to import variables into an OML session.
- Signal Viewer
  Use the Signal Viewer to import and treat (basic) signals in both time and frequency domains, as well as generate signals based on the most common waveforms such as step, chirp and sawtooth.
- Plot Assistant
  Use the Plot Assistant to create plots from the various 2D and 3D OML plot types.
- Extension Manager
  Use the Extension Manager to create custom extensions, load extensions automatically, and add custom documentation for defined features.
- OML Functions in HyperWorks Products
  OML functions can be registered from the Compose graphical user interface or via a preference file and later opened in certain HyperWorks products.
- OML Libraries
  Additional libraries can be written in the C/C++ or Fortran language and interfaced with OML.
Reference Guides
Reference guides are available for functions and commands supported by OML, Tcl, and Python.
Appendix
Get help for the optional libraries that are available in the Extension Manager.
Frequently Asked Questions
You've got questions? We've got answers!

Install Additional Python Packages

Install Python packages using OML and other methods.

Install Using OML

Use the installpythonpackage OML function to install a Python library directly from the Compose interface. You can add information to the existing installpythonpackage documentation as required.

Install Using Other Methods

Use the pip command to install packages from the repository.

Run the Python executable:

Windows

<INSTALLATION_ROOT>\common\python\python<version>\win64\python.exe -m pip install <package>

Linux

<INSTALLATION_ROOT>/altair/common/python/python<version>/linux64/bin/python3 -m pip install <package>
For both Windows and Linux, you can also install a pre-compiled binary that's downloaded from other sources rather than installing from an online package, which could require compiling from the source. Resolving dependency issues on Windows can be complicated.
From the Python packages, download the wheel package and use the following command to install it:

Windows

<INSTALLATION_ROOT>\common\python\python<version>\win64\python.exe -m pip install <path-to-wheel>/package_name.whl

Linux

<INSTALLATION_ROOT>/altair/common/python/python<version>/linux64/bin/python3 -m pip install <path-to-wheel>/package_name.whl
Note: If a Python package requires any direct or indirect building of C++/Fortran code, it may not work.
Install a Python package using the “--user” option.
- Python packages installed using the “--user” option go to a default location if the PYTHONUSERBASE environment variable is not set. Python packages installed for other applications using “--user” will interfere with Compose if PYTHONUSERBASE is not set.
- To avoid the potential problem, Compose sets PYTHONUSERBASE to:
  <user home directory>/.altair/Compose<version>/hwx/python
- Set PYTHONUSERBASE to <user home directory>/.altair/ Compose<version>/hwx/python before using the argument “--user” to install packages.
  
  Windows
  
  set PYTHONUSERBASE=C:\\Users\\<userid>\\.altair\\Compose2024.1\\hwx\\python
  
  <INSTALLATION_ROOT>\common\python\python<version>\win64\python.exe -m pip install --user <package>
  
  Linux
  
  export PYTHONUSERBASE=/home/<userid>/.altair/Compose2024.1/hwx/python
  
  <INSTALLATION_ROOT>/altair/common/python/python<version>/linux64/bin/python3 -m pip install --user <package>