tests: update interactive plots, now not skipped thanks to vtk-osmesa + ignore HTML outputs

Author: elenafuengar

.github/workflows/nightly_tests_CPU.yml

@@ -28,7 +28,8 @@ jobs:
     - name: pip install
       run:  |
         pip install wakis['notebook']
-
+        pip uninstall vtk -y
+        pip install --extra-index-url https://wheels.vtk.org vtk-osmesa
     - name: Print versions
       run: conda list
     - name: Checkout wakis

.gitignore

@@ -7,6 +7,7 @@ FDTD_*
 ECT_*
 */img*
 *.png
+*.html
 *.gif
 *.old*
 *.svg

tests/test_003_planewave_sphere.py

@@ -1,20 +1,24 @@
-import os, sys
-import numpy as np
+import os
+import sys
 import pyvista as pv
 import matplotlib.pyplot as plt
 from scipy.constants import c
 
 sys.path.append('../wakis')
-                
+
 from wakis import SolverFIT3D
-from wakis import GridFIT3D 
+from wakis import GridFIT3D
 from wakis.sources import PlaneWave
 
-import pytest 
+import pytest
 
-flag_interactive = False # Set to true to run PyVista tests
+# Turn False when running local
+flag_offscreen = True
 
 class TestPlanewave:
+
+    img_folder = 'tests/003_img/'
+
     def test_simulation(self):
         print("\n---------- Initializing simulation ------------------")
         # Number of mesh cells
@@ -23,7 +27,7 @@ def test_simulation(self):
         Nz = 120
 
         # Embedded boundaries
-        stl_file = 'tests/stl/003_sphere.stl' 
+        stl_file = 'tests/stl/003_sphere.stl'
         surf = pv.read(stl_file)
 
         stl_solids = {'Sphere': stl_file}
@@ -44,90 +48,75 @@ def test_simulation(self):
         xmax, ymax, zmax = (xmax+padx), (ymax+pady), (zmax+padz)
 
         global grid
-        grid = GridFIT3D(xmin, xmax, ymin, ymax, zmin, zmax, Nx, Ny, Nz, 
-                stl_solids=stl_solids, 
+        grid = GridFIT3D(xmin, xmax, ymin, ymax, zmin, zmax, Nx, Ny, Nz,
+                stl_solids=stl_solids,
                 stl_rotate=stl_rotate,
                 stl_scale=stl_scale,
                 stl_materials=stl_materials)
 
-        # Boundary conditions and 
+        # Boundary conditions and
         bc_low=['periodic', 'periodic', 'pec']
         bc_high=['periodic', 'periodic', 'pml']
-        
+
+        # -------------- Output folder ---------------------
+        if not os.path.exists(self.img_folder):
+            os.mkdir(self.img_folder)
+
         # simulation
         global solver
         solver = SolverFIT3D(grid, use_stl=True, bc_low=bc_low, bc_high=bc_high)
-        
+
         # source
         f = 15/((solver.z.max()-solver.z.min())/c)
-        source = PlaneWave(xs=slice(1, Nx-1), ys=slice(1,Ny-1), zs=1, 
+        source = PlaneWave(xs=slice(1, Nx-1), ys=slice(1,Ny-1), zs=1,
                            f=f, beta=1.0)
-        
+
         Nt = int(1.0*(solver.z.max()-solver.z.min())/c/solver.dt)
         solver.emsolve(Nt, source)
 
-    def test_plot2D(self):
+    def test_plot1D(self):
         global solver
-        solver.plot2D('Ex', plane='ZY', pos=0.5, cmap='rainbow', 
-                    add_patch='Sphere', patch_alpha=0.3, 
-                    off_screen=False)
-        if not flag_interactive:
-            plt.close()
-            
-    def test_plot2D_offscreen(self):
+        solver.plot1D('Ex', line='z', pos=[0.7, 0.6, 0.5, 0.4, 0.3, 0.2],
+                    xscale='linear', yscale='linear',
+                    off_screen=flag_offscreen, n=solver.Nt,
+                    colors=['#5ccfe6', '#fdb6d0', '#ffae57', '#bae67e', '#ffd580', '#a2aabc'],
+                    title=self.img_folder+'1Dplot_Ex')
+
+    def test_plot2D(self):
         global solver
-        solver.plot2D('Hy', plane='ZY', pos=0.5, cmap='bwr', 
+        solver.plot2D('Hy', plane='ZY', pos=0.5, cmap='bwr',
                     add_patch='Sphere', patch_alpha=0.1, interpolation='spline36',
-                    off_screen=True, n=solver.Nt, title='003_2Dplot_Hy') 
-        if not flag_interactive:
-            os.remove(f'003_2Dplot_Hy_{str(solver.Nt).zfill(6)}.png')
-    
-    @pytest.mark.skipif(not flag_interactive, reason="Requires interactive plotting")
+                    off_screen=flag_offscreen, n=solver.Nt,
+                    title=self.img_folder+'2Dplot_Hy')
+
+    @pytest.mark.skipif(flag_offscreen, reason="Requires interactive plotting")
     def test_plot3D_interactive(self):
         global solver
         solver.plot3D(field='E', component='x', cmap='jet',
             add_stl='Sphere', stl_opacity=0.1, stl_colors='white',
             clip_interactive=True, clip_normal='-y',
-            off_screen=False)  
-        
-    @pytest.mark.skipif(not flag_interactive, reason="Requires Xserver connection for plotting")     
+            off_screen=False)
+
     def test_plot3D_offscreen(self):
         global solver
         solver.plot3D(field='H', component='y', cmap='bwr',
                       add_stl='Sphere', stl_opacity=0.1, stl_colors='white',
-                      clip_box=True, clip_bounds=None, 
-                      off_screen=True, title='003_3Dplot_Hy')
-        if not flag_interactive:
-            os.remove('003_3Dplot_Hy.png')
-    
-    @pytest.mark.skipif(not flag_interactive, reason="Requires interactive plotting")
+                      clip_box=True, clip_bounds=None,
+                      off_screen=flag_offscreen, title=self.img_folder+'3Dplot_Hy')
+
+    @pytest.mark.skipif(flag_offscreen, reason="Requires interactive plotting")
     def test_plot3DonSTL_interactive(self):
         global solver
-        solver.plot3DonSTL('Ex', cmap='jet', 
+        solver.plot3DonSTL('Ex', cmap='jet',
                            stl_with_field='Sphere', field_opacity=1.,
                            stl_transparent='Sphere', stl_opacity=0.3, stl_colors='white',
                            clip_interactive=True, clip_normal='-y',
                            off_screen=False, zoom=1.0)
-        
-    @pytest.mark.skipif(not flag_interactive, reason="Requires Xserver connection for plotting")
+
     def test_plot3DonSTL_offscreen(self):
         global solver
-        solver.plot3DonSTL('Ex', cmap='jet', 
+        solver.plot3DonSTL('Ex', cmap='jet',
                            stl_with_field='Sphere', field_opacity=1.,
                            stl_transparent=None, stl_opacity=0., stl_colors=None,
-                           off_screen=True, zoom=1.0, title='003_3DplotOnSTL_Hy')
-        if not flag_interactive:
-            os.remove('003_3DplotOnSTL_Hy.png')
-        
-
-    @pytest.mark.skipif(not flag_interactive, reason="Requires interactive plotting")
-    def test_grid_inspect(self):
-        global grid
-        grid.inspect(add_stl=None, stl_opacity=0.5, stl_colors=None, 
-                     anti_aliasing='ssa')
-
-    @pytest.mark.skipif(not flag_interactive, reason="Requires interactive plotting")
-    def test_grid_plot_solids(self):
-        global grid
-        grid.plot_solids(bounding_box=False, opacity=1.0, specular=0.5,
-                         anti_aliasing=None)
+                           off_screen=flag_offscreen, zoom=1.0,
+                           title=self.img_folder+'3DplotOnSTL_Hy')

tests/test_008_3D_plotting.py

@@ -14,8 +14,7 @@
 
 import pytest
 
-# Turn true when running local
-flag_plot_3D = True
+# Turn False when running local
 flag_offscreen = True
 
 @pytest.mark.slow
@@ -75,7 +74,7 @@ def test_simulation(self):
                     xsource=xs, ysource=ys, ti=ti)
 
         wake = WakeSolver(q=q, sigmaz=sigmaz, beta=beta,
-                         xsource=xs, ysource=ys, ti=ti)  
+                         xsource=xs, ysource=ys, ti=ti)
 
         # ----------- Solver & Simulation ----------
         # boundary conditions
@@ -102,7 +101,6 @@ def test_simulation(self):
             beam.update(solver, n*solver.dt)
             solver.one_step()
 
-    @pytest.mark.skipif(not flag_plot_3D, reason="Requires interactive plotting")
     def test_grid_inspect(self):
         # Plot grid and imported solids
         global solver
@@ -113,7 +111,6 @@ def test_grid_inspect(self):
             #pl.screenshot(self.img_folder+'grid_inspect.png')
             pl.export_html(self.img_folder+'grid_inspect.html')
 
-    @pytest.mark.skipif(not flag_plot_3D, reason="Requires interactive plotting")
     def test_grid_plot_solids(self):
         # Plot only imported solids
         global solver
@@ -124,7 +121,6 @@ def test_grid_plot_solids(self):
                                 smooth_shading=False,
                                 off_screen=flag_offscreen,)
 
-    @pytest.mark.skipif(not flag_plot_3D, reason="Requires interactive plotting")
     def test_grid_stl_mask(self):
         # Plot STL solid masks in the grid
         global solver
@@ -137,7 +133,6 @@ def test_grid_stl_mask(self):
                                   ymax=0.0,
                                   off_screen=flag_offscreen,)
 
-    @pytest.mark.skipif(not flag_plot_3D, reason="Requires interactive plotting")
     def test_solver_inspect(self):
         # Plot imported solids and beam source and integraiton path
         global solver
@@ -148,7 +143,6 @@ def test_solver_inspect(self):
             #pl.screenshot(self.img_folder+'solver_inspect.png')
             pl.export_html(self.img_folder+'solver_inspect.html')
 
-    @pytest.mark.skipif(not flag_plot_3D, reason="Requires interactive plotting")
     def test_plot3D(self):
         # Plot Abs Electric field on domain
         global solver
@@ -159,7 +153,6 @@ def test_plot3D(self):
                 title=self.img_folder+'Ez3d',
                 off_screen=flag_offscreen)
 
-    @pytest.mark.skipif(not flag_plot_3D, reason="Requires interactive plotting")
     def test_plot3DonSTL(self):
         # Plot Abs Electric field on STL solid `cavity`
         global solver