Change back to Rodas5P

Author: AnHeuermann

.github/workflows/msl-test.yml

@@ -36,6 +36,11 @@ on:
         required: false
         default: '^(?!Modelica\.Clocked)'
         type: string
+      solver:
+        description: 'ODE solver algorithm (any DifferentialEquations.jl algorithm name, e.g. Rodas5P, FBDF)'
+        required: false
+        default: 'Rodas5P'
+        type: string
 
 concurrency:
   group: pages-${{ inputs.library || 'Modelica' }}-${{ inputs.lib_version || '4.1.0' }}-${{ inputs.bm_version || 'main' }}
@@ -58,6 +63,7 @@ jobs:
       BM_VERSION_INPUT: ${{ inputs.bm_version || 'main' }}
       BM_OPTIONS:  ${{ inputs.bm_options || 'scalarize,moveBindings,inlineFunctions' }}
       FILTER:      ${{ inputs.filter || '^(?!Modelica\.Clocked)' }}
+      SOLVER:      ${{ inputs.solver || 'Rodas5P' }}
 
     steps:
       - name: Checkout source
@@ -123,6 +129,9 @@ jobs:
         run: |
           julia --project=. -e '
             using BaseModelicaLibraryTesting
+            using DifferentialEquations
+            solver_name = get(ENV, "SOLVER", "Rodas5P")
+            configure_simulate!(solver = getproperty(DifferentialEquations, Symbol(solver_name))())
             filter_str = get(ENV, "FILTER", "")
             main(
               library      = ENV["LIB_NAME"],

README.md

@@ -55,10 +55,55 @@ main(
 
 Preview the generated HTML report at `main/Modelica/4.1.0/report.html`.
 
+### Changing the ODE Solver
+
+By default the simulation uses `Rodas5P()`. To switch to a different solver,
+call `configure_simulate!` before `main`:
+
+```julia
+using BaseModelicaLibraryTesting
+using DifferentialEquations
+
+configure_simulate!(solver = FBDF())
+
+main(
+  library = "Modelica",
+  version = "4.1.0",
+  omc_exe = "omc",
+  ref_root = "MAP-LIB_ReferenceResults"
+)
+```
+
+Any SciML-compatible ODE/DAE algorithm (e.g. `QNDF()`, `Rodas4()`) can be
+passed to `solver`.
+
 ```bash
 python -m http.server -d results/main/Modelica/4.1.0/
 ```
 
+## GitHub Actions — Manual MSL Test
+
+The [MSL Test & GitHub Pages][msl-action-url] workflow runs automatically every
+day at 03:00 UTC. It can also be triggered manually from the GitHub Actions UI:
+
+1. Go to **Actions → MSL Test & GitHub Pages**
+2. Click **Run workflow**
+3. Fill in the options and click **Run workflow**
+
+The following inputs are available:
+
+| Input | Default | Description |
+| ----- | ------- | ----------- |
+| `library` | `Modelica` | Modelica library name |
+| `lib_version` | `4.1.0` | Library version to test |
+| `bm_version` | `main` | BaseModelica.jl branch, tag, or version |
+| `bm_options` | `scalarize,moveBindings,inlineFunctions` | Comma-separated `--baseModelicaOptions` passed to OpenModelica during Base Modelica export |
+| `filter` | `^(?!Modelica\.Clocked)` | Julia regex to restrict which models are tested (empty string runs all models) |
+| `solver` | `Rodas5P` | Any `DifferentialEquations.jl` algorithm name (e.g. `Rodas5P`, `Rodas5Pr`, `FBDF`) |
+
+Results are published to [GitHub Pages][msl-pages-url] under
+`results/<bm_version>/<library>/<lib_version>/`.
+
 ## License
 
 This package is available under the [OSMC-PL License][osmc-license-file] and the
@@ -68,6 +113,7 @@ file for details.
 [build-badge-svg]: https://github.com/OpenModelica/BaseModelicaLibraryTesting.jl/actions/workflows/CI.yml/badge.svg?branch=main
 [build-action-url]: https://github.com/OpenModelica/BaseModelicaLibraryTesting.jl/actions/workflows/CI.yml?query=branch%3Amain
 [msl-badge-svg]: https://github.com/OpenModelica/BaseModelicaLibraryTesting.jl/actions/workflows/msl-test.yml/badge.svg?branch=main
+[msl-action-url]: https://github.com/OpenModelica/BaseModelicaLibraryTesting.jl/actions/workflows/msl-test.yml
 [msl-pages-url]: https://openmodelica.github.io/BaseModelicaLibraryTesting.jl/
 [openmodelica-url]: https://openmodelica.org/
 [basemodelicajl-url]: https://github.com/SciML/BaseModelica.jl

src/pipeline.jl

@@ -251,6 +251,9 @@ function main(;
         length(cpu_info),
         Sys.total_memory() / 1024^3,
         time() - t0,
+        let s = _SIM_SETTINGS.solver
+            "$(parentmodule(typeof(s))).$(nameof(typeof(s)))"
+        end,
     )
 
     generate_report(results, results_root, info; csv_max_size_mb)

src/report.jl

@@ -159,6 +159,7 @@ function generate_report(results::Vector{ModelResult}, results_root::String,
 OpenModelica: $(info.omc_version)<br>
 OMC options: <code>$(info.omc_options)</code><br>
 BaseModelica.jl: $(basemodelica_jl_version)<br>
+Solver: <code>$(info.solver)</code><br>
 Filter: $(var_filter)<br>
 Reference results: $(ref_results)</p>
 <p>CPU: $(info.cpu_model) ($(info.cpu_threads) threads)<br>

src/simulate.jl

@@ -6,15 +6,15 @@ import ModelingToolkit
 import Printf: @sprintf
 
 """Module-level default simulation settings.  Modify via `configure_simulate!`."""
-const _SIM_SETTINGS = SimulateSettings(solver = DifferentialEquations.Rodas5Pr())
+const _SIM_SETTINGS = SimulateSettings(solver = DifferentialEquations.Rodas5P())
 
 """
     configure_simulate!(; solver, saveat_n) → SimulateSettings
 
 Update the module-level simulation settings in-place and return them.
 
 # Keyword arguments
-- `solver`   — any SciML ODE/DAE algorithm instance (e.g. `Rodas5Pr`, `FBDF()`).
+- `solver`   — any SciML ODE/DAE algorithm instance (e.g. `Rodas5P`, `FBDF()`).
 - `saveat_n` — number of uniform time points for purely algebraic systems.
 
 # Example

src/summary.jl

@@ -33,6 +33,7 @@ function write_summary(
         print(io, "  \"cpu_threads\":  $(info.cpu_threads),\n")
         print(io, "  \"ram_gb\":       $(@sprintf "%.2f" info.ram_gb),\n")
         print(io, "  \"total_time_s\": $(@sprintf "%.2f" info.total_time_s),\n")
+        print(io, "  \"solver\":       \"$(_esc_json(info.solver))\",\n")
         print(io, "  \"models\": [\n")
         for (i, r) in enumerate(results)
             sep = i < length(results) ? "," : ""
@@ -74,6 +75,7 @@ Parsed contents of a single `summary.json` file.
 - `cpu_threads`  — number of logical CPU threads
 - `ram_gb`       — total system RAM in GiB
 - `total_time_s` — wall-clock duration of the full test run in seconds
+- `solver`       — fully-qualified solver name, e.g. `"DifferentialEquations.Rodas5P"`
 - `models`       — vector of per-model dicts; each has keys
                    `"name"`, `"export"`, `"parse"`, `"sim"`, `"cmp_total"`, `"cmp_pass"`
 """
@@ -92,6 +94,7 @@ struct RunSummary
     cpu_threads  :: Int
     ram_gb       :: Float64
     total_time_s :: Float64
+    solver       :: String
     models       :: Vector{Dict{String,Any}}
 end
 
@@ -150,6 +153,7 @@ function load_summary(results_root::String)::Union{RunSummary,Nothing}
         _int("cpu_threads"),
         _float("ram_gb"),
         _float("total_time_s"),
+        _str("solver"),
         models,
     )
 end

src/types.jl

@@ -46,7 +46,7 @@ Mutable configuration struct for ODE simulation.
 
 # Fields
 - `solver`   — any SciML ODE/DAE algorithm instance.  Default: `nothing`,
-               resolved to `Rodas5Pr()` when the module-level singleton is
+               resolved to `Rodas5P()` when the module-level singleton is
                constructed in `simulate.jl`.
 - `saveat_n` — number of evenly-spaced time points used for purely algebraic
                systems (all mass-matrix rows zero).  Default: `500`.
@@ -79,6 +79,7 @@ Metadata about a single test run, collected by `main()` and written into both
 - `cpu_threads`  — number of logical CPU threads
 - `ram_gb`       — total system RAM in GiB
 - `total_time_s` — wall-clock duration of the full test run in seconds
+- `solver`       — fully-qualified solver name, e.g. `"DifferentialEquations.Rodas5P"`
 """
 struct RunInfo
     library      :: String
@@ -95,6 +96,7 @@ struct RunInfo
     cpu_threads  :: Int
     ram_gb       :: Float64
     total_time_s :: Float64
+    solver       :: String
 end
 
 # ── Result type ────────────────────────────────────────────────────────────────