ScadPy 0.4.9__tar.gz → 0.4.11__tar.gz

{scadpy-0.4.9 → scadpy-0.4.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ScadPy
-Version: 0.4.9
+Version: 0.4.11
 Summary: Simplified 2D/3D modeling for Python with fluent API and boolean operations
 Author: m-fabregue
 License: # MIT License
@@ -51,6 +51,8 @@ Keywords: 2d,3d,modeling,python,scad,shape,solid
 Classifier: Development Status :: 3 - Alpha
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.12
 Requires-Dist: ipython~=8.30
 Requires-Dist: manifold3d==3.2.1

{scadpy-0.4.9 → scadpy-0.4.11}/docs/_static/badges/coverage.svg

@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" width="114" height="20" role="img" aria-label="coverage: 90.32%"><title>coverage: 90.32%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="114" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="61" height="20" fill="#555"/><rect x="61" width="53" height="20" fill="#4c1"/><rect width="114" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">coverage</text><text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="510">coverage</text><text aria-hidden="true" x="865" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">90.32%</text><text x="865" y="140" transform="scale(.1)" fill="#fff" textLength="430">90.32%</text></g></svg>
+<svg xmlns="http://www.w3.org/2000/svg" width="114" height="20" role="img" aria-label="coverage: 90.87%"><title>coverage: 90.87%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="114" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="61" height="20" fill="#555"/><rect x="61" width="53" height="20" fill="#4c1"/><rect width="114" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">coverage</text><text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="510">coverage</text><text aria-hidden="true" x="865" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">90.87%</text><text x="865" y="140" transform="scale(.1)" fill="#fff" textLength="430">90.87%</text></g></svg>

{scadpy-0.4.9 → scadpy-0.4.11}/docs/_static/badges/interrogate.svg

@@ -1,10 +1,10 @@
 <svg width="140" height="20" viewBox="0 0 140 20" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
-    <title>interrogate: 88.5%</title>
+    <title>interrogate: 90.8%</title>
     <g transform="matrix(1,0,0,1,22,0)">
         <g id="backgrounds" transform="matrix(1.32789,0,0,1,-22.3892,0)">
             <rect x="0" y="0" width="71" height="20" style="fill:rgb(85,85,85);"/>
         </g>
-        <rect x="71" y="0" width="47" height="20" data-interrogate="color" style="fill:#a4a61d"/>
+        <rect x="71" y="0" width="47" height="20" data-interrogate="color" style="fill:#97CA00"/>
         <g transform="matrix(1.19746,0,0,1,-22.3744,-4.85723e-16)">
             <rect x="0" y="0" width="118" height="20" style="fill:url(#_Linear1);"/>
         </g>
@@ -12,8 +12,8 @@
     <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110">
         <text x="590" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="610">interrogate</text>
         <text x="590" y="140" transform="scale(.1)" textLength="610">interrogate</text>
-        <text x="1160" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="370" data-interrogate="result">88.5%</text>
-        <text x="1160" y="140" transform="scale(.1)" textLength="370" data-interrogate="result">88.5%</text>
+        <text x="1160" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="370" data-interrogate="result">90.8%</text>
+        <text x="1160" y="140" transform="scale(.1)" textLength="370" data-interrogate="result">90.8%</text>
     </g>
     <g id="logo-shadow" serif:id="logo shadow" transform="matrix(0.854876,0,0,0.854876,-6.73514,1.732)">
         <g transform="matrix(0.299012,0,0,0.299012,9.70229,-6.68582)">

{scadpy-0.4.9 → scadpy-0.4.11}/docs/index.rst

@@ -349,3 +349,4 @@ API reference
    core <scadpy/core>
    2D <scadpy/d2>
    3D <scadpy/d3>
+   Utils <scadpy/utils>

scadpy-0.4.11/docs/scadpy/utils.rst

@@ -0,0 +1,7 @@
+Utils
+=====
+
+.. automodule:: scadpy.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:

scadpy-0.4.11/docs/snapshots/d2__examples_honeycomb_extruded_plate__dark.md5

@@ -0,0 +1 @@
+35751c3d101175d0b4164962b4d98770

scadpy-0.4.11/docs/snapshots/d2__examples_honeycomb_extruded_plate__light.md5

@@ -0,0 +1 @@
+8be86cd80b46396a612534f76dd1cce2

scadpy-0.4.11/docs/snapshots/d2__examples_labelized_extruded_plate__dark.md5

@@ -0,0 +1 @@
+76290d54b58103661563c924992aa4e0

scadpy-0.4.11/docs/snapshots/d2__examples_labelized_extruded_plate__light.md5

@@ -0,0 +1 @@
+22b718f12b986038e9a8d6dcf2125390

scadpy-0.4.11/docs/snapshots/d2__index_extruded_plate__dark.md5

@@ -0,0 +1 @@
+76290d54b58103661563c924992aa4e0

scadpy-0.4.11/docs/snapshots/d2__index_extruded_plate__light.md5

@@ -0,0 +1 @@
+22b718f12b986038e9a8d6dcf2125390

scadpy-0.4.11/docs/snapshots/d2__linear_extrude_shape_square__dark.md5

@@ -0,0 +1 @@
+c29c4a3b8a0d202b7b89028a76224935

scadpy-0.4.11/docs/snapshots/d2__linear_extrude_shape_square__light.md5

@@ -0,0 +1 @@
+b198932e5af8f1ad4310b539fa017207

scadpy-0.4.11/docs/snapshots/d2__linear_extrude_shape_tapered__dark.md5

@@ -0,0 +1 @@
+1e8f7ff480bc0bd198f531b9e2c113a9

scadpy-0.4.11/docs/snapshots/d2__linear_extrude_shape_tapered__light.md5

@@ -0,0 +1 @@
+0a8df25e8c32483e0c4b21fc498042a0

scadpy-0.4.11/docs/snapshots/d2__linear_extrude_shape_tube__dark.md5

@@ -0,0 +1 @@
+40c515645834220f1f25982b5c5effb1

scadpy-0.4.11/docs/snapshots/d2__linear_extrude_shape_tube__light.md5

@@ -0,0 +1 @@
+cb561effd51ae3f9a59501760e35ef5a

scadpy-0.4.11/docs/snapshots/d2__path_extrude_shape_tube__dark.md5

@@ -0,0 +1 @@
+3da57c1436d736a4a83843730280dc5d

scadpy-0.4.11/docs/snapshots/d2__path_extrude_shape_tube__light.md5

@@ -0,0 +1 @@
+86362ce9fdb0c1d20bbdd53b16cca509

scadpy-0.4.11/docs/snapshots/d2__path_extrude_shape_tube_strategy__dark.md5

@@ -0,0 +1 @@
+ba61ad5d75f391a3dd59fa62387761dc

scadpy-0.4.11/docs/snapshots/d2__path_extrude_shape_tube_strategy__light.md5

@@ -0,0 +1 @@
+86d69e5c16b4e22df86a58b687c74c0c

{scadpy-0.4.9 → scadpy-0.4.11}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "ScadPy"
-version = "0.4.9"
+version = "0.4.11"
 description = "Simplified 2D/3D modeling for Python with fluent API and boolean operations"
 requires-python = ">= 3.12"
 authors = [{ name = "m-fabregue" }]
@@ -15,6 +15,8 @@ classifiers = [
     "Development Status :: 3 - Alpha",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
 ]
 dependencies = ["trimesh[easy] ~= 4.10", "manifold3d == 3.2.1", "ipython ~= 8.30", "matplotlib == 3.10.6", "python-fcl ~= 0.7"]
 

{scadpy-0.4.9 → scadpy-0.4.11}/scadpy/d2/shape/transformations/path_extrude_shape.py

@@ -279,7 +279,7 @@ def _compute_rmf_frames(
     if abs(float(np.dot(initial_tangent, up))) > 0.9:
         up = np.array([0.0, 1.0, 0.0])
     initial_normal: NDArray[np.float64] = np.asarray(
-        np.cross(initial_tangent, up), dtype=np.float64
+        np.cross(up, initial_tangent), dtype=np.float64
     )
     initial_normal /= float(np.linalg.norm(initial_normal))
 

{scadpy-0.4.9 → scadpy-0.4.11}/scadpy/d2/shape/types/shape.py

@@ -20,11 +20,44 @@ if TYPE_CHECKING:
 
 @final
 class Shape(Assembly[Polygon]):
+    """A 2D assembly of :class:`~shapely.geometry.Polygon` parts.
+
+    ``Shape`` is the central 2D modeling object in ScadPy.  It wraps one or
+    more colored Shapely polygons and exposes a fluent API for boolean
+    operations, geometric transforms, topology queries, and 2D→3D extrusions.
+
+    Use the primitives (:func:`~scadpy.circle`, :func:`~scadpy.rectangle`,
+    :func:`~scadpy.square`, …) or importers (:meth:`Shape.from_dxf`,
+    :meth:`Shape.from_svg`) to create shapes; do not instantiate this class
+    directly.
+
+    Examples
+    --------
+    >>> from scadpy import circle, square
+    >>> s = square(4) - circle(1)
+    >>> s.is_empty
+    False
+    """
+
     def __init__(self, *args: Any, **kwargs: Any) -> None:  # pyright: ignore[reportExplicitAny, reportAny]
+        """Initialize a Shape (internal — use primitives instead)."""
         super().__init__(*args, **kwargs)
 
     @classmethod
     def dimensions(cls) -> int:
+        """Return the number of spatial dimensions: always ``2``.
+
+        Returns
+        -------
+        int
+            Always ``2``.
+
+        Examples
+        --------
+        >>> from scadpy import Shape
+        >>> Shape.dimensions()
+        2
+        """
         return 2
 
     ##########

{scadpy-0.4.9 → scadpy-0.4.11}/scadpy/d3/solid/features/get_solid_centroid.py

@@ -24,10 +24,13 @@ def get_solid_centroid(solid: Solid) -> NDArray[np.float64]:
 
     Examples
     --------
-    >>> from scadpy import cuboid
+    >>> from scadpy import cuboid, Solid
 
     >>> cuboid(2).centroid
     array([0., 0., 0.])
+
+    >>> Solid.from_parts([]).centroid
+    array([0., 0., 0.])
     """
     parts = solid._parts  # pyright: ignore[reportPrivateUsage]
     if not parts:

{scadpy-0.4.9 → scadpy-0.4.11}/scadpy/d3/solid/types/solid.py

@@ -24,11 +24,43 @@ from scadpy.core.assembly import Assembly
 
 @final
 class Solid(Assembly[Trimesh]):
+    """A 3D assembly of :class:`~trimesh.Trimesh` parts.
+
+    ``Solid`` is the central 3D modeling object in ScadPy.  It wraps one or
+    more colored Trimesh meshes and exposes a fluent API for boolean
+    operations, geometric transforms, topology queries, and 3D export.
+
+    Use the primitives (:func:`~scadpy.cuboid`, :func:`~scadpy.cylinder`,
+    :func:`~scadpy.sphere`, …) or importers (:meth:`Solid.from_stl`) to
+    create solids; do not instantiate this class directly.
+
+    Examples
+    --------
+    >>> from scadpy import cuboid, sphere
+    >>> s = cuboid(4) - sphere(3)
+    >>> s.is_empty
+    False
+    """
+
     def __init__(self, *args: Any, **kwargs: Any) -> None:  # pyright: ignore[reportExplicitAny, reportAny]
+        """Initialize a Solid (internal — use primitives instead)."""
         super().__init__(*args, **kwargs)
 
     @classmethod
     def dimensions(cls) -> int:
+        """Return the number of spatial dimensions: always ``3``.
+
+        Returns
+        -------
+        int
+            Always ``3``.
+
+        Examples
+        --------
+        >>> from scadpy import Solid
+        >>> Solid.dimensions()
+        3
+        """
         return 3
 
     ##########
@@ -205,7 +237,14 @@ class Solid(Assembly[Trimesh]):
         return unify_solid(solids=[self, other])
 
     def __and__(self: Self, other: Solid) -> Solid:
-        """Intersect two solids. Shortcut for :func:`intersect_solid`."""
+        """Intersect two solids. Shortcut for :func:`intersect_solid`.
+
+        Examples
+        --------
+        >>> from scadpy import cuboid, sphere
+        >>> (cuboid(4) & sphere(3)).is_empty
+        False
+        """
         from scadpy import intersect_solid
 
         return intersect_solid(solids=[self, other])
@@ -217,7 +256,14 @@ class Solid(Assembly[Trimesh]):
         return subtract_solid(to_be_subtracted=self, to_subtract=other)
 
     def __xor__(self: Self, other: Solid) -> Solid:
-        """Compute symmetric difference with another solid. Shortcut for :func:`exclude_solid`."""
+        """Compute symmetric difference with another solid. Shortcut for :func:`exclude_solid`.
+
+        Examples
+        --------
+        >>> from scadpy import cuboid, sphere
+        >>> (cuboid(4) ^ sphere(3)).is_empty
+        False
+        """
         from scadpy import exclude_solid
 
         return exclude_solid(solids=[self, other])
@@ -658,6 +704,27 @@ class Solid(Assembly[Trimesh]):
 
     @classmethod
     def from_parts(cls, parts: Sequence[Part[Trimesh]]) -> Solid:
+        """Assemble a :class:`Solid` from a sequence of :class:`~scadpy.Part`.
+
+        This is the low-level constructor used internally.  In most cases you
+        should use primitives or boolean operations instead.
+
+        Parameters
+        ----------
+        parts : Sequence[Part[Trimesh]]
+            The parts that make up the solid.
+
+        Returns
+        -------
+        Solid
+            A new solid containing exactly the given parts.
+
+        Examples
+        --------
+        >>> from scadpy import Solid
+        >>> Solid.from_parts([]).is_empty
+        True
+        """
         solid = Solid()
         solid._parts = parts
         return solid

scadpy-0.4.11/scadpy/utils/x.py

@@ -0,0 +1,32 @@
+import numpy as np
+from numpy.typing import NDArray
+
+
+def x(n: float = 1) -> NDArray[np.float64]:
+    """Create a vector with ``n`` on the X-axis and ``nan`` on Y and Z.
+
+    ``nan`` acts as a sentinel meaning "keep the current value" when this
+    vector is passed to transforms such as :func:`~scadpy.translate_shape` or
+    :func:`~scadpy.rotate_solid`.  Only the X component is specified; the
+    other axes are left untouched.
+
+    Parameters
+    ----------
+    n : float
+        The value of the X component.  Default is ``1``.
+
+    Returns
+    -------
+    NDArray[np.float64]
+        A NumPy array of shape ``(3,)`` representing ``[n, nan, nan]``.
+
+    Examples
+    --------
+    >>> from scadpy import x
+    >>> x(5)
+    array([ 5., nan, nan])
+
+    >>> x(-2.3)
+    array([-2.3,  nan,  nan])
+    """
+    return np.array([n, np.nan, np.nan], dtype=np.float64)

scadpy-0.4.11/scadpy/utils/y.py

@@ -0,0 +1,32 @@
+import numpy as np
+from numpy.typing import NDArray
+
+
+def y(n: float = 1) -> NDArray[np.float64]:
+    """Create a vector with ``n`` on the Y-axis and ``nan`` on X and Z.
+
+    ``nan`` acts as a sentinel meaning "keep the current value" when this
+    vector is passed to transforms such as :func:`~scadpy.translate_shape` or
+    :func:`~scadpy.rotate_solid`.  Only the Y component is specified; the
+    other axes are left untouched.
+
+    Parameters
+    ----------
+    n : float
+        The value of the Y component.  Default is ``1``.
+
+    Returns
+    -------
+    NDArray[np.float64]
+        A NumPy array of shape ``(3,)`` representing ``[nan, n, nan]``.
+
+    Examples
+    --------
+    >>> from scadpy import y
+    >>> y(5)
+    array([nan,  5., nan])
+
+    >>> y(-2.3)
+    array([ nan, -2.3,  nan])
+    """
+    return np.array([np.nan, n, np.nan], dtype=np.float64)

scadpy-0.4.11/scadpy/utils/z.py

@@ -0,0 +1,32 @@
+import numpy as np
+from numpy.typing import NDArray
+
+
+def z(n: float = 1) -> NDArray[np.float64]:
+    """Create a vector with ``n`` on the Z-axis and ``nan`` on X and Y.
+
+    ``nan`` acts as a sentinel meaning "keep the current value" when this
+    vector is passed to transforms such as :func:`~scadpy.translate_shape` or
+    :func:`~scadpy.rotate_solid`.  Only the Z component is specified; the
+    other axes are left untouched.
+
+    Parameters
+    ----------
+    n : float
+        The value of the Z component.  Default is ``1``.
+
+    Returns
+    -------
+    NDArray[np.float64]
+        A NumPy array of shape ``(3,)`` representing ``[nan, nan, n]``.
+
+    Examples
+    --------
+    >>> from scadpy import z
+    >>> z(5)
+    array([nan, nan,  5.])
+
+    >>> z(-2.3)
+    array([ nan,  nan, -2.3])
+    """
+    return np.array([np.nan, np.nan, n], dtype=np.float64)

scadpy-0.4.9/docs/snapshots/d2__examples_honeycomb_extruded_plate__dark.md5

@@ -1 +0,0 @@
-99004d895b5bc523ed16f8ec12ba22d1

scadpy-0.4.9/docs/snapshots/d2__examples_honeycomb_extruded_plate__light.md5

@@ -1 +0,0 @@
-62e718d1417c78e66d7d083f86e7f624

scadpy-0.4.9/docs/snapshots/d2__examples_labelized_extruded_plate__dark.md5

@@ -1 +0,0 @@
-335e9795a8fbcaf739c45a02dfe98ec7

scadpy-0.4.9/docs/snapshots/d2__examples_labelized_extruded_plate__light.md5

@@ -1 +0,0 @@
-1b92030fa5c7114c9d72077830d922b1

scadpy-0.4.9/docs/snapshots/d2__index_extruded_plate__dark.md5

@@ -1 +0,0 @@
-335e9795a8fbcaf739c45a02dfe98ec7

scadpy-0.4.9/docs/snapshots/d2__index_extruded_plate__light.md5

@@ -1 +0,0 @@
-1b92030fa5c7114c9d72077830d922b1

scadpy-0.4.9/docs/snapshots/d2__linear_extrude_shape_square__dark.md5

@@ -1 +0,0 @@
-c8ac4547119b9d02568a7e450f0709e9

scadpy-0.4.9/docs/snapshots/d2__linear_extrude_shape_square__light.md5

@@ -1 +0,0 @@
-c58007b42f16282da85fff8ac7c0f163

scadpy-0.4.9/docs/snapshots/d2__linear_extrude_shape_tapered__dark.md5

@@ -1 +0,0 @@
-26acb0322b6f8ca51af83a1e17d64175

scadpy-0.4.9/docs/snapshots/d2__linear_extrude_shape_tapered__light.md5

@@ -1 +0,0 @@
-fe3cc29f355d3fd1acad894b8e58886c

scadpy-0.4.9/docs/snapshots/d2__linear_extrude_shape_tube__dark.md5

@@ -1 +0,0 @@
-bcb7da7e3778f8c6dbd7400919ae670e

scadpy-0.4.9/docs/snapshots/d2__linear_extrude_shape_tube__light.md5

@@ -1 +0,0 @@
-4fea9af99cf5affce1d67ce8a31ea8be

scadpy-0.4.9/docs/snapshots/d2__path_extrude_shape_tube__dark.md5

@@ -1 +0,0 @@
-08e3418e7eeaf554cafdef289f92022f

scadpy-0.4.9/docs/snapshots/d2__path_extrude_shape_tube__light.md5

@@ -1 +0,0 @@
-c65baffbed5e0f6ac4637ad76dab72c0

scadpy-0.4.9/docs/snapshots/d2__path_extrude_shape_tube_strategy__dark.md5

@@ -1 +0,0 @@
-828a594e649bd7caf50205e4f9e88045

scadpy-0.4.9/docs/snapshots/d2__path_extrude_shape_tube_strategy__light.md5

@@ -1 +0,0 @@
-21c416c7837e82a71bdb4b69a1e2b30f

scadpy-0.4.9/scadpy/utils/x.py

@@ -1,36 +0,0 @@
-import numpy as np
-from numpy.typing import NDArray
-
-
-def x(n: float = 1) -> NDArray[np.float64]:
-    """
-    Creates a 3D vector along the X-axis.
-
-    Parameters
-    ----------
-    n : float
-        The value of the X component. The Y and Z components are set to 0.
-
-    Returns
-    -------
-    NDArray[np.float64]
-        A NumPy array of shape (3,) representing the vector `[n, 0, 0]`.
-
-    Notes
-    -----
-    - The resulting array always has 3 elements.
-    - The dtype of the array is `np.float64`.
-
-    Examples
-    --------
-    >>> from scadpy import x
-    >>> x(5)
-    array([5., 0., 0.])
-
-    >>> x(-2.3)
-    array([-2.3,  0. ,  0. ])
-
-    >>> x(0)
-    array([0., 0., 0.])
-    """
-    return np.array([n, np.nan, np.nan], dtype=np.float64)

scadpy-0.4.9/scadpy/utils/y.py

@@ -1,36 +0,0 @@
-import numpy as np
-from numpy.typing import NDArray
-
-
-def y(n: float = 1) -> NDArray[np.float64]:
-    """
-    Creates a 3D vector along the Y-axis.
-
-    Parameters
-    ----------
-    n : float
-        The value of the Y component. The X and Z components are set to 0.
-
-    Returns
-    -------
-    NDArray[np.float64]
-        A NumPy array of shape (3,) representing the vector `[0, n, 0]`.
-
-    Notes
-    -----
-    - The resulting array always has 3 elements.
-    - The dtype of the array is `np.float64`.
-
-    Examples
-    --------
-    >>> from scadpy import y
-    >>> y(5)
-    array([0., 5., 0.])
-
-    >>> y(-2.3)
-    array([ 0. , -2.3,  0. ])
-
-    >>> y(0)
-    array([0., 0., 0.])
-    """
-    return np.array([np.nan, n, np.nan], dtype=np.float64)

scadpy-0.4.9/scadpy/utils/z.py

@@ -1,36 +0,0 @@
-import numpy as np
-from numpy.typing import NDArray
-
-
-def z(n: float = 1) -> NDArray[np.float64]:
-    """
-    Creates a 3D vector along the Z-axis.
-
-    Parameters
-    ----------
-    n : float
-        The value of the Z component. The X and Y components are set to 0.
-
-    Returns
-    -------
-    NDArray[np.float64]
-        A NumPy array of shape (3,) representing the vector `[0, 0, n]`.
-
-    Notes
-    -----
-    - The resulting array always has 3 elements.
-    - The dtype of the array is `np.float64`.
-
-    Examples
-    --------
-    >>> from scadpy import z
-    >>> z(5)
-    array([0., 0., 5.])
-
-    >>> z(-2.3)
-    array([ 0. ,  0. , -2.3])
-
-    >>> z(0)
-    array([0., 0., 0.])
-    """
-    return np.array([np.nan, np.nan, n], dtype=np.float64)