Merge pull request #340 from JuliaPhysics/multithreaded-tests

Run CI with four Julia threads active

Author: fhagemann

.github/workflows/Downgrade.yml

@@ -1,4 +1,6 @@
 name: Downgrade
+env:
+  JULIA_NUM_THREADS: 4
 on:
   pull_request:
     branches:
@@ -31,3 +33,5 @@ jobs:
           skip: Pkg,TOML
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
+        with:
+          coverage: false

.github/workflows/ci.yml

@@ -10,6 +10,11 @@ on:
   pull_request:
   release:
 
+# needed to allow julia-actions/cache to delete old caches that it has created
+permissions:
+  actions: write
+  contents: read
+
 concurrency:
   # Skip intermediate builds: always.
   # Cancel intermediate builds: only if it is a pull request build.
@@ -20,28 +25,35 @@ jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
     runs-on: ${{ matrix.os }}
+    env:
+      JULIA_NUM_THREADS: ${{ matrix.threads }}
     continue-on-error: ${{ matrix.version == 'pre' }}
     strategy:
       fail-fast: false
       matrix:
         version:
-          - '1.10'
           - '1'
-          - 'pre'
         os:
           - ubuntu-latest
+          - macOS-latest
+          - windows-latest
         arch:
           - x64
+        threads: 
+          - 4
         include:
-          - version: 1
+          - version: '1.10'
             os: ubuntu-latest
-            arch: x86
-          - version: 1
-            os: macOS-latest
             arch: x64
-          - version: 1
-            os: windows-latest
+            threads: '1'
+          - version: pre
+            os: ubuntu-latest
             arch: x64
+            threads: 4
+          - version: '1'
+            os: ubuntu-latest
+            arch: x86
+            threads: 4
     steps:
       - uses: actions/checkout@v4
       - uses: julia-actions/setup-julia@v2
@@ -61,11 +73,11 @@ jobs:
         if: matrix.arch == 'x86'
       - uses: julia-actions/julia-runtest@v1
         with:
-          coverage: ${{ matrix.version == '1' && matrix.os == 'ubuntu-latest' && matrix.arch == 'x64' }}
+          coverage: ${{ matrix.version == '1.10' && matrix.os == 'ubuntu-latest' && matrix.arch == 'x64' }}
       - uses: julia-actions/julia-processcoverage@v1
-        if: matrix.version == '1' && matrix.os == 'ubuntu-latest' && matrix.arch == 'x64'
+        if: matrix.version == '1.10' && matrix.os == 'ubuntu-latest' && matrix.arch == 'x64'
       - uses: codecov/codecov-action@v5
-        if: matrix.version == '1' && matrix.os == 'ubuntu-latest' && matrix.arch == 'x64'
+        if: matrix.version == '1.10' && matrix.os == 'ubuntu-latest' && matrix.arch == 'x64'
         with:
           files: lcov.info
         env:

src/Simulation/Simulation.jl

@@ -962,7 +962,7 @@ function _calculate_potential!( sim::Simulation{T, CS}, potential_type::UnionAll
                 end
                 refine!(sim, ElectricPotential, max_diffs, min_tick_distance)
                 nt = guess_nt ? _guess_optimal_number_of_threads_for_SOR(size(sim.electric_potential.grid), max_nthreads[iref+1], CS) : max_nthreads[iref+1]
-                verbose && println("Grid size: $(size(sim.electric_potential.data)) - $(onCPU ? "using $(nt) threads now" : "GPU"):") 
+                verbose && println("Grid size: $(size(sim.electric_potential.data)) - $(onCPU ? "using $(nt) threads now" : "GPU")") 
                 update_till_convergence!( sim, potential_type, convergence_limit,
                                                 n_iterations_between_checks = n_iterations_between_checks,
                                                 max_n_iterations = max_n_iterations,
@@ -976,7 +976,7 @@ function _calculate_potential!( sim::Simulation{T, CS}, potential_type::UnionAll
                 max_diffs = abs.(ref_limits)
                 refine!(sim, WeightingPotential, contact_id, max_diffs, min_tick_distance)
                 nt = guess_nt ? _guess_optimal_number_of_threads_for_SOR(size(sim.weighting_potentials[contact_id].grid), max_nthreads[iref+1], CS) : max_nthreads[iref+1]
-                verbose && println("Grid size: $(size(sim.weighting_potentials[contact_id].data)) - $(onCPU ? "using $(nt) threads now" : "GPU"):") 
+                verbose && println("Grid size: $(size(sim.weighting_potentials[contact_id].data)) - $(onCPU ? "using $(nt) threads now" : "GPU")") 
                 update_till_convergence!( sim, potential_type, contact_id, convergence_limit,
                                                 n_iterations_between_checks = n_iterations_between_checks,
                                                 max_n_iterations = max_n_iterations,

test/Project.toml

@@ -7,6 +7,7 @@ LegendHDF5IO = "c9265ca6-b027-5446-b1a4-febfa8dd10b0"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 OrderedCollections = "bac558e1-5e72-5ebc-8fee-abe8a469f55d"
 RadiationDetectorSignals = "bf2c0563-65cf-5db2-a620-ceb7de82658c"
+SolidStateDetectors = "71e43887-2bd9-5f77-aebd-47f656f0a3f0"
 SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"

test/runtests.jl

@@ -3,6 +3,8 @@
 using Test
 using SolidStateDetectors
 
+@info "Running tests with $(Base.Threads.nthreads()) Julia threads active."
+
 include("test_utils.jl")
 
 @timed_testset "Comparison to analytic solutions" begin

test/test_real_detectors.jl

@@ -9,7 +9,7 @@ using Unitful
 
 T = Float32
 
-@timed_testset "Simulate example detector: Inverted Coax" begin
+@timed_testset "Inverted Coax" begin
     sim = Simulation{T}(SSD_examples[:InvertedCoax])
     timed_simulate!(sim, convergence_limit = 1e-6, device_array_type = device_array_type, refinement_limits = [0.2, 0.1, 0.05, 0.03, 0.02, 0.01], verbose = false)
     evt = Event(CartesianPoint.([CylindricalPoint{T}(20e-3, deg2rad(10), 10e-3 )]))
@@ -35,7 +35,7 @@ T = Float32
     timed_calculate_electric_potential!(sim, depletion_handling = true)
     @test is_depleted(sim.point_types)
 end
-@timed_testset "Simulate example detector: Inverted Coax (in cryostat)" begin
+@timed_testset "Inverted Coax (in cryostat)" begin
     sim = Simulation{T}(SSD_examples[:InvertedCoaxInCryostat])
     timed_simulate!(sim, convergence_limit = 1e-6, device_array_type = device_array_type, refinement_limits = [0.2, 0.1], verbose = false)
     evt = Event(CartesianPoint.([CylindricalPoint{T}(20e-3, deg2rad(10), 10e-3 )]))
@@ -48,7 +48,7 @@ end
     @info signalsum
     @test isapprox( signalsum, T(2), atol = 5e-3 )
 end
-# @timed_testset "Simulate example detector: Coax" begin
+# @timed_testset "Coax" begin
 #     sim = Simulation{T}(SSD_examples[:Coax])
 #     timed_calculate_electric_potential!(sim, convergence_limit = 1e-6, device_array_type = device_array_type, refinement_limits = [0.2, 0.1], verbose = false)
 #     timed_calculate_electric_field!(sim)
@@ -67,7 +67,7 @@ end
 #     @info signalsum
 #     @test isapprox( signalsum, T(2), atol = 5e-3 )
 # end
-@timed_testset "Simulate example detector: BEGe" begin
+@timed_testset "BEGe" begin
     sim = Simulation{T}(SSD_examples[:BEGe])
     timed_calculate_electric_potential!(sim, convergence_limit = 1e-6, device_array_type = device_array_type, refinement_limits = [0.2, 0.1], verbose = false)
     timed_calculate_electric_field!(sim)
@@ -99,7 +99,7 @@ end
     end
     @test isapprox(timed_estimate_depletion_voltage(sim, verbose = false), 0u"V", atol = 0.2u"V") # This detector has no impurity profile
 end
-@timed_testset "Simulate example detector: HexagonalPrism" begin
+@timed_testset "HexagonalPrism" begin
     sim = Simulation{T}(SSD_examples[:Hexagon])
     timed_simulate!(sim, convergence_limit = 1e-6, device_array_type = device_array_type, refinement_limits = [0.2, 0.1, 0.05, 0.02], verbose = false)
     evt = Event([CartesianPoint{T}(0, 5e-4, 1e-3)])
@@ -113,7 +113,7 @@ end
     @test isapprox( signalsum, T(2), atol = 5e-3 )
     @test isapprox(timed_estimate_depletion_voltage(sim, verbose = false), T(-13.15)*u"V", atol = 1.0u"V") 
 end
-@timed_testset "Simulate example detector: CGD" begin
+@timed_testset "CGD" begin
     sim = Simulation{T}(SSD_examples[:CGD])
     timed_simulate!(sim, convergence_limit = 1e-6, device_array_type = device_array_type, refinement_limits = [0.2, 0.1], verbose = false)
     evt = Event([CartesianPoint{T}(0,2e-3,0)])
@@ -128,7 +128,7 @@ end
     nt = NamedTuple(sim)
     @test sim == Simulation(nt)
 end
-@timed_testset "Simulate example detector: Spherical" begin
+@timed_testset "Spherical" begin
     sim = Simulation{T}(SSD_examples[:Spherical])
     timed_simulate!(sim, convergence_limit = 1e-5, device_array_type = device_array_type, refinement_limits = [0.2, 0.1], verbose = false)
     evt = Event([CartesianPoint{T}(0,0,0)])
@@ -141,7 +141,7 @@ end
     @info signalsum
     @test isapprox( signalsum, T(2), atol = 5e-3 )
 end 
-@timed_testset "Simulate example detector: Toroidal" begin
+@timed_testset "Toroidal" begin
     sim = Simulation{T}(SSD_examples[:CoaxialTorus])
     timed_simulate!(sim, convergence_limit = 1e-5, device_array_type = device_array_type, refinement_limits = [0.2, 0.1, 0.05, 0.02, 0.01], 
         max_tick_distance = 0.5u"mm", verbose = false)
@@ -155,7 +155,7 @@ end
     @info signalsum
     @test isapprox( signalsum, T(2), atol = 5e-3 )
 end
-@timed_testset "Simulate example detector: Coaxial for partial phi range" begin
+@timed_testset "Coaxial for partial phi range" begin
     sim = Simulation{T}(SSD_examples[:Cone2D])
     timed_calculate_electric_potential!(sim, convergence_limit = 1e-6, device_array_type = device_array_type, refinement_limits = missing, verbose = false)
 
@@ -169,7 +169,7 @@ end
     idx = findall(pt -> SolidStateDetectors.is_pn_junction_point_type(pt), sim.point_types.data)
     @test maximum(abs.(sim_alt.electric_potential.data[idx] .- sim.electric_potential.data[idx])) .< T(0.2)
 end
-@timed_testset "Simulate example detector: SigGen PPC" begin
+@timed_testset "SigGen PPC" begin
     sim = Simulation{T}(SSD_examples[:SigGen])
     timed_simulate!(sim, convergence_limit = 1e-6, device_array_type = device_array_type, refinement_limits = [0.2, 0.1], verbose = false)
     evt = Event(CartesianPoint.([CylindricalPoint{T}(20e-3, deg2rad(10), 10e-3 )]))