Skip to content

Commit abd3d9e

Browse files
authoredApr 13, 2022
Update testresults.md
1 parent 2980d2d commit abd3d9e

File tree

1 file changed

+23
-20
lines changed

1 file changed

+23
-20
lines changed
 

‎testresults.md

+23-20
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,6 @@
11
# Test Results of Open-Source Modelica Libraries using OpenModelica
22

3-
The library testsuite job is run every night on the OSMC servers, testing open-source Modelica libraries covered by the
4-
[Package Manager](https://github.com/OpenModelica/OMPackageManager#readme) with various versions of OpenModelica,
5-
including the development version on the master branch. The simulations are run with the C-runtime, unless specified differently.
6-
7-
Within each library, all models with an experiment(StopTime) annotations are run. For each tested model, the results of the following steps are reported:
8-
- _parsing_
9-
- _frontend_: flattening the model
10-
- _backend_: structural analysis, index reduction, causalization, tearing, and all kind of symbolic manipulations and optimization to solve the model efficiently
11-
- _simcode_: intermediate stap towards simulation code generation
12-
- _templates_: generation of the actual C code
13-
- _compilation_: compilation of the C code into a simulation executable
14-
- _simulation_: the simulation is actually run to produce simulation results
15-
- _verification_: if reference results file are available, they are compared with the simulation results
16-
17-
Clicking on the model name shows the log of phases from parsing to compilation. Clicking on the (sim) link shows the log of the runtime simulation.
18-
19-
Many different reports are available:
3+
## Test reports
204

215
- **Overview with library test results across OMC versions**: These reports shows how libraries with full or partial support level
226
(see [here](https://github.com/OpenModelica/OMPackageManager/blob/master/README.md#library-support-levels-in-openmodelica) for more details)
@@ -35,6 +19,25 @@ Many different reports are available:
3519
- [C++](https://libraries.openmodelica.org/branches/history/cpp/): simulation with C++ runtime
3620
- [FMI](https://libraries.openmodelica.org/branches/history/master-fmi/): simulation with FMI, C runtime
3721

38-
If you are actively developing a library, it is recommended to have two tests for it: one testing the latest official release, which can be used
39-
to check if changes to OMC cause regressions to the existing library, another one testing the development version, which also checks regressions
40-
caused by changes to the library code. You can then bookmark the page with regression reports, and the page with the test results with your favourite settings
22+
## How to read the test reports
23+
24+
The library testsuite job is run every night on the OSMC servers, testing open-source Modelica libraries covered by the
25+
[Package Manager](https://github.com/OpenModelica/OMPackageManager#readme) with various versions of OpenModelica,
26+
including the development version on the master branch. The simulations are run with the C-runtime, unless specified differently.
27+
28+
Within each library, all models with an experiment(StopTime) annotations are run. For each tested model, the results of the following steps are reported:
29+
- _parsing_
30+
- _frontend_: flattening the model
31+
- _backend_: structural analysis, index reduction, causalization, tearing, and all kind of symbolic manipulations and optimization to solve the model efficiently
32+
- _simcode_: intermediate stap towards simulation code generation
33+
- _templates_: generation of the actual C code
34+
- _compilation_: compilation of the C code into a simulation executable
35+
- _simulation_: the simulation is actually run to produce simulation results
36+
- _verification_: if reference results file are available, they are compared with the simulation results
37+
38+
Clicking on the model name shows the log of phases from parsing to compilation. Clicking on the (sim) link shows the log of the runtime simulation.
39+
40+
## How to get your open-source library in the testsuite
41+
42+
If you are actively developing an open-source Modelica library using a GIT repository, you can easily get it included in the OpenModelica library testsuite. Please open a request on the [OpenModelica issue tracker](https://github.com/OpenModelica/OpenModelica/issues/new/choose).
43+
Ideally, you should have two tests for it: one testing the latest official release, which can be used to check if changes to OMC cause regressions to the existing library, another one testing the development version, which also checks regressions caused by changes to the library code. You can then bookmark the page with the regression reports and the page with the test results obtained with your favourite settings.

0 commit comments

Comments
 (0)
Please sign in to comment.