Export environment - HyperStudy

New solver script to be registered

Before starting new studies in Altair® HyperStudy® by using connectors exported from Altair® FluxMotor®, FluxMotor® must be registered as a new solver script in HyperStudy®. This must be defined only while using the coupling for the first time. 

Connection between Altair® FluxMotor® and Altair® HyperStudy®
1 Open the area in HyperStudy® to register FluxMotor® 2024 script
2 Path where FluxMotors.exe must be selected to be registered as a new solver in HyperStudy®.
Note: FluxMotors.exe with an “s” at the end of FluxMotors.

This must be defined only when using the coupling for the first time. 

Note: In the version 2022.1 of HyperStudy, the FluxMotor solver script is automatically registered, when the default path installation is selected while installing Flux and FluxMotor.
Note: The new auto generation of the HyperStudy study in HyperStudy Application (described above) allows to automatically register FluxMotor® as a new solver script in HyperStudy®. If HyperStudy is not installed in the same folder (by default : C:\Program Files\Altair\2024\hwdesktop\hst), the path must be defined in the user preferences via the supervisor of FluxMotor (Path to HyperStudy – Needed for HyperStudy export).

Mandatory synchronization between connector and FluxMotor versions

The connectors used in HyperStudy must be synchronized with the FluxMotor solver version.

An error message (inside the log files) is generated while performing HyperStudy studies with a connector provided with a former version of FluxMotor solver.

Export a connector for HyperStudy studies - Process

What happens while using a compatible HyperStudy connector?

Illustration of the problem when one uses a non-compatible HyperStudy connector with the selected solver in HyperStudy application (Refer to the Register Solver Script).

Open the FluxMotor project (example Motor1) with the version FluxMotor 2022.3

Get into the EXPORT area and select HyperStudy workspace
  • Select the test to be performed.
  • Select the test configuration.
  • Select the parameters for HyperStudy
  • Define the Export information: Connector name: Motor1_C1, for example, and the destination folder
  • Then, export the connector.

Generation of a connector for HyperStudy from Motor Factory Export- HyperStudy area.
In the HyperStudy software, create a new study:
  • Give a name to this study.
  • Locate the connector to be considered.
  • Select the Solver Execution Script.
In a first step, let’s select the FluxMotor 2022.3 solver
  • Import variables
  • Define inputs (and constraints if needed)
  • Run the definition of the model

In such a case, the Test Models execution (Write / Execute / Extract) must pass (all the indicators are green) since the Connector exported from FluxMotor 2022.3 is compatible with the FluxMotor Solver used in HyperStudy.

What happens while using a non-compatible HyperStudy connector?

Now, what happens if one selects the FluxMotor 2023 solver instead of the FluxMotor 2022.3 solver i.e., if one uses a FluxMotor solver newer than the version with which the connector has been generated?

So, let’s modify the Solver Execution Script by targeting the FluxMotor 2023 solver.

And operate all the same previous steps:
  • Import variables.
  • Define inputs (and constraints if needed).
  • Run the definition of the model.

In that case, the Test Models execution do not pass (the indicator write is green but the two other ones - Execute and Extract are red).

If you get into the folder where the runs are stored, in the log.out file you’ll see the following error message:

The Hyperstudy connector version 2022.3.0 is incompatible with the FluxMotor solver version 2023.0.0#100.6.268 (FluxMotorLogger.java:212)

How can a non-compatible HyperStudy connector be made compatible?

Since FluxMotor 2023 version, a solution exists to update the connector and make it compatible with a more recent FluxMotor Solver Script. This consists of running the ConnectorUpdater.py file which is provided and located in the same folder as the connector. This allows us to update the connector and make it usable with a newer version of the FluxMotor solver.

To apply this new process, one must open FluxMotor 2023 and get into Script Factory. Then, in the Script Workspace, one must select the folder in which the previous connector is stored.

Then, open the ConnectorUpdater.py file located in this folder and run it.

Edit and run the ConnectorUpdater.py file from the Script Factory application

It is mandatory to run the ConnectorUpdater.py file in the folder where the Connector to be updated is located (the default location) otherwise the updating process will fail.

The ConnectorUpdater.py file must remain in the same folder as the connector to be updated.

A new folder containing the previous connector is then built at the same level as the former folder.

Its name is the same with the additional following extension: “_updated”.

For example, if the former connector was “Motor1_C1”, the new one is “Motor1_C1_updated”.

Resulting updated folder while running the ConnectorUpdater.py file

Now, in HyperStudy, you can build a new Study, by selecting this new resource and then run the Study with the new FluxMotor Solver Script, i.e., FluxMotor 2023.

Thanks to the updated connector the test Models (Write / Execute / Extract) pass (all the indicators are green).

General rules

  • A connector provided with FluxMotor version N-1 (or older) cannot be used in HyperStudy where the FluxMotor Solver Version N (or newest) is selected.
  • However, since the FluxMotor 2022.3 version, each time you generate a connector, a ConnectorUpdater.py file is provided and located in the same folder as the connector.
  • Thanks to this script, the user can update an older HyperStudy connector generated with a former version of FluxMotor.
  • This process is fully operational with FluxMotor 2023.
  • Indeed, FluxMotor 2022.3 was the very first version where a ConnectorUpdater.py file was automatically generated each time a HyperStudy connector is provided from the Export/HyperStudy workspace of Motor Factory.
  • Hence, when using the FluxMotor 2023 solver in HyperStudy, one is able to update the connector provided with FluxMotor 2022.3 by using the ConnectorUpdater.py file generated with the previous version, i.e., FluxMotor 2022.3.
Note: As indicated, for FluxMotor versions older than 2022.3, the ConnectorUpdater.py is not available and consequently, the generated HyperStudy connectors with such versions cannot be updated.