linter typos

Author: otvam

docs/format/file_geometry_shape.yaml

@@ -40,10 +40,10 @@
         - {"n_layer": 1, "tag_layer": "terminal"}
 
     # definition of the shapes composing the different domains
-    #   - dict with the domain name and a list of shape to be assembled
+    #   - dict with the domain name and a list of shapes to be assembled
     #   - required information, the dict cannot be empty
     #   - domain definition
-    #       - shape_layer: list of layer where the shape is located
+    #       - shape_layer: list of layers where the shape is located
     #       - shape_operation: composition operation for assembling the shape ("add" or "sub")
     #       - shape_type: type of the shape ("pad" or "trace" or "polygon")
     #       - shape_data: data containing the shape geometry

docs/format/file_problem.yaml

@@ -81,15 +81,15 @@
 #                   - "lumped" and "anisotropic": array
 #                       - the array contains the anisotropic parameters
 #                       - the same parameters are used for all the voxels
-#                       - arrays with following size are used: (3)
+#                       - arrays with the following size are used: (3)
 #                   - "distributed" and "isotropic": array
 #                       - the material parameters are isotropic
 #                       - different parameters are used for each voxel
-#                       - arrays with following size are used: (n_voxel)
+#                       - arrays with the following size are used: (n_voxel)
 #                   - "distributed" and "anisotropic": 2D array
 #                       - the material parameters are anisotropic
 #                       - different parameters are used for each voxel
-#                       - arrays with following size are used: (n_voxel, 3)
+#                       - arrays with the following size are used: (n_voxel, 3)
 #           - source_val: source parameters
 #               - dict of dicts with the source name and the source definition
 #               - current source definition
@@ -114,7 +114,7 @@
 #                   - "distributed": array
 #                       - the source is using distributed parameters
 #                       - different parameters are used for each voxel
-#                       - arrays with following size are used: (n_voxel)
+#                       - arrays with the following size are used: (n_voxel)
 "sweep_solver":
     "sim_dc":
         "init": null

examples/config/cfg_data_matplotlib.yaml

@@ -5,4 +5,4 @@
 
 "style": "default"                     # string with a Matplotlib style
 "legend": "best"                       # location of the legend box
-"font": 12                             # reference font size of the figure
+"font": 12                             # reference font size for the figure

examples/config/cfg_data_pyvista.yaml

@@ -16,7 +16,7 @@
     "text_color": "black"              # color of the text elements
     "title_font": 10                   # font size of the title
     "colorbar_font": 15                # font size of the color bar
-    "colorbar_size": 5                 # number of division for the colorbar
+    "colorbar_size": 5                 # number of divisions for the colorbar
     "colorbar_plot": true              # show (or not) the colorbar
     "background_color": "gray"         # background color of the plot
     "axis_add": true                   # add (or not) the axis marker

examples/config/plotter.yaml

@@ -1,6 +1,6 @@
 # PyPEEC options for the plotter renderings.
 #
-# A plot is described with a dictionary with the following fields:
+# A plot is described by a dictionary with the following fields:
 #   - framework: framework used for the rendering ("pyvista" or "matplotlib")
 #   - layout: string describing the plot type (see description below)
 #   - data_window: dictionary describing the plot window
@@ -20,7 +20,7 @@
 #   - "norm_voxel": plot a scalar norm variable on the voxel structure
 #   - "norm_point": plot a scalar norm variable on the point cloud
 #       - title: title located at the corner of the plot (null for hiding)
-#       - legend: legend of variable being shown with the color axis (null for hiding)
+#       - legend: legend being shown with the color axis (null for hiding)
 #       - var: name of the scalar norm variable to be plotted
 #       - scale: scaling of the variable (scaling is done first)
 #       - log: use (or not) a log scale for the color axis
@@ -32,7 +32,7 @@
 #   - "phasor_voxel": plot a scalar phasor variable on the voxel structure
 #   - "phasor_point": plot a scalar phasor variable on the point cloud
 #       - title: title located at the corner of the plot (null for hiding)
-#       - legend: legend of variable being shown with the color axis (null for hiding)
+#       - legend: legend being shown with the color axis (null for hiding)
 #       - var: name of the scalar phasor variable to be plotted
 #       - phase: phase to be considered for the phasor (in radian)
 #       - scale: scaling of the variable (scaling is done first)
@@ -45,7 +45,7 @@
 #   - "arrow_voxel": plot a vector phasor variable on the voxel structure (arrow plot)
 #   - "arrow_point": plot a vector phasor variable on the point cloud (arrow plot)
 #       - title: title located at the corner of the plot (null for hiding)
-#       - legend: legend of variable being shown with the color axis (null for hiding)
+#       - legend: legend being shown with the color axis (null for hiding)
 #       - var: name of the vector phasor variable to be plotted
 #       - phase: phase to be considered for the phasor (in radian)
 #       - scale: scaling of the variable (scaling is done first)
@@ -63,7 +63,7 @@
 #       - marker: plot marker size
 #       - width: plot line width
 #
-#   - "convergence": plot an histogram with the solver residuum (matplotlib)
+#   - "convergence": plot a histogram with the solver residuum (matplotlib)
 #       - title: title located at the top of the plot (null for hiding)
 #       - color_bar: fill color of the bins
 #       - color_edge: "edge color of the bins

examples/config/tolerance.yaml

@@ -12,7 +12,7 @@
 # parallel pool/thread control for the sweeps
 parallel_sweep:
     "n_jobs": 0                        # number of processes (0 for disabling, -1 for number of cores)
-    "n_threads": null                  # number of inner thread per process (None for optimal number)
+    "n_threads": null                  # number of inner threads per process (None for optimal number)
 
 # control where numerical approximations are used for the Green and coupling functions
 #   - if the normalized voxel distance is smaller than the threshold, analytical solutions are used
@@ -29,7 +29,7 @@ parallel_sweep:
     # method for dense matrix multiplication
     #   - "fft" for doing the multiplication with circulant tensors and FFT
     #   - "dense" for standard matrix multiplication with the full matrix
-    #   - "dense" is extremely slow and memory intensive
+    #   - "dense" is extremely slow and memory-intensive (dense matrices)
     #   - "dense" is only useful for debugging and educational purposes
     "method": "fft"
 
@@ -47,7 +47,7 @@ parallel_sweep:
         #   - "SciPy" FFT library is always available (integrated with SciPy)
         #   - "FFTW" has to be installed separately (available through pyFFTW)
         #   - "MKL" has to be installed separately (available through mkl_fft)
-        #   - "CuPy" is extremely fast but require GPUs compatible with the CUDA toolkit.
+        #   - "CuPy" is extremely fast but requires GPUs compatible with the CUDA toolkit.
         "library": "SciPy"
 
         # FFT algorithm options

examples/config/viewer.yaml

@@ -1,6 +1,6 @@
 # PyPEEC options for the viewer renderings.
 #
-# A plot is described with a dictionary with the following fields:
+# A plot is described by a dictionary with the following fields:
 #   - framework: framework used for the rendering ("pyvista" or "matplotlib")
 #   - layout: string describing the plot type (see description below)
 #   - data_window: dictionary describing the plot window
@@ -14,7 +14,7 @@
 #       - colormap: colormap used to plot the different voxel groups
 #       - opacity: opacity of the face color
 #
-#   - "component": plot the connect components of the voxel structure
+#   - "component": plot the connected components of the voxel structure
 #       - title: title located at the corner of the plot (null for hiding)
 #       - colormap: colormap used to plot the different voxel groups
 #       - opacity: opacity of the face color
@@ -28,7 +28,7 @@
 #       - opacity_voxel: face opacity for the voxelized structure
 #       - opacity_reference: face opacity for the reference structure
 #
-#   - "component": plot a matrix showing the connected the domains (matplotlib)
+#   - "component": plot a matrix showing the connected domains (matplotlib)
 #       - title: title located at the top of the plot (null for hiding)
 #       - color_edge: line color between the elements
 #       - color_true: fill color for the true values

examples/tutorial/geometry.yaml

@@ -49,7 +49,7 @@
         - {"n_layer": 1, "tag_layer": "copper_4"}
 
     # definition of the shapes composing the different domains
-    #   - shape_layer: list of layer where the shape is located
+    #   - shape_layer: list of layers where the shape is located
     #   - shape_operation: composition operation for assembling the shape ("add" or "sub")
     #   - shape_type: type of the shape ("pad" or "trace" or "polygon")
     #   - shape_data: data containing the shape geometry

pypeec/lib_plot/manage_matplotlib.py

@@ -7,7 +7,7 @@
 
 For the plotter, the following plots are available:
     - A plot describing the convergence of the matrix solver.
-    - An histogram describing the residuum of the solution.
+    - A histogram describing the residuum of the solution.
 """
 
 __author__ = "Thomas Guillod"