scikit-spatial 8.1.0__tar.gz → 9.0.0__tar.gz

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/HISTORY.rst

@@ -2,12 +2,20 @@
 History
 =======
 
+9.0.0 (2024-12-23)
+------------------
+
+Breaking Changes
+~~~~~~~~~~~~~~~~
+- Make matplotlib an optional dependency. It can be installed by `pip install scikit-spatial[plotting]`
+
+
 8.1.0 (2024-12-23)
 ------------------
 
 Features
 ~~~~~~~~
-- Add optiont to return error for line and plane of best fit.
+- Add option to return error for line and plane of best fit.
 
 
 8.0.0 (2024-10-03)

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scikit-spatial
-Version: 8.1.0
+Version: 9.0.0
 Summary: Spatial objects and computations based on NumPy arrays.
 Project-URL: repository, https://github.com/ajhynes7/scikit-spatial
 Project-URL: documentation, https://scikit-spatial.readthedocs.io
@@ -20,11 +20,12 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.8
-Requires-Dist: matplotlib>=3
 Requires-Dist: numpy>1.24; python_version >= '3.12'
 Requires-Dist: numpy>=1; python_version < '3.12'
 Requires-Dist: scipy>1.11; python_version >= '3.12'
 Requires-Dist: scipy>=1; python_version < '3.12'
+Provides-Extra: plotting
+Requires-Dist: matplotlib>=3; extra == 'plotting'
 Description-Content-Type: text/markdown
 
 ![](images/logo.svg)
@@ -179,6 +180,13 @@ $ conda install scikit-spatial -c conda-forge
 
 ```
 
+The `matplotlib` dependency is optional. To enable plotting, you can install scikit-spatial with the extra `plotting`.
+
+```bash
+   $ pip install scikit-spatial[plotting]
+
+```
+
 # Example Usage
 
 ## Measurement

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/README.md

@@ -150,6 +150,13 @@ $ conda install scikit-spatial -c conda-forge
 
 ```
 
+The `matplotlib` dependency is optional. To enable plotting, you can install scikit-spatial with the extra `plotting`.
+
+```bash
+   $ pip install scikit-spatial[plotting]
+
+```
+
 # Example Usage
 
 ## Measurement

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/docs/source/plotting.rst

@@ -6,6 +6,13 @@ Plotting
 
 This library uses ``matplotlib`` to enable plotting of all of its spatial objects. Each object has a ``plot_2d`` and/or ``plot_3d`` method. For example, a :class:`Point` object can be plotted in 2D or 3D, while a :class:`Sphere` object can only be plotted in 3D.
 
+The ``matplotlib`` dependency is optional. To install it, you can install scikit-spatial with the extra `plotting`.
+
+.. code-block:: console
+
+   $ pip install scikit-spatial[plotting]
+
+
 The ``plot_2d`` methods require an instance of :class:`~matplotlib.axes.Axes` as the first argument, while the ``plot_3d`` methods require an instance of :class:`~mpl_toolkits.mplot3d.axes3d.Axes3D`. This allows for placing multiple spatial objects on the same plot, which is useful for visualizing computations such as projection or intersection.
 
 The methods also pass keyword arguments to ``matplotlib`` functions. For example, ``Point.plot_2d`` uses :meth:`~matplotlib.axes.Axes.scatter` under the hood, so any keyword arguments to :meth:`~matplotlib.axes.Axes.scatter` can also be input to the method. Some plotting methods have additional keyword arguments that are not passed to ``matplotlib``, such as ``Line.plot_2d``, which takes parameters ``t_1`` and ``t_2`` to determine the start and end points of the line.

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/docs/source/requirements.txt

@@ -1,6 +1,6 @@
 Sphinx==5.3.0
 numpydoc==1.5.0
-scikit-spatial==8.1.0
+scikit-spatial[plotting]==9.0.0
 setuptools==70.0.0
 sphinx-bootstrap-theme==0.8.1
 sphinx-gallery==0.9.0

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "scikit-spatial"
-version = "8.1.0"
+version = "9.0.0"
 description = "Spatial objects and computations based on NumPy arrays."
 
 license = { text = "BSD-3-Clause" }
@@ -31,13 +31,15 @@ classifiers = [
 requires-python = ">=3.8"
 
 dependencies = [
-    "matplotlib>=3",
     "numpy>1.24; python_version >= '3.12'",
     "numpy>=1; python_version < '3.12'",
     "scipy>1.11; python_version >= '3.12'",
     "scipy>=1; python_version < '3.12'",
 ]
 
+[project.optional-dependencies]
+plotting = ["matplotlib>=3"]
+
 [project.urls]
 repository = "https://github.com/ajhynes7/scikit-spatial"
 documentation = "https://scikit-spatial.readthedocs.io"

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/src/skspatial/objects/_base_sphere.py

@@ -1,5 +1,7 @@
 """Module for base class of Circle and Sphere."""
 
+from typing import cast
+
 import numpy as np
 
 from skspatial._functions import _contains_point
@@ -85,4 +87,4 @@ class _BaseSphere(_BaseSpatial):
 
         vector_to_point = Vector.from_points(self.point, point)
 
-        return self.point + self.radius * vector_to_point.unit()
+        return cast(Point, self.point + self.radius * vector_to_point.unit())

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/src/skspatial/objects/circle.py

@@ -5,9 +5,7 @@ from __future__ import annotations
 import math
 from typing import Tuple, cast
 
-import matplotlib.pyplot as plt
 import numpy as np
-from matplotlib.axes import Axes
 
 from skspatial._functions import np_float
 from skspatial.objects._base_sphere import _BaseSphere
@@ -368,8 +366,8 @@ class Circle(_BaseSphere):
         point_2 = point_1 + line.direction.unit()
 
         # Translate the points on the line to mimic the circle being centered on the origin.
-        point_translated_1: Point = point_1 - self.point
-        point_translated_2: Point = point_2 - self.point
+        point_translated_1 = point_1 - self.point
+        point_translated_2 = point_2 - self.point
 
         x_1, y_1 = point_translated_1
         x_2, y_2 = point_translated_2
@@ -465,7 +463,7 @@ class Circle(_BaseSphere):
 
         return cls(center, radius)
 
-    def plot_2d(self, ax_2d: Axes, **kwargs) -> None:
+    def plot_2d(self, ax_2d, **kwargs) -> None:
         """
         Plot the circle in 2D.
 
@@ -493,6 +491,8 @@ class Circle(_BaseSphere):
             >>> limits = plt.axis([-10, 10, -10, 10])
 
         """
+        import matplotlib.pyplot as plt
+
         circle = plt.Circle(tuple(self.point), self.radius, **kwargs)
 
         ax_2d.add_artist(circle)

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/src/skspatial/objects/cylinder.py

@@ -7,7 +7,6 @@ from dataclasses import dataclass
 from typing import List, Optional, Tuple, cast
 
 import numpy as np
-from mpl_toolkits.mplot3d import Axes3D
 from scipy.optimize import minimize
 
 from skspatial._functions import _solve_quadratic
@@ -639,7 +638,7 @@ class Cylinder(_BaseSpatial, _ToPointsMixin):
 
         return cls(point_a, vector_ab, radius)
 
-    def plot_3d(self, ax_3d: Axes3D, n_along_axis: int = 100, n_angles: int = 30, **kwargs) -> None:
+    def plot_3d(self, ax_3d, n_along_axis: int = 100, n_angles: int = 30, **kwargs) -> None:
         """
         Plot a 3D cylinder.
 

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/src/skspatial/objects/line.py

@@ -5,14 +5,11 @@ from __future__ import annotations
 from typing import Optional, cast
 
 import numpy as np
-from matplotlib.axes import Axes
-from mpl_toolkits.mplot3d import Axes3D
 
 from skspatial.objects._base_line_plane import _BaseLinePlane
 from skspatial.objects.point import Point
 from skspatial.objects.points import Points
 from skspatial.objects.vector import Vector
-from skspatial.plotting import _connect_points_2d, _connect_points_3d
 from skspatial.transformation import transform_coordinates
 from skspatial.typing import array_like
 
@@ -265,7 +262,7 @@ class Line(_BaseLinePlane):
         """
         vector_along_line = t * self.direction
 
-        return self.point + vector_along_line
+        return cast(Point, self.point + vector_along_line)
 
     def project_point(self, point: array_like) -> Point:
         """
@@ -787,7 +784,7 @@ class Line(_BaseLinePlane):
 
         return column.flatten()
 
-    def plot_2d(self, ax_2d: Axes, t_1: float = 0, t_2: float = 1, **kwargs) -> None:
+    def plot_2d(self, ax_2d, t_1: float = 0, t_2: float = 1, **kwargs) -> None:
         """
         Plot a 2D line.
 
@@ -821,12 +818,14 @@ class Line(_BaseLinePlane):
             >>> grid = ax.grid()
 
         """
+        from skspatial.plotting import _connect_points_2d
+
         point_1 = self.to_point(t_1)
         point_2 = self.to_point(t_2)
 
         _connect_points_2d(ax_2d, point_1, point_2, **kwargs)
 
-    def plot_3d(self, ax_3d: Axes3D, t_1: float = 0, t_2: float = 1, **kwargs) -> None:
+    def plot_3d(self, ax_3d, t_1: float = 0, t_2: float = 1, **kwargs) -> None:
         """
         Plot a 3D line.
 
@@ -862,6 +861,8 @@ class Line(_BaseLinePlane):
             >>> line.point.plot_3d(ax, s=100)
 
         """
+        from skspatial.plotting import _connect_points_3d
+
         point_1 = self.to_point(t_1)
         point_2 = self.to_point(t_2)
 

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/src/skspatial/objects/line_segment.py

@@ -5,14 +5,11 @@ from __future__ import annotations
 import math
 
 import numpy as np
-from matplotlib.axes import Axes
-from mpl_toolkits.mplot3d import Axes3D
 
 from skspatial.objects._base_spatial import _BaseSpatial
 from skspatial.objects.line import Line
 from skspatial.objects.point import Point
 from skspatial.objects.vector import Vector
-from skspatial.plotting import _connect_points_2d, _connect_points_3d
 from skspatial.typing import array_like
 
 
@@ -157,7 +154,7 @@ class LineSegment(_BaseSpatial):
 
         return point_intersection
 
-    def plot_2d(self, ax_2d: Axes, **kwargs) -> None:
+    def plot_2d(self, ax_2d, **kwargs) -> None:
         """
         Plot a 2D line segment.
 
@@ -190,9 +187,11 @@ class LineSegment(_BaseSpatial):
             >>> grid = ax.grid()
 
         """
+        from skspatial.plotting import _connect_points_2d
+
         _connect_points_2d(ax_2d, self.point_a, self.point_b, **kwargs)
 
-    def plot_3d(self, ax_3d: Axes3D, **kwargs) -> None:
+    def plot_3d(self, ax_3d, **kwargs) -> None:
         """
         Plot a 3D line segment.
 
@@ -226,4 +225,6 @@ class LineSegment(_BaseSpatial):
             >>> segment.plot_3d(ax, c='k')
 
         """
+        from skspatial.plotting import _connect_points_3d
+
         _connect_points_3d(ax_3d, self.point_a, self.point_b, **kwargs)

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/src/skspatial/objects/plane.py

@@ -5,7 +5,6 @@ from __future__ import annotations
 from typing import Optional, Tuple, cast
 
 import numpy as np
-from mpl_toolkits.mplot3d import Axes3D
 
 from skspatial.objects._base_line_plane import _BaseLinePlane
 from skspatial.objects._mixins import _ToPointsMixin
@@ -853,7 +852,7 @@ class Plane(_BaseLinePlane, _ToPointsMixin):
 
         return X, Y, Z
 
-    def plot_3d(self, ax_3d: Axes3D, lims_x: array_like = (-1, 1), lims_y: array_like = (-1, 1), **kwargs) -> None:
+    def plot_3d(self, ax_3d, lims_x: array_like = (-1, 1), lims_y: array_like = (-1, 1), **kwargs) -> None:
         """
         Plot a 3D plane.
 

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/src/skspatial/objects/point.py

@@ -1,12 +1,9 @@
 """Module for the Point class."""
 
 import numpy as np
-from matplotlib.axes import Axes
-from mpl_toolkits.mplot3d import Axes3D
 
 from skspatial.objects._base_array import _BaseArray1D
 from skspatial.objects.vector import Vector
-from skspatial.plotting import _scatter_2d, _scatter_3d
 from skspatial.typing import array_like
 
 
@@ -98,7 +95,7 @@ class Point(_BaseArray1D):
 
         return vector.norm()
 
-    def plot_2d(self, ax_2d: Axes, **kwargs) -> None:
+    def plot_2d(self, ax_2d, **kwargs) -> None:
         """
         Plot the point on a 2D scatter plot.
 
@@ -122,9 +119,11 @@ class Point(_BaseArray1D):
             >>> Point([1, 2]).plot_2d(ax, c='k', s=100)
 
         """
+        from skspatial.plotting import _scatter_2d
+
         _scatter_2d(ax_2d, self.reshape(1, -1), **kwargs)
 
-    def plot_3d(self, ax_3d: Axes3D, **kwargs) -> None:
+    def plot_3d(self, ax_3d, **kwargs) -> None:
         """
         Plot the point on a 3D scatter plot.
 
@@ -151,4 +150,6 @@ class Point(_BaseArray1D):
             >>> Point([1, 2, 3]).plot_3d(ax, c='k', s=100)
 
         """
+        from skspatial.plotting import _scatter_3d
+
         _scatter_3d(ax_3d, self.reshape(1, -1), **kwargs)

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/src/skspatial/objects/points.py

@@ -5,13 +5,10 @@ from __future__ import annotations
 from typing import cast
 
 import numpy as np
-from matplotlib.axes import Axes
-from mpl_toolkits.mplot3d import Axes3D
 from numpy.linalg import matrix_rank
 
 from skspatial.objects._base_array import _BaseArray2D
 from skspatial.objects.point import Point
-from skspatial.plotting import _scatter_2d, _scatter_3d
 
 
 class Points(_BaseArray2D):
@@ -149,7 +146,7 @@ class Points(_BaseArray2D):
 
         """
         centroid = self.centroid()
-        points_centered: Points = self - centroid
+        points_centered = self - centroid
 
         if return_centroid:
             return points_centered, centroid
@@ -325,7 +322,7 @@ class Points(_BaseArray2D):
         """
         return bool(self.affine_rank(**kwargs) <= 2)
 
-    def plot_2d(self, ax_2d: Axes, **kwargs) -> None:
+    def plot_2d(self, ax_2d, **kwargs) -> None:
         """
         Plot the points on a 2D scatter plot.
 
@@ -350,9 +347,11 @@ class Points(_BaseArray2D):
             >>> points.plot_2d(ax, c='k')
 
         """
+        from skspatial.plotting import _scatter_2d
+
         _scatter_2d(ax_2d, self, **kwargs)
 
-    def plot_3d(self, ax_3d: Axes3D, **kwargs) -> None:
+    def plot_3d(self, ax_3d, **kwargs) -> None:
         """
         Plot the points on a 3D scatter plot.
 
@@ -380,4 +379,6 @@ class Points(_BaseArray2D):
             >>> points.plot_3d(ax, s=75, depthshade=False)
 
         """
+        from skspatial.plotting import _scatter_3d
+
         _scatter_3d(ax_3d, self, **kwargs)

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/src/skspatial/objects/sphere.py

@@ -6,7 +6,6 @@ import math
 from typing import Tuple
 
 import numpy as np
-from mpl_toolkits.mplot3d import Axes3D
 
 from skspatial._functions import np_float
 from skspatial.objects._base_sphere import _BaseSphere
@@ -301,7 +300,7 @@ class Sphere(_BaseSphere, _ToPointsMixin):
 
         return X, Y, Z
 
-    def plot_3d(self, ax_3d: Axes3D, n_angles: int = 30, **kwargs) -> None:
+    def plot_3d(self, ax_3d, n_angles: int = 30, **kwargs) -> None:
         """
         Plot the sphere in 3D.
 

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/src/skspatial/objects/triangle.py

@@ -5,8 +5,6 @@ from itertools import combinations
 from typing import Sequence
 
 import numpy as np
-from matplotlib.axes import Axes
-from mpl_toolkits.mplot3d import Axes3D
 
 from skspatial._functions import np_float
 from skspatial.objects._base_spatial import _BaseSpatial
@@ -631,7 +629,7 @@ class Triangle(_BaseSpatial):
 
         return math.isclose(a**2 + b**2, c**2, **kwargs)
 
-    def plot_2d(self, ax_2d: Axes, part: str = 'points', **kwargs: str) -> None:
+    def plot_2d(self, ax_2d, part: str = 'points', **kwargs: str) -> None:
         """
         Plot a triangle in 2D.
 
@@ -670,7 +668,7 @@ class Triangle(_BaseSpatial):
             for line in self.multiple('line', 'abc'):
                 line.plot_2d(ax_2d, **kwargs)
 
-    def plot_3d(self, ax_3d: Axes3D, part: str = 'points', **kwargs: str) -> None:
+    def plot_3d(self, ax_3d, part: str = 'points', **kwargs: str) -> None:
         """
         Plot a triangle in 3D.
 

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/src/skspatial/objects/vector.py

@@ -6,12 +6,9 @@ import math
 from typing import cast
 
 import numpy as np
-from matplotlib.axes import Axes
-from mpl_toolkits.mplot3d import Axes3D
 
 from skspatial._functions import np_float
 from skspatial.objects._base_array import _BaseArray1D
-from skspatial.plotting import _connect_points_3d
 from skspatial.typing import array_like
 
 
@@ -759,7 +756,7 @@ class Vector(_BaseArray1D):
 
         return vector_different_direction
 
-    def plot_2d(self, ax_2d: Axes, point: array_like = (0, 0), scalar: float = 1, **kwargs) -> None:
+    def plot_2d(self, ax_2d, point: array_like = (0, 0), scalar: float = 1, **kwargs) -> None:
         """
         Plot a 2D vector.
 
@@ -796,7 +793,7 @@ class Vector(_BaseArray1D):
 
         ax_2d.arrow(x, y, dx, dy, **kwargs)
 
-    def plot_3d(self, ax_3d: Axes3D, point: array_like = (0, 0, 0), scalar: float = 1, **kwargs) -> None:
+    def plot_3d(self, ax_3d, point: array_like = (0, 0, 0), scalar: float = 1, **kwargs) -> None:
         """
         Plot a 3D vector.
 
@@ -830,6 +827,8 @@ class Vector(_BaseArray1D):
             >>> Vector([-1, 1, 1]).plot_3d(ax, point=(1, 2, 3), c='r')
 
         """
+        from skspatial.plotting import _connect_points_3d
+
         point_2 = np.array(point) + scalar * self
 
         _connect_points_3d(ax_3d, point, point_2, **kwargs)

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/src/skspatial/plotting.py

@@ -2,10 +2,19 @@
 
 from typing import Callable, Tuple
 
-import matplotlib.pyplot as plt
 import numpy as np
-from matplotlib.axes import Axes
-from mpl_toolkits.mplot3d import Axes3D
+
+try:
+    import matplotlib.pyplot as plt
+    from matplotlib.axes import Axes
+    from mpl_toolkits.mplot3d import Axes3D
+except ImportError as error:
+    raise ImportError(
+        "Matplotlib is required for plotting.\n"
+        "Install scikit-spatial with plotting support: "
+        "pip install 'scikit-spatial[plotting]'",
+    ) from error
+
 
 from skspatial.typing import array_like
 

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/tox.ini

@@ -24,7 +24,8 @@ commands =
 
 [testenv:type]
 deps =
-    mypy==1.11.2
+    matplotlib==3.10.1
+    mypy==1.15.0
 commands =
     mypy src/
 
@@ -33,12 +34,16 @@ commands =
     python -m doctest README.md
 
 [testenv:doctests]
+deps =
+    pytest==8.3.3
+    matplotlib==3.10.1
 commands =
     pytest --doctest-modules src/
 
 [testenv:docs]
 deps =
     Sphinx==5.3.0
+    matplotlib==3.10.1
     numpydoc==1.5.0
     setuptools==69.0.3
     sphinx-bootstrap-theme==0.8.1

{scikit_spatial-8.1.0 → scikit_spatial-9.0.0}/uv.lock

@@ -757,13 +757,17 @@ name = "scikit-spatial"
 version = "8.1.0"
 source = { editable = "." }
 dependencies = [
-    { name = "matplotlib" },
     { name = "numpy", version = "1.24.4", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.12'" },
     { name = "numpy", version = "1.26.4", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.12'" },
     { name = "scipy", version = "1.10.1", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.12'" },
     { name = "scipy", version = "1.14.1", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.12'" },
 ]
 
+[package.optional-dependencies]
+plotting = [
+    { name = "matplotlib" },
+]
+
 [package.dev-dependencies]
 dev = [
     { name = "mypy" },
@@ -774,7 +778,7 @@ dev = [
 
 [package.metadata]
 requires-dist = [
-    { name = "matplotlib", specifier = ">=3" },
+    { name = "matplotlib", marker = "extra == 'plotting'", specifier = ">=3" },
     { name = "numpy", marker = "python_full_version < '3.12'", specifier = ">=1" },
     { name = "numpy", marker = "python_full_version >= '3.12'", specifier = ">1.24" },
     { name = "scipy", marker = "python_full_version < '3.12'", specifier = ">=1" },