Adding a Model to the Test System

One of the key features of OpenBrIM is the ability to make continuous library and platform releases. However, it can be challenging to keep track of what has changed and whether these changes affect your model or previously submitted results. Simply reading the release notes often does not provide this information directly.

Setting up these types of test problems in your workspace allows both you and OpenBrIM engineers to run the tests before each release, ensuring that nothing behaves differently or impacts your results unexpectedly.

Here is a step-by-step quick guide to setting up a test problem.

Instructions	Screenshot
The first step is to add your project to the verification profile by clicking Add to Verification Profile as shown in the screenshot. This updates the UI to include test-related functionality and displays additional menu items that will be used in the next steps.
Once added, you will see two new menu options: Add Reference Summary Report and Run Summary Report Verification (Compare to Reference). In addition, each FEA result and each read-only spreadsheet parameter will now include an Add to Verification option.
To add any read-only parameter or FEA result from the spreadsheet, use the Add to Verification button. The important thing is to add only critical results instead of every result to reduce verification time. Select the relative tolerance for percentage comparison, or choose a value tolerance if you want to compare absolute values. Specify whether to log the result as Info, Warning, or Error—each with its own color code. Name each check according to your needs, then click Accept.
Once added, you can view all your verifications under Verify Spreadsheet and modify the values directly from the UI.
The next step is to add the summary report results to the verification. At this stage, the user can only verify all values in the summary report—there is no option to check individual values or separate them. To do this, after running the “Design”, return to the menu where you added the verification profile and click Add Reference Summary Report. For a test to fail for any single value, the difference must exceed both the percentage tolerance and the absolute tolerance simultaneously. Enter the tolerance values here, then click Continue. This will upload all current summary report results for future tests and add the file to your project.
Congratulations! You have successfully added your project to the test system. Now click Test to open the test system and view your projects. Simply select the tests you want to run from the tree view and click the Play icon.
Once the tests run, you will see the results as passes or failures. This way, you can always review your results after each OpenBrIM release using batch runs. To check new library updates, add the problem before the update, then click Update Library and run the test again.