taperable-helix 0.7.0

Generate helixes that can optionally taper to a point at each end.

Taperable Helix

Generate helixes that can optionally taper to a point at each end.

• GitHub repo: https://github.com/winksaville/py-taperable-helix/

• Documentation: https://taperable-helix.readthedocs.io/

• PyPi package: https://pypi.org/project/taperable-helix/

• Free software: MIT license

Package Docs

• docs: https://taperable-helix.readthedocs.io/en/latest/taperable_helix.html

• source: helix.py

@dataclass
class Helix:
    radius: float
    pitch: float
    height: float
    taper_out_rpos: float = 0
    taper_in_rpos: float = 1
    inset_offset: float = 0
    first_t: float = 0
    last_t: float = 1

@dataclass
class HelixLocation:
    # The internal thread radius and an array of HelixLocation
    radius: Optional[float] = None
    horz_offset: float = 0
    vert_offset: float = 0


def helix(
    h: Helix, hl: Optional[HelixLocation] = None
) -> Callable[[float], Tuple[float, float, float]]:
    ...

Examples

• helical_line.py

def helical_line(
    radius: float = 5, pitch: float = 2, height: float = 6, num_points: int = 100
) -> List[Tuple[float, float, float]]:
    h: Helix = Helix(radius=radius, pitch=pitch, height=height)
    f = helix(h)
    points = list(map(f, linspace(start=0, stop=1, num=num_points, dtype=float)))
    # print(f"helical_line: points={points}")
    return points

• helical_tri.py

def helical_triangle(
    radius: float = 1,
    pitch: float = 2,
    height: float = 4,
    num_points: int = 100,
    tri_height: float = 0.2,
    tri_width: float = 0.2,
) -> Tuple[
    List[Tuple[float, float, float]],
    List[Tuple[float, float, float]],
    List[Tuple[float, float, float]],
]:

    # Create three helixes that taper to a point

    # Create the base Helix
    h: Helix = Helix(
        radius=radius, pitch=pitch, height=height, taper_out_rpos=0.1, taper_in_rpos=0.9
    )

    # The Upper points, horz_offset defaults to 0
    fU = helix(h, HelixLocation(vert_offset=tri_height / 2))
    points_fU = list(map(fU, linspace(h.first_t, h.last_t, num=100, dtype=float)))

    # The Lower points, again horz_offset defaults to 0
    fL = helix(h, HelixLocation(vert_offset=-tri_height / 2))
    points_fL = list(map(fL, linspace(h.first_t, h.last_t, num=100, dtype=float)))

    # The Middle point, change vert_offset to 0
    fM = helix(h, HelixLocation(horz_offset=tri_width))
    points_fM = list(map(fM, linspace(h.first_t, h.last_t, num=100, dtype=float)))

    return (points_fU, points_fM, points_fL)

Prerequisites

Using

• python >= 3.7

Development and Examples

• sphinx

• plotly

  • numpy

  • panda

  • python-kaleido

Credits

This code originated from a post by Adam Urbanczyk to the CadQuery forum and this package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (2020-08-31)

• First release on PyPI.