Adding a Model to the Test System

One of OpenBrIM's key features is the ability to ship continuous library and platform releases. The trade-off is that it can be hard to know whether any given release affects your model or your previously-submitted results — release notes alone rarely answer that question.

Setting up a test problem in your workspace lets both you and OpenBrIM engineers re-run the same checks before each release, ensuring nothing has changed unexpectedly.

The steps below show how to set up a test problem.

Add the Project to the Verification Profile

1. Click Add to Verification Profile as shown in the screenshot. The UI updates with test-related controls and additional menu items used in the next steps.

   

   
2. Two new menu options appear: Add Reference Summary Report and Run Summary Report Verification (Compare to Reference). Each FEA result and each read-only spreadsheet parameter also gains an Add to Verification option.

   

   

   

Add Verifications

To add a read-only parameter or FEA result from the spreadsheet, use the Add to Verification button. Add only critical results, not every result, to keep verification time short.

For each check:

1. Pick a relative tolerance (percentage comparison) or a value tolerance (absolute comparison).
2. Choose the log level — Info, Warning, or Error — each has its own color code.
3. Name the check and click Accept.

All verifications are visible under Verify Spreadsheet, where you can edit values directly from the UI.

Add the Summary Report Reference

Add the summary-report results as a verification baseline. Today, you can verify the entire summary report only — there is no per-value selection.

1. Run Design.
2. Return to the verification profile menu and click Add Reference Summary Report.
3. Set the percentage and absolute tolerances. A value fails only when both tolerances are exceeded simultaneously.
4. Click Continue — the current summary-report results are uploaded as the reference for future tests and the file is added to your project.

Run the Tests

1. Click Test to open the test system and view your projects. Pick the tests you want to run from the tree view and click the Play icon.

   

   

   
2. Test results appear as pass/fail. Use this after each OpenBrIM release as a batch run to confirm nothing has shifted. To check a library update, add the test before the update, click Update Library, then re-run the test.