STY: Run linter checks and add noqa ignore where applicable

ryder-davidson · ryder-davidson · commit 5835a49bb749 · 2026-06-18T11:36:11.000-07:00
diff --git a/examples/01_getting_started/p01_simple_scene.py b/examples/01_getting_started/p01_simple_scene.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 """
 Instantiating a Plot3d Object
 =============================
@@ -12,11 +13,11 @@
 
 # %%
 # .. note::
-#    As stated throughout the **pyvisual** documentation site, it is *highly* recommended to explore the
-#    `PyVista <https://docs.pyvista.org/>`_ documentation to learn about the extensive capabilities
-#    provided by the PyVista and VTK libraries. **pyvisual** is but a thin wrapper around a small
-#    subset of these capabilities, and thus, learning about the underlying libraries will allow you to
-#    make the most of **pyvisual**.
+#    As stated throughout the **pyvisual** documentation site, it is *highly* recommended to
+#    explore the `PyVista <https://docs.pyvista.org/>`_ documentation to learn about the
+#    extensive capabilities provided by the PyVista and VTK libraries. **pyvisual** is but a
+#    thin wrapper around a small subset of these capabilities, and thus, learning about the
+#    underlying libraries will allow you to make the most of **pyvisual**.
 
 # %%
 # The Plot3d class inherits from :class:`~pyvista.Plotter` and, therefore, can be instantiated
@@ -42,9 +43,9 @@
 plotter.show()
 
 # %%
-# By capturing the returned result of the :meth:`~pyvisual.core.plot3d.Plot3d.add_sun` method, we can
-# manipulate the sun actor after it has been added to the scene. For example, we can remove it
-# from the scene and then add it back again.
+# By capturing the returned result of the :meth:`~pyvisual.core.plot3d.Plot3d.add_sun` method,
+# we can manipulate the sun actor after it has been added to the scene. For example, we can
+# remove it from the scene and then add it back again.
 
 # sphinx_gallery_start_ignore
 # NOTE: The following code block can be removed when run outside the sphinx gallery pipeline.
diff --git a/examples/01_getting_started/p02_longlat_lines.py b/examples/01_getting_started/p02_longlat_lines.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 """
 Longitudinal and Latitudinal Lines
 ==================================
diff --git a/examples/01_getting_started/p03_loading_data.py b/examples/01_getting_started/p03_loading_data.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 r"""
 Loading and Plotting MHD Data
 ==============================
diff --git a/examples/02_stack_mesh_mixin/p01_points.py b/examples/02_stack_mesh_mixin/p01_points.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 """
 Plotting Points and Splines
 ============================
diff --git a/examples/02_stack_mesh_mixin/p02_surface.py b/examples/02_stack_mesh_mixin/p02_surface.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 """
 Reconstructing Surfaces
 =======================
diff --git a/examples/02_stack_mesh_mixin/p03_fieldlines.py b/examples/02_stack_mesh_mixin/p03_fieldlines.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 r"""
 Plotting Magnetic Fieldlines
 =============================
diff --git a/examples/03_grid_mesh_mixin/p01_1d_slices.py b/examples/03_grid_mesh_mixin/p01_1d_slices.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 r"""
 1-D Line Slices
 ===============
diff --git a/examples/03_grid_mesh_mixin/p02_2d_slices.py b/examples/03_grid_mesh_mixin/p02_2d_slices.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 r"""
 2-D Surface Slices
 ==================
diff --git a/examples/03_grid_mesh_mixin/p03_contour.py b/examples/03_grid_mesh_mixin/p03_contour.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 """
 Isosurface Contours
 ===================
@@ -73,8 +74,8 @@
 # steady-state Thermodynamic MAS coronal model, we can load in the data
 # using :func:`~psi_io.psi_io.read_hdf_data`.
 
-from psi_data import fetch_mas_data
-from psi_io import read_hdf_data
+from psi_data import fetch_mas_data  # noqa: E402
+from psi_io import read_hdf_data  # noqa: E402
 
 br_file = fetch_mas_data(domains="cor", variables="br").cor_br
 br, r, t, p = read_hdf_data(br_file)
diff --git a/examples/04_observer_mixin/p01_saving_views.py b/examples/04_observer_mixin/p01_saving_views.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 r"""
 Saving and Restoring Camera Views
 ==================================
@@ -51,11 +52,9 @@
 
 saved_position = plotter.observer_position
 saved_orientation = plotter.observer_orientation
-print(
-	f"Saved position    : r={saved_position.r:.2f}, "
-	f"t={saved_position.t:.3f}, p={saved_position.p:.3f}"
-)
-print(f"Saved orientation : p_angle={saved_orientation.p_angle:.2f} deg")
+print(f"Saved position    : r={saved_position.r:.2f}, "		# noqa: T201
+	  f"t={saved_position.t:.3f}, p={saved_position.p:.3f}")
+print(f"Saved orientation : p_angle={saved_orientation.p_angle:.2f} deg")		# noqa: T201
 
 # sphinx_gallery_start_ignore
 # The following block re-instantiates the plotter to avoid the sphinx-gallery
diff --git a/examples/04_observer_mixin/p02_orbit.py b/examples/04_observer_mixin/p02_orbit.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 """
 Camera Orbit Animation
 =======================
diff --git a/examples/04_observer_mixin/p03_los_and_fov_views.py b/examples/04_observer_mixin/p03_los_and_fov_views.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 r"""
 Line-of-Sight and Field-of-View Control
 =========================================
diff --git a/examples/05_geometry_mixin/p01_shells_and_discs.py b/examples/05_geometry_mixin/p01_shells_and_discs.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 """
 Shells and Discs
 ================
@@ -57,7 +58,7 @@
 # radial :math:`\hat{r}` (blue), colatitudinal :math:`\hat{\theta}` (white),
 # and longitudinal :math:`\hat{\phi}` (red).
 
-disc_kwargs = dict(r=2, t=pi / 2, p=0, outer_radius=0.2)
+disc_kwargs = {"r": 2, "t": pi / 2, "p": 0, "outer_radius": 0.2}
 
 plotter = Plot3d()
 plotter.show_axes()
diff --git a/examples/05_geometry_mixin/p02_thompson_sphere.py b/examples/05_geometry_mixin/p02_thompson_sphere.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 r"""
 The Thomson Sphere
 ==================
diff --git a/examples/05_geometry_mixin/p03_grid.py b/examples/05_geometry_mixin/p03_grid.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 """
 Structured Spline Grids
 =======================
diff --git a/examples/06_spherical_grid_class/p01_spherical_grid_init.py b/examples/06_spherical_grid_class/p01_spherical_grid_init.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 """
 Constructing a SphericalMesh
 ============================
@@ -46,11 +47,11 @@
 
 mesh_from_path = SphericalMesh(br_file)
 
-print(f"dimensions : {mesh_from_path.dimensions}")
-print(f"r range    : [{mesh_from_path.r.min():.2f}, {mesh_from_path.r.max():.2f}] R_sun")
-print(f"t range    : [{mesh_from_path.t.min():.4f}, {mesh_from_path.t.max():.4f}] rad")
-print(f"p range    : [{mesh_from_path.p.min():.4f}, {mesh_from_path.p.max():.4f}] rad")
-print(f"data range : [{mesh_from_path.data.min():.4f}, {mesh_from_path.data.max():.4f}] MAS Units")
+print(f"dimensions : {mesh_from_path.dimensions}")  # noqa: T201
+print(f"r range    : [{mesh_from_path.r.min():.2f}, {mesh_from_path.r.max():.2f}] R_sun")   # noqa: T201
+print(f"t range    : [{mesh_from_path.t.min():.4f}, {mesh_from_path.t.max():.4f}] rad") # noqa: T201
+print(f"p range    : [{mesh_from_path.p.min():.4f}, {mesh_from_path.p.max():.4f}] rad") # noqa: T201
+print(f"data range : [{mesh_from_path.data.min():.4f}, {mesh_from_path.data.max():.4f}] MAS Units") # noqa: T201
 
 # %%
 # From Data Arrays
@@ -68,8 +69,8 @@
 mesh_from_arrays = SphericalMesh(r, t, p, data=data, dataid="Br")
 
 # Dimensions and data range are identical to the file-path route.
-print(f"dimensions match : {mesh_from_arrays.dimensions == mesh_from_path.dimensions}")
-print(f"data allclose    : {(mesh_from_arrays.data == mesh_from_path.data).all()}")
+print(f"dimensions match : {mesh_from_arrays.dimensions == mesh_from_path.dimensions}") # noqa: T201
+print(f"data allclose    : {(mesh_from_arrays.data == mesh_from_path.data).all()}") # noqa: T201
 
 # %%
 # From an Existing SphericalMesh
@@ -81,7 +82,7 @@
 
 mesh_from_mesh = SphericalMesh(mesh_from_path)
 
-print(f"dimensions match : {mesh_from_mesh.dimensions == mesh_from_path.dimensions}")
+print(f"dimensions match : {mesh_from_mesh.dimensions == mesh_from_path.dimensions}")       # noqa: T201
 
 # %%
 # Visualising the Mesh
diff --git a/examples/06_spherical_grid_class/p02_arithmetic.py b/examples/06_spherical_grid_class/p02_arithmetic.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 """
 Arithmetic and NumPy Ufunc Support
 ====================================
@@ -27,11 +28,11 @@
 # ------------
 #
 # We initialize a :class:`~pyvisual.core.mesh3d.SphericalMesh` from the HDF file path, which
-# triggers the file-path dispatch path (see :ref:`sphx_glr_gallery_06_spherical_grid_class_p01_spherical_grid_init.py`
-# for details on the three construction paths.
+# triggers the file-path dispatch path (see
+# :ref:`sphx_glr_gallery_06_spherical_grid_class_p01_spherical_grid_init.py` for details on
+# the three construction paths.
 mesh = SphericalMesh(br_file)
-mesh
-
+mesh        # noqa: B018
 # %%
 # Radial Flux Scaling
 # -------------------
@@ -41,8 +42,8 @@
 # arrays are unchanged; only the active scalar is updated.
 
 mesh_r2 = mesh * mesh.r[:, None, None] ** 2
-print(f"Br     range: [{mesh.data.min():.4f}, {mesh.data.max():.4f}]")
-print(f"Br r^2 range: [{mesh_r2.data.min():.4f}, {mesh_r2.data.max():.4f}]")
+print(f"Br     range: [{mesh.data.min():.4f}, {mesh.data.max():.4f}]")      # noqa: T201
+print(f"Br r^2 range: [{mesh_r2.data.min():.4f}, {mesh_r2.data.max():.4f}]")        # noqa: T201
 
 plotter = Plot3d()
 plotter.show_axes()
@@ -63,7 +64,7 @@
 # mesh type.
 
 mesh_log = np.log10(abs(mesh_r2))
-print(f"log10(|Br r^2|) range: [{mesh_log.data.min():.3f}, {mesh_log.data.max():.3f}]")
+print(f"log10(|Br r^2|) range: [{mesh_log.data.min():.3f}, {mesh_log.data.max():.3f}]")     # noqa: T201
 
 plotter = Plot3d()
 plotter.show_axes()
diff --git a/examples/06_spherical_grid_class/p03_filters.py b/examples/06_spherical_grid_class/p03_filters.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 """
 SphericalMesh Filter Methods
 ==============================
@@ -37,13 +38,13 @@
 # :math:`(r, \theta, \phi)` index space and rendered as a semi-transparent volume
 # using a diverging colormap.
 mesh = SphericalMesh(br_file)
-mesh
+mesh		# noqa: B018
 
 # %%
 #
 
 sub_mesh = mesh[120:150, 55:85, 135:165]
-sub_mesh
+sub_mesh		# noqa: B018
 
 plotter = Plot3d()
 plotter.show_axes()
diff --git a/examples/07_cartesian_grid_class/p01_cartesian_grid_init.py b/examples/07_cartesian_grid_class/p01_cartesian_grid_init.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 """
 Constructing a CartesianMesh
 ============================
@@ -37,8 +38,8 @@
 dist = np.sqrt(X**2 + Y**2 + Z**2)
 
 mesh = CartesianMesh(X, Y, Z, data=dist, dataid="r")
-print(f"dimensions : {mesh.dimensions}")
-print(f"data range : [{mesh.data.min():.2f}, {mesh.data.max():.2f}]")
+print(f"dimensions : {mesh.dimensions}")        # noqa: T201
+print(f"data range : [{mesh.data.min():.2f}, {mesh.data.max():.2f}]")       # noqa: T201
 
 plotter = Plot3d()
 plotter.show_axes()
@@ -71,8 +72,8 @@
 cart_struct = sph_mesh.spherical_to_cartesian()
 cart_mesh = CartesianMesh(cart_struct)
 
-print(f"SphericalMesh frame : {sph_mesh.user_dict['MESH_FRAME']}")
-print(f"CartesianMesh frame : {cart_mesh.user_dict['MESH_FRAME']}")
+print(f"SphericalMesh frame : {sph_mesh.user_dict['MESH_FRAME']}")      # noqa: T201
+print(f"CartesianMesh frame : {cart_mesh.user_dict['MESH_FRAME']}")     # noqa: T201
 
 plotter = Plot3d()
 plotter.show_axes()
diff --git a/examples/07_cartesian_grid_class/p02_cart_arithmetic.py b/examples/07_cartesian_grid_class/p02_cart_arithmetic.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 """
 Arithmetic and NumPy Ufunc Support
 ==================================
@@ -35,7 +36,7 @@
 dist = np.sqrt(X**2 + Y**2 + Z**2)
 
 mesh = CartesianMesh(X, Y, Z, data=dist, dataid="r")
-print(f"data range : [{mesh.data.min():.2f}, {mesh.data.max():.2f}]")
+print(f"data range : [{mesh.data.min():.2f}, {mesh.data.max():.2f}]")       # noqa: T201
 
 # %%
 # Scalar Arithmetic
@@ -49,7 +50,7 @@
 
 mesh_shifted = mesh - mesh.data.min()
 mesh_norm = mesh_shifted / mesh_shifted.data.max()
-print(f"normalised range : [{mesh_norm.data.min():.2f}, {mesh_norm.data.max():.2f}]")
+print(f"normalised range : [{mesh_norm.data.min():.2f}, {mesh_norm.data.max():.2f}]")       # noqa: T201
 
 plotter = Plot3d()
 plotter.show_axes()
@@ -69,7 +70,7 @@
 # (here, the grid corner where :math:`r = 0`) are masked by the log.
 
 mesh_log = np.log10(mesh_norm + 1e-6)
-print(f"log10 range : [{mesh_log.data.min():.2f}, {mesh_log.data.max():.2f}]")
+print(f"log10 range : [{mesh_log.data.min():.2f}, {mesh_log.data.max():.2f}]")      # noqa: T201
 
 plotter = Plot3d()
 plotter.show_axes()
diff --git a/examples/07_cartesian_grid_class/p03_cart_filters.py b/examples/07_cartesian_grid_class/p03_cart_filters.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 r"""
 CartesianMesh Filter Methods
 ============================
@@ -52,8 +53,8 @@
 
 cartesian_mesh = CartesianMesh(br_file, iformat="rtp")
 spherical_mesh = SphericalMesh(br_file, iformat="rtp")
-cartesian_mesh
-spherical_mesh
+cartesian_mesh		# noqa: B018
+spherical_mesh		# noqa: B018
 
 # %%
 # Index-based Sub-region Extraction
diff --git a/examples/99_advanced_plots/p01_combining_multiple_elements.py b/examples/99_advanced_plots/p01_combining_multiple_elements.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 """
 Combining Slices, Contours, and Fieldlines
 ==========================================
diff --git a/examples/99_advanced_plots/p03_contour_based_fieldlines.py b/examples/99_advanced_plots/p03_contour_based_fieldlines.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 r"""
 Polarity-Inversion-Line Seeded Fieldlines
 ==========================================
diff --git a/examples/99_advanced_plots/p05_interactive_tracer.py b/examples/99_advanced_plots/p05_interactive_tracer.py
@@ -1,6 +1,7 @@
+# noqa: INP001
 r"""
 Interactive Fieldline Tracer
-=============================
+============================
 
 This example builds a two-panel interactive scene for exploring coronal magnetic
 connectivity.  The top panel displays a longitude–latitude map of :math:`B_r`
diff --git a/examples/99_advanced_plots/p07_faux_volume_render.py b/examples/99_advanced_plots/p07_faux_volume_render.py
@@ -1,3 +1,4 @@
+# noqa: INP001
 """
 Faux Volume Rendering.
 =====================
diff --git a/examples/99_advanced_plots/p09_integrating_mhdweb_p1.py b/examples/99_advanced_plots/p09_integrating_mhdweb_p1.py
diff --git a/examples/99_advanced_plots/p11_integrating_mhdweb_p2.py b/examples/99_advanced_plots/p11_integrating_mhdweb_p2.py
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/pyvisual/core/__init__.py b/pyvisual/core/__init__.py
diff --git a/pyvisual/core/_styling.py b/pyvisual/core/_styling.py
diff --git a/pyvisual/core/_typing.py b/pyvisual/core/_typing.py
diff --git a/pyvisual/core/mesh3d.py b/pyvisual/core/mesh3d.py
diff --git a/pyvisual/core/mixins.py b/pyvisual/core/mixins.py
diff --git a/pyvisual/core/parsers.py b/pyvisual/core/parsers.py
diff --git a/pyvisual/core/plot3d.py b/pyvisual/core/plot3d.py
diff --git a/pyvisual/utils/geometry.py b/pyvisual/utils/geometry.py

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# noqa: INP001`
`1`	`2`	`"""`
`2`	`3`	`Longitudinal and Latitudinal Lines`
`3`	`4`	`==================================`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+# noqa: INP001`
`1`	`2`	`r"""`
`2`	`3`	`Loading and Plotting MHD Data`
`3`	`4`	`==============================`