knit-graphs 0.0.7__tar.gz → 0.0.8__tar.gz

{knit_graphs-0.0.7 → knit_graphs-0.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: knit-graphs
-Version: 0.0.7
+Version: 0.0.8
 Summary: A graph representation of knitted structures where each loop is a node and edges represent yarn and stitch relationships.
 Home-page: https://mhofmann-Khoury.github.io/knit-graphs/
 License: MIT
@@ -21,7 +21,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering
 Requires-Dist: networkx (>=3.5)
-Requires-Dist: plotly (>=6.3.0)
+Requires-Dist: plotly (>=6.3.0,<7.0.0)
 Project-URL: Documentation, https://mhofmann-Khoury.github.io/knit-graphs/
 Project-URL: Repository, https://github.com/mhofmann-Khoury/knit-graphs
 Description-Content-Type: text/markdown

knit_graphs-0.0.8/docs/source/api/knit_graphs.Course.rst

@@ -0,0 +1,7 @@
+knit\_graphs.Course module
+==========================
+
+.. automodule:: knit_graphs.Course
+   :members:
+   :undoc-members:
+   :show-inheritance:

knit_graphs-0.0.8/docs/source/api/knit_graphs.Knit_Graph.rst

@@ -0,0 +1,7 @@
+knit\_graphs.Knit\_Graph module
+===============================
+
+.. automodule:: knit_graphs.Knit_Graph
+   :members:
+   :undoc-members:
+   :show-inheritance:

knit_graphs-0.0.8/docs/source/api/knit_graphs.Knit_Graph_Visualizer.rst

@@ -0,0 +1,7 @@
+knit\_graphs.Knit\_Graph\_Visualizer module
+===========================================
+
+.. automodule:: knit_graphs.Knit_Graph_Visualizer
+   :members:
+   :undoc-members:
+   :show-inheritance:

knit_graphs-0.0.8/docs/source/api/knit_graphs.Loop.rst

@@ -0,0 +1,7 @@
+knit\_graphs.Loop module
+========================
+
+.. automodule:: knit_graphs.Loop
+   :members:
+   :undoc-members:
+   :show-inheritance:

knit_graphs-0.0.8/docs/source/api/knit_graphs.Pull_Direction.rst

@@ -0,0 +1,7 @@
+knit\_graphs.Pull\_Direction module
+===================================
+
+.. automodule:: knit_graphs.Pull_Direction
+   :members:
+   :undoc-members:
+   :show-inheritance:

knit_graphs-0.0.8/docs/source/api/knit_graphs.Yarn.rst

@@ -0,0 +1,7 @@
+knit\_graphs.Yarn module
+========================
+
+.. automodule:: knit_graphs.Yarn
+   :members:
+   :undoc-members:
+   :show-inheritance:

knit_graphs-0.0.8/docs/source/api/knit_graphs.artin_wale_braids.Crossing_Direction.rst

@@ -0,0 +1,7 @@
+knit\_graphs.artin\_wale\_braids.Crossing\_Direction module
+===========================================================
+
+.. automodule:: knit_graphs.artin_wale_braids.Crossing_Direction
+   :members:
+   :undoc-members:
+   :show-inheritance:

knit_graphs-0.0.8/docs/source/api/knit_graphs.artin_wale_braids.Loop_Braid_Graph.rst

@@ -0,0 +1,7 @@
+knit\_graphs.artin\_wale\_braids.Loop\_Braid\_Graph module
+==========================================================
+
+.. automodule:: knit_graphs.artin_wale_braids.Loop_Braid_Graph
+   :members:
+   :undoc-members:
+   :show-inheritance:

knit_graphs-0.0.8/docs/source/api/knit_graphs.artin_wale_braids.Wale.rst

@@ -0,0 +1,7 @@
+knit\_graphs.artin\_wale\_braids.Wale module
+============================================
+
+.. automodule:: knit_graphs.artin_wale_braids.Wale
+   :members:
+   :undoc-members:
+   :show-inheritance:

knit_graphs-0.0.8/docs/source/api/knit_graphs.artin_wale_braids.Wale_Braid.rst

@@ -0,0 +1,7 @@
+knit\_graphs.artin\_wale\_braids.Wale\_Braid module
+===================================================
+
+.. automodule:: knit_graphs.artin_wale_braids.Wale_Braid
+   :members:
+   :undoc-members:
+   :show-inheritance:

knit_graphs-0.0.8/docs/source/api/knit_graphs.artin_wale_braids.Wale_Braid_Word.rst

@@ -0,0 +1,7 @@
+knit\_graphs.artin\_wale\_braids.Wale\_Braid\_Word module
+=========================================================
+
+.. automodule:: knit_graphs.artin_wale_braids.Wale_Braid_Word
+   :members:
+   :undoc-members:
+   :show-inheritance:

knit_graphs-0.0.8/docs/source/api/knit_graphs.artin_wale_braids.Wale_Group.rst

@@ -0,0 +1,7 @@
+knit\_graphs.artin\_wale\_braids.Wale\_Group module
+===================================================
+
+.. automodule:: knit_graphs.artin_wale_braids.Wale_Group
+   :members:
+   :undoc-members:
+   :show-inheritance:

knit_graphs-0.0.8/docs/source/api/knit_graphs.artin_wale_braids.rst

@@ -0,0 +1,23 @@
+knit\_graphs.artin\_wale\_braids package
+========================================
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   knit_graphs.artin_wale_braids.Crossing_Direction
+   knit_graphs.artin_wale_braids.Loop_Braid_Graph
+   knit_graphs.artin_wale_braids.Wale
+   knit_graphs.artin_wale_braids.Wale_Braid
+   knit_graphs.artin_wale_braids.Wale_Braid_Word
+   knit_graphs.artin_wale_braids.Wale_Group
+
+Module contents
+---------------
+
+.. automodule:: knit_graphs.artin_wale_braids
+   :members:
+   :undoc-members:
+   :show-inheritance:

knit_graphs-0.0.8/docs/source/api/knit_graphs.basic_knit_graph_generators.rst

@@ -0,0 +1,7 @@
+knit\_graphs.basic\_knit\_graph\_generators module
+==================================================
+
+.. automodule:: knit_graphs.basic_knit_graph_generators
+   :members:
+   :undoc-members:
+   :show-inheritance:

knit_graphs-0.0.8/docs/source/api/knit_graphs.rst

@@ -0,0 +1,32 @@
+knit\_graphs package
+====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   knit_graphs.artin_wale_braids
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   knit_graphs.Course
+   knit_graphs.Knit_Graph
+   knit_graphs.Knit_Graph_Visualizer
+   knit_graphs.Loop
+   knit_graphs.Pull_Direction
+   knit_graphs.Yarn
+   knit_graphs.basic_knit_graph_generators
+
+Module contents
+---------------
+
+.. automodule:: knit_graphs
+   :members:
+   :undoc-members:
+   :show-inheritance:

{knit_graphs-0.0.7 → knit_graphs-0.0.8}/pyproject.toml

@@ -12,7 +12,7 @@ build-backend = "poetry.core.masonry.api"  # Use Poetry's build system
 # All the information about your project that will appear on PyPI
 [tool.poetry]
 name = "knit-graphs"
-version = "0.0.7"
+version = "0.0.8"
 description = "A graph representation of knitted structures where each loop is a node and edges represent yarn and stitch relationships."
 authors = ["Megan Hofmann <m.hofmann@northeastern.edu>"]
 maintainers = ["Megan Hofmann <m.hofmann@northeastern.edu>"]
@@ -79,7 +79,7 @@ exclude = [
 [tool.poetry.dependencies]
 python = ">=3.11,<3.14"
 networkx = ">=3.5"
-plotly = ">=6.3.0"
+plotly = "^6.3.0"
 # Examples:
 # requests = "^2.31.0"              # For HTTP requests
 # pydantic = "^2.0.0"               # For data validation
@@ -102,6 +102,7 @@ plotly = ">=6.3.0"
 # =============================================================================
 # These packages are only needed during development and testing
 
+
 [tool.poetry.group.dev.dependencies]
 importlib-resources = ">=6.5.2"
 
@@ -277,8 +278,6 @@ omit = [                           # Files to exclude from coverage measurement
     "*/__pycache__/*",              # Ignore Python cache files
     "*/site-packages/*",            # Ignore installed packages
     "*/venv/*",                     # Ignore virtual environment
-    "setup.py",                     # Ignore setup script (if present)
-    "update_project_config.py"
 ]
 branch = true                       # Enable branch coverage (more comprehensive)
 
@@ -301,39 +300,6 @@ show_missing = true                 # Show which lines are missing coverage
 skip_covered = false                # Show covered files in report
 skip_empty = true                   # Skip empty files in report
 
-# Coverage output formats
-[tool.coverage.html]
-directory = "htmlcov"               # Directory for HTML coverage reports
-
-[tool.coverage.xml]
-output = "coverage.xml"             # XML coverage report (used by CI/CD tools)
-
-# =============================================================================
-# VERSION BUMPING CONFIGURATION
-# =============================================================================
-# Configuration for bump2version tool to automate version updates
-[tool.bumpversion]
-current_version = "0.0.7"          # Keep this in sync with tool.poetry.version
-parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
-serialize = ["{major}.{minor}.{patch}"]
-search = "{current_version}"
-replace = "{new_version}"
-commit = true                       # Automatically commit version changes
-tag = true                          # Automatically create git tags
-sign_tags = false                   # Set to true if you want to sign tags with GPG
-
-# Files where version numbers should be updated
-[[tool.bumpversion.files]]
-filename = "pyproject.toml"
-search = 'version = "{current_version}"'
-replace = 'version = "{new_version}"'
-
-# Add other files that contain version numbers
-# [[tool.bumpversion.files]]
-# filename = "src/your_project_name/__init__.py"
-# search = '__version__ = "{current_version}"'
-# replace = '__version__ = "{new_version}"'
-
 # =============================================================================
 # WHEEL BUILDING CONFIGURATION
 # =============================================================================

{knit_graphs-0.0.7 → knit_graphs-0.0.8}/src/knit_graphs/Knit_Graph_Visualizer.py

@@ -3,8 +3,13 @@
 This module provides comprehensive visualization capabilities for knit graphs using Plotly.
 It handles the positioning of loops, rendering of yarn paths, stitch edges, and cable crossings to create interactive 2D visualizations of knitted structures.
 """
+from __future__ import annotations
+
+import os
+import sys
 from typing import Iterable, cast
 
+import plotly.io as pio
 from networkx import DiGraph
 from plotly.graph_objs import Figure, Layout, Scatter
 
@@ -15,6 +20,25 @@ from knit_graphs.Loop import Loop
 from knit_graphs.Pull_Direction import Pull_Direction
 
 
+def configure_plotly_environment() -> None:
+    """Auto-configure Plotly based on environment detection to avoid socket issues."""
+    # Check if we're in a testing environment
+    if ('pytest' in sys.modules or 'unittest' in sys.modules or
+            os.environ.get('TESTING') or os.environ.get('CI')):
+        # For testing, don't set a default renderer - we'll handle this with show_figure=False
+        pass
+    elif 'ipykernel' in sys.modules or 'jupyter' in sys.modules:
+        # Jupyter environment - use notebook renderer
+        pio.renderers.default = "notebook"
+    else:
+        # Development environment - use browser but with timeout to prevent hanging
+        pio.renderers.default = "browser"
+
+
+# Configure environment on import
+configure_plotly_environment()
+
+
 class Knit_Graph_Visualizer:
     """A class used to visualize a knit graph using the plotly graph objects library.
 
@@ -79,11 +103,14 @@ class Knit_Graph_Visualizer:
         self._set_yarn_traces()
         self._add_stitch_edges()
 
-    def make_figure(self, graph_title: str = "Knit Graph") -> None:
-        """Generate and display the interactive figure to visualize this knit graph.
+    def make_figure(self, graph_title: str = "Knit Graph") -> Figure:
+        """Generate the interactive figure to visualize this knit graph.
 
         Args:
             graph_title (str, optional): The title to display on the figure. Defaults to "Knit Graph".
+
+        Returns:
+            Figure: The plotly figure object.
         """
         go_layout = Layout(title=graph_title,
                            showlegend=True,
@@ -97,7 +124,34 @@ class Knit_Graph_Visualizer:
         figure_data.extend(self._loop_markers)
         fig = Figure(data=figure_data,
                      layout=go_layout)
-        fig.show()
+        return fig
+
+    def show_figure(self, graph_title: str = "Knit Graph", renderer: str | None = None) -> None:
+        """Generate and display the interactive figure to visualize this knit graph.
+
+        Args:
+            graph_title (str, optional): The title to display on the figure. Defaults to "Knit Graph".
+            renderer (str, optional): Plotly renderer to use. If None, uses the default configured renderer.
+        """
+        fig = self.make_figure(graph_title)
+
+        # Configure display to minimize resource usage
+        config = {
+            'displayModeBar': False,  # Hide toolbar to reduce resource usage
+            'displaylogo': False,  # Hide plotly logo
+            'staticPlot': False,  # Keep interactive
+            'scrollZoom': False,  # Allow zoom
+            'doubleClick': 'reset+autosize'  # Double-click behavior
+        }
+
+        try:
+            if renderer:
+                fig.show(renderer=renderer, config=config)
+            else:
+                fig.show(config=config)
+        except Exception as e:
+            print(f"Warning: Could not display figure: {e}")
+            print("Figure created successfully but display failed. Consider using show_figure=False and accessing the returned Figure object directly.")
 
     def _no_cross_knit_trace(self, line_width: float = 4.0, knit_color: str = 'blue') -> Scatter:
         """Create a scatter trace for knit stitches not involved in cable crossings.
@@ -159,12 +213,12 @@ class Knit_Graph_Visualizer:
         """
         return self._stitch_trace(self._top_purl_trace_data, "Purl Stitches on Top of Cable", purl_color, line_width, opacity=1.0)
 
-    def _bot_purl_trace(self, line_width: float = 3.0, purl_color: str = 'blue') -> Scatter:
+    def _bot_purl_trace(self, line_width: float = 3.0, purl_color: str = 'red') -> Scatter:
         """Create a scatter trace for purl stitches that cross under other stitches in cables.
 
         Args:
             line_width (float, optional): The width of the lines representing the stitch edges. Defaults to 3.0.
-            purl_color (str, optional): The color of purl stitches in the visualization. Defaults to 'blue'.
+            purl_color (str, optional): The color of purl stitches in the visualization. Defaults to 'red'.
 
         Returns:
             Scatter: The plotly scatter object used to visualize purl stitches below cable crossings.
@@ -192,10 +246,7 @@ class Knit_Graph_Visualizer:
                        mode='lines')
 
     def _add_cable_edges(self) -> None:
-        """Add all stitch edges that are involved in cable crossings to the appropriate trace data.
-
-        This method processes all cable crossings in the knit graph and adds the associated stitch edges to the correct trace data based on their crossing direction (over/under).
-        """
+        """Add all stitch edges that are involved in cable crossings to the appropriate trace data."""
         for left_loop, right_loop in self.knit_graph.braid_graph.loop_crossing_graph.edges:
             crossing_direction = self.knit_graph.braid_graph.get_crossing(left_loop, right_loop)
             for left_parent in left_loop.parent_loops:
@@ -204,10 +255,7 @@ class Knit_Graph_Visualizer:
                 self._add_stitch_edge(right_parent, right_loop, ~crossing_direction)
 
     def _add_stitch_edges(self) -> None:
-        """Add all stitch edges to the visualization trace data based on their type and cable position.
-
-        This method first adds cable-involved edges, then adds all remaining stitch edges as non-cable stitches. It ensures all visible stitch connections are properly categorized for rendering.
-        """
+        """Add all stitch edges to the visualization trace data based on their type and cable position."""
         self._add_cable_edges()
         # Add remaining stitches as though they have no cable crossing.
         for u, v in self.knit_graph.stitch_graph.edges:
@@ -216,13 +264,7 @@ class Knit_Graph_Visualizer:
                 self._add_stitch_edge(u, v, Crossing_Direction.No_Cross)
 
     def _add_stitch_edge(self, u: Loop, v: Loop, crossing_direction: Crossing_Direction) -> None:
-        """Add a single stitch edge to the appropriate trace data based on stitch type and cable crossing.
-
-        Args:
-            u (Loop): The parent loop in the stitch connection.
-            v (Loop): The child loop in the stitch connection.
-            crossing_direction (Crossing_Direction): The cable crossing direction of this stitch edge.
-        """
+        """Add a single stitch edge to the appropriate trace data based on stitch type and cable crossing."""
         pull_direction = self.knit_graph.get_pull_direction(u, v)
         if pull_direction is None:
             return  # No edge between these loops
@@ -253,12 +295,7 @@ class Knit_Graph_Visualizer:
         trace_data['y'].append(None)
 
     def _set_loop_markers(self, loop_size: float = 30.0, loop_border_width: float = 2.0) -> None:
-        """Create plotly scatter objects to mark the position of each loop in the visualization.
-
-        Args:
-            loop_size (float, optional): The diameter of the circle marking each loop. Defaults to 30.0.
-            loop_border_width (float, optional): The width of the border around each loop marker. Defaults to 2.0.
-        """
+        """Create plotly scatter objects to mark the position of each loop in the visualization."""
         yarns_to_loop_data = {yarn: {'x': [self._get_x_of_loop(loop) for loop in yarn],
                                      'y': [self._get_y_of_loop(loop) for loop in yarn],
                                      'loop_id': [loop.loop_id for loop in yarn]
@@ -276,12 +313,7 @@ class Knit_Graph_Visualizer:
                               for yarn, yarn_data in yarns_to_loop_data.items()]
 
     def _set_yarn_traces(self, line_width: float = 1.0, smoothing: float = 1.3) -> None:
-        """Create plotly traces representing the path of each yarn through the knitted structure.
-
-        Args:
-            line_width (float, optional): The width of the lines representing yarn paths. Defaults to 1.0.
-            smoothing (float, optional): The smoothing factor for spline interpolation of yarn paths. Defaults to 1.3.
-        """
+        """Create plotly traces representing the path of each yarn through the knitted structure."""
         yarns_to_float_data = {}
         for yarn in self.knit_graph.yarns:
             float_data: dict[str, list[float]] = {'x': [], 'y': []}
@@ -300,23 +332,14 @@ class Knit_Graph_Visualizer:
                              for yarn, float_data in yarns_to_float_data.items()]
 
     def _position_loops(self) -> None:
-        """Calculate and set the x,y coordinate positions of all loops to be visualized.
-
-        This method orchestrates the complete positioning process including base course positioning, subsequent course positioning, knit/purl shifting, and float alignment adjustments.
-        """
+        """Calculate and set the x,y coordinate positions of all loops to be visualized."""
         self._position_base_course()
         self._place_loops_in_courses()
         self._shift_knit_purl()
         self._shift_loops_by_float_alignment()
 
     def _shift_knit_purl(self, shift: float = 0.1) -> None:
-        """Adjust the horizontal position of loops to visually distinguish knit from purl stitches.
-
-        This method shifts knit stitches slightly left and purl stitches slightly right to create visual separation that makes knit-purl patterns more distinct in the visualization.
-
-        Args:
-            shift (float, optional): The amount to shift stitches horizontally. Knit stitches are shifted left and purl stitches are shifted right. Defaults to 0.1.
-        """
+        """Adjust the horizontal position of loops to visually distinguish knit from purl stitches."""
         has_knits = any(self.knit_graph.get_pull_direction(u, v) is Pull_Direction.BtF for u, v in self.knit_graph.stitch_graph.edges)
         has_purls = any(self.knit_graph.get_pull_direction(u, v) is Pull_Direction.FtB for u, v in self.knit_graph.stitch_graph.edges)
         if not (has_knits and has_purls):
@@ -340,14 +363,7 @@ class Knit_Graph_Visualizer:
             self._set_x_of_loop(loop, self._get_x_of_loop(child_loop))
 
     def _shift_loops_by_float_alignment(self, float_increment: float = 0.25) -> None:
-        """Adjust the vertical position of loops based on their float relationships.
-
-        Loops that pass in front of floats are shifted down while loops that pass behind floats are shifted up.
-        This creates a visual layering effect that represents the three-dimensional structure of the knitted fabric.
-
-        Args:
-            float_increment (float, optional): The vertical spacing adjustment for loops relative to floats they cross. Defaults to 0.25.
-        """
+        """Adjust the vertical position of loops based on their float relationships."""
         for yarn in self.knit_graph.yarns:
             for u, v, front_loops in yarn.loops_in_front_of_floats():
                 for front_loop in front_loops:
@@ -359,26 +375,11 @@ class Knit_Graph_Visualizer:
                         self._set_y_of_loop(back_loop, self._get_y_of_loop(back_loop) + float_increment)  # shift loop up to show it is behind the float.
 
     def _get_course_of_loop(self, loop: Loop) -> Course:
-        """Get the course (horizontal row) that contains the specified loop.
-
-        Args:
-            loop (Loop): The loop to find the course for.
-
-        Returns:
-            Course: The course that contains this loop.
-        """
+        """Get the course (horizontal row) that contains the specified loop."""
         return self.loops_to_course[loop]
 
     def _place_loop(self, loop: Loop, x: float, y: float) -> None:
-        """Add a loop to the visualization data graph at the specified coordinates.
-
-        If the loop already exists in the data graph, its coordinates will be updated to the new position.
-
-        Args:
-            loop (Loop): The loop to position in the visualization.
-            x (float): The x coordinate for the loop.
-            y (float): The y coordinate for the loop.
-        """
+        """Add a loop to the visualization data graph at the specified coordinates."""
         if self._loop_has_position(loop):
             self._set_x_of_loop(loop, x)
             self._set_y_of_loop(loop, y)
@@ -386,98 +387,43 @@ class Knit_Graph_Visualizer:
             self.data_graph.add_node(loop, x=x, y=y)
 
     def _set_x_of_loop(self, loop: Loop, x: float) -> None:
-        """Update the x coordinate of a loop that already exists in the visualization data graph.
-
-        Args:
-            loop (Loop): The loop to update the x coordinate for.
-            x (float): The new x coordinate for the loop.
-
-        Raises:
-            KeyError: If the loop does not exist in the visualization data graph.
-        """
+        """Update the x coordinate of a loop that already exists in the visualization data graph."""
         if self._loop_has_position(loop):
             self.data_graph.nodes[loop]['x'] = x
         else:
             raise KeyError(f"Loop {loop} is not in the data graph")
 
     def _set_y_of_loop(self, loop: Loop, y: float) -> None:
-        """Update the y coordinate of a loop that already exists in the visualization data graph.
-
-        Args:
-            loop (Loop): The loop to update the y coordinate for.
-            y (float): The new y coordinate for the loop.
-
-        Raises:
-            KeyError: If the loop does not exist in the visualization data graph.
-        """
+        """Update the y coordinate of a loop that already exists in the visualization data graph."""
         if self._loop_has_position(loop):
             self.data_graph.nodes[loop]['y'] = y
         else:
             raise KeyError(f"Loop {loop} is not in the data graph")
 
     def _get_x_of_loop(self, loop: Loop) -> float:
-        """Get the x coordinate of a loop from the visualization data graph.
-
-        Args:
-            loop (Loop): The loop to get the x coordinate for.
-
-        Returns:
-            float: The x coordinate of the loop.
-
-        Raises:
-            KeyError: If the loop does not exist in the visualization data graph.
-        """
+        """Get the x coordinate of a loop from the visualization data graph."""
         if self._loop_has_position(loop):
             return float(self.data_graph.nodes[loop]['x'])
         else:
             raise KeyError(f"Loop {loop} is not in the data graph")
 
     def _get_y_of_loop(self, loop: Loop) -> float:
-        """Get the y coordinate of a loop from the visualization data graph.
-
-        Args:
-            loop (Loop): The loop to get the y coordinate for.
-
-        Returns:
-            float: The y coordinate of the loop.
-
-        Raises:
-            KeyError: If the loop does not exist in the visualization data graph.
-        """
+        """Get the y coordinate of a loop from the visualization data graph."""
         if self._loop_has_position(loop):
             return float(self.data_graph.nodes[loop]['y'])
         else:
             raise KeyError(f"Loop {loop} is not in the data graph")
 
     def _loop_has_position(self, loop: Loop) -> bool:
-        """Check if a loop has been positioned in the visualization data graph.
-
-        Args:
-            loop (Loop): The loop to check for positioning.
-
-        Returns:
-            bool: True if the loop has been positioned in the visualization, False otherwise.
-        """
+        """Check if a loop has been positioned in the visualization data graph."""
         return bool(self.data_graph.has_node(loop))
 
     def _stitch_has_position(self, u: Loop, v: Loop) -> bool:
-        """Check if a stitch edge between two loops has been added to the visualization data graph.
-
-        Args:
-            u (Loop): The parent loop in the stitch edge.
-            v (Loop): The child loop in the stitch edge.
-
-        Returns:
-            bool: True if a stitch edge from u to v exists in the visualization data graph, False otherwise.
-        """
+        """Check if a stitch edge between two loops has been added to the visualization data graph."""
         return bool(self.data_graph.has_edge(u, v))
 
     def _place_loops_in_courses(self, course_spacing: float = 1.0) -> None:
-        """Position loops in all courses above the base course using parent relationships and yarn connections.
-
-        Args:
-            course_spacing (float, optional): The vertical distance between consecutive courses. Defaults to 1.0.
-        """
+        """Position loops in all courses above the base course using parent relationships and yarn connections."""
         y = course_spacing
         for course in self.courses[self.first_course_index + 1:self.top_course_index]:
             self._place_loops_by_parents(course, y)
@@ -487,11 +433,7 @@ class Knit_Graph_Visualizer:
             y += course_spacing  # Shift y coordinate up with each course
 
     def _swap_loops_in_cables(self, course: Course) -> None:
-        """Swap the horizontal positions of loops involved in cable crossings within a course.
-
-        Args:
-            course (Course): The course containing loops that may need position swapping due to cable crossings.
-        """
+        """Swap the horizontal positions of loops involved in cable crossings within a course."""
         for left_loop in course:
             for right_loop in self.knit_graph.braid_graph.left_crossing_loops(left_loop):
                 crossing_direction = self.knit_graph.braid_graph.get_crossing(left_loop, right_loop)
@@ -501,12 +443,7 @@ class Knit_Graph_Visualizer:
                     self._set_x_of_loop(right_loop, left_x)
 
     def _place_loops_by_parents(self, course: Course, y: float) -> None:
-        """Position loops in a course based on the average position of their parent loops.
-
-        Args:
-            course (Course): The course containing loops to be positioned.
-            y (float): The y coordinate for all loops in this course.
-        """
+        """Position loops in a course based on the average position of their parent loops."""
         for x, loop in enumerate(course):
             self._set_loop_x_by_parent_average(loop, y)
         placed_loops = set()
@@ -519,14 +456,7 @@ class Knit_Graph_Visualizer:
         # A loops past the first course should have at least one yarn neighbor to place them.
 
     def _set_loop_x_by_parent_average(self, loop: Loop, y: float) -> None:
-        """Set the x coordinate of a loop based on the weighted average position of its parent loops.
-
-        If the loop has no parent loops, it is added to the set of loops that need positioning through other methods.
-
-        Args:
-            loop (Loop): The loop to position based on its parents.
-            y (float): The y coordinate to assign to the loop.
-        """
+        """Set the x coordinate of a loop based on the weighted average position of its parent loops."""
         if len(loop.parent_loops) == 0:
             self._loops_need_placement.add(loop)
             return
@@ -542,16 +472,7 @@ class Knit_Graph_Visualizer:
         self._place_loop(loop, x=x, y=y)
 
     def _set_loop_between_yarn_neighbors(self, loop: Loop, y: float, spacing: float = 1.0) -> bool:
-        """Position a loop based on the average position of its neighboring loops along the yarn.
-
-        Args:
-            loop (Loop): The loop to position based on its yarn neighbors.
-            y (float): The y coordinate to assign to the loop.
-            spacing (float, optional): The minimum spacing to maintain between adjacent loops on the same course. Defaults to 1.0.
-
-        Returns:
-            bool: True if the loop was successfully positioned, False if no yarn neighbors were available for positioning.
-        """
+        """Position a loop based on the average position of its neighboring loops along the yarn."""
         spacing = abs(spacing)  # Ensure spacing is positive.
         x_neighbors = []
         prior_loop = loop.prior_loop_on_yarn()
@@ -573,11 +494,7 @@ class Knit_Graph_Visualizer:
         return True
 
     def _position_base_course(self) -> None:
-        """Position the loops in the bottom course of the visualization and establish base metrics.
-
-        This method determines whether the base course is knit in the round (tube) or in rows (flat) and positions loops accordingly.
-        It also establishes the base width and left position for scaling other courses.
-        """
+        """Position the loops in the bottom course of the visualization and establish base metrics."""
         base_course = self.courses[self.first_course_index]
         if (len(self.courses) > self.first_course_index + 1  # There are more courses to show after the base course
                 and base_course.in_round_with(self.courses[self.first_course_index + 1])):  # The first course is knit in the round to form a tube structure.
@@ -590,13 +507,7 @@ class Knit_Graph_Visualizer:
         self.base_width = max_x - self.base_left
 
     def _get_base_round_course_positions(self, base_course: Course, loop_space: float = 1.0, back_shift: float = 0.5) -> None:
-        """Position loops in the base course for circular/tube knitting structure.
-
-        Args:
-            base_course (Course): The base course to position for circular knitting.
-            loop_space (float, optional): The horizontal spacing between loops in the course. Defaults to 1.0.
-            back_shift (float, optional): The vertical offset for loops on the back of the tube. Defaults to 0.5.
-        """
+        """Position loops in the base course for circular/tube knitting structure."""
         split_index = len(base_course) // 2  # Split the course in half to form a tube.
         front_loops: list[Loop] = cast(list[Loop], base_course[:split_index])
         front_set: set[Loop] = set(front_loops)
@@ -617,12 +528,7 @@ class Knit_Graph_Visualizer:
                 self._place_loop(back_loop, x=(x * loop_space) - back_shift, y=0)
 
     def _get_base_row_course_positions(self, base_course: Course, loop_space: float = 1.0) -> None:
-        """Position loops in the base course for flat/row knitting structure.
-
-        Args:
-            base_course (Course): The base course to position for flat knitting.
-            loop_space (float, optional): The horizontal spacing between loops. Defaults to 1.0.
-        """
+        """Position loops in the base course for flat/row knitting structure."""
         loops: Iterable[Loop] = list(base_course)
         if not self.start_on_left:
             loops = reversed(base_course)
@@ -630,13 +536,7 @@ class Knit_Graph_Visualizer:
             self._place_loop(loop, x=x * loop_space, y=0)
 
     def _left_align_course(self, course: Course) -> None:
-        """Align the leftmost loop of a course to x=0 if left alignment is enabled.
-
-        The relative positions of all loops in the course are preserved while shifting the entire course horizontally.
-
-        Args:
-            course (Course): The course to potentially left-align.
-        """
+        """Align the leftmost loop of a course to x=0 if left alignment is enabled."""
         if self.left_zero_align:
             current_left = min(self._get_x_of_loop(loop) for loop in course)
             if current_left != 0.0:
@@ -644,11 +544,7 @@ class Knit_Graph_Visualizer:
                     self._set_x_of_loop(loop, self._get_x_of_loop(loop) - current_left)
 
     def _balance_course(self, course: Course) -> None:
-        """Scale the width of a course to match the base course width if balancing is enabled.
-
-        Args:
-            course (Course): The course to potentially balance to match the base width.
-        """
+        """Scale the width of a course to match the base course width if balancing is enabled."""
         current_left = min(self._get_x_of_loop(loop) for loop in course)
         max_x = max(self._get_x_of_loop(loop) for loop in course)
         course_width = max_x - current_left
@@ -660,10 +556,60 @@ class Knit_Graph_Visualizer:
             for loop in course:
                 self._set_x_of_loop(loop, _target_distance_from_left(loop) + current_left)
 
+    def x_coordinate_differences(self, other: Knit_Graph_Visualizer) -> dict[Loop: tuple[float | None, float | None]]:
+        """Find the differences in x-coordinates between two knitgraph visualizations. Used for testing and comparing visualization results.
+
+        Args:
+            other (Knit_Graph_Visualizer): The knitgraph visualization to compare to.
+
+        Returns:
+            dict[Loop: tuple[float | None, float | None]]: The differences in x-coordinates.
+            * The keys of the dictionary are loops with differences between the two visualizations.
+            * The values of the dictionary are tuples of floats or None.
+            ** The first value in each tuple is the x-coordinate of the loop in this knitgraph visualization or None if the loop is not in this visualization.
+            ** The second value of each tuple is the x-coordinate of the loop in the other visualization or NOne if the loop is not in that visualization.
+
+        """
+        differences = {l: (self._get_x_of_loop(l), None) for l in self.data_graph.nodes if not other.data_graph.has_node(l)}
+        differences.update({l: (None, other._get_x_of_loop(l)) for l in other.data_graph.nodes if not self.data_graph.has_node(l)})
+        differences.update({l: (self._get_x_of_loop(l), other._get_x_of_loop(l)) for l in self.data_graph.nodes if other.data_graph.has_node(l) and self._get_x_of_loop(l) != other._get_x_of_loop(l)})
+        return differences
+
+    def y_coordinate_differences(self, other: Knit_Graph_Visualizer) -> dict[Loop: tuple[float | None, float | None]]:
+        """Find the differences in y-coordinates between two knitgraph visualizations. Used for testing and comparing visualization results.
+
+        Args:
+            other (Knit_Graph_Visualizer): The knitgraph visualization to compare to.
+
+        Returns:
+            dict[Loop: tuple[float | None, float | None]]: The differences in y-coordinates.
+            * The keys of the dictionary are loops with differences between the two visualizations.
+            * The values of the dictionary are tuples of floats or None.
+            ** The first value in each tuple is the y-coordinate of the loop in this knitgraph visualization or None if the loop is not in this visualization.
+            ** The second value of each tuple is the y-coordinate of the loop in the other visualization or NOne if the loop is not in that visualization.
+
+        """
+        differences = {l: (self._get_y_of_loop(l), None) for l in self.data_graph.nodes if not other.data_graph.has_node(l)}
+        differences.update({l: (None, other._get_y_of_loop(l)) for l in other.data_graph.nodes if not self.data_graph.has_node(l)})
+        differences.update({l: (self._get_y_of_loop(l), other._get_y_of_loop(l)) for l in self.data_graph.nodes if other.data_graph.has_node(l) and self._get_y_of_loop(l) != other._get_y_of_loop(l)})
+        return differences
+
+    def __eq__(self, other: Knit_Graph_Visualizer) -> bool:
+        """Two visualizations are equal if share the same x,y coordinates for all loops in the visualization and both contain the same set of loop nodes.
+        Args:
+            other (Knit_Graph_Visualizer): The knitgraph visualization to compare to.
+
+        Returns:
+            bool: True if the knitgraph visualizations are equal, False otherwise.
+        """
+        return len(self.data_graph.nodes) == len(other.data_graph.nodes) and len(self.x_coordinate_differences(other)) == 0 and len(self.y_coordinate_differences(other)) == 0
 
-def visualize_knit_graph(knit_graph: Knit_Graph, first_course_index: int = 0, top_course_index: int | None = None, start_on_left: bool = True, balance_by_base_width: bool = False,
-                         left_zero_align: bool = True, graph_title: str = "knit_graph", show_figure: bool = True) -> None:
-    """Generate and display a plotly visualization of the given knit graph with specified configuration.
+
+def visualize_knit_graph(knit_graph: Knit_Graph, first_course_index: int = 0, top_course_index: int | None = None,
+                         start_on_left: bool = True, balance_by_base_width: bool = False,
+                         left_zero_align: bool = True, graph_title: str = "knit_graph",
+                         show_figure: bool = True, renderer: str | None = None) -> Figure:
+    """Generate and optionally display a plotly visualization of the given knit graph with specified configuration.
 
     Args:
         knit_graph (Knit_Graph): The knit graph to visualize.
@@ -674,7 +620,56 @@ def visualize_knit_graph(knit_graph: Knit_Graph, first_course_index: int = 0, to
         left_zero_align (bool): Whether to align the leftmost position of each course with x=0 in the figure. Defaults to True.
         graph_title (str): The title to display on the generated figure. Defaults to "knit_graph".
         show_figure (bool, optional): If True, the visualization will be shown. Defaults to True.
+        renderer (str, optional): Plotly renderer to use. Common options: 'browser', 'notebook'. Defaults to None (uses configured default).
+
+    Returns:
+        Figure: The plotly figure object.
     """
     visualizer = Knit_Graph_Visualizer(knit_graph, first_course_index, top_course_index, start_on_left, balance_by_base_width, left_zero_align)
+    fig = visualizer.make_figure(graph_title)
+
     if show_figure:
-        visualizer.make_figure(graph_title)
+        try:
+            # Configure display to minimize resource usage
+            config = {
+                'displayModeBar': False,  # Hide toolbar to reduce resource usage
+                'displaylogo': False,  # Hide plotly logo
+                'staticPlot': False,  # Keep interactive
+                'scrollZoom': True,  # Allow zoom
+                'doubleClick': 'reset+autosize'  # Double-click behavior
+            }
+
+            if renderer:
+                fig.show(renderer=renderer, config=config)
+            else:
+                fig.show(config=config)
+        except Exception as e:
+            print(f"Warning: Could not display figure '{graph_title}': {e}")
+            print("Figure created successfully but display failed.")
+
+    return fig
+
+
+def visualize_knit_graph_safe(knit_graph: Knit_Graph, first_course_index: int = 0, top_course_index: int | None = None,
+                              start_on_left: bool = True, balance_by_base_width: bool = False,
+                              left_zero_align: bool = True, graph_title: str = "knit_graph") -> Figure:
+    """Generate a plotly visualization of the given knit graph with specified configuration.
+    This function is safe for UnitTest and other headless environments because it does not attempt to show the visualization.
+
+    Args:
+        knit_graph (Knit_Graph): The knit graph to visualize.
+        first_course_index (int): Index of the first (bottom) course to include in the visualization. Defaults to 0.
+        top_course_index (int | None): Index of the last (top) course to include in the visualization. If None, visualizes up to the top of the knit graph.
+        start_on_left (bool): Whether the first loop knit is presumed to be positioned on the left of the pattern. Defaults to True.
+        balance_by_base_width (bool): Whether to scale all course widths to match the first course width. Defaults to False.
+        left_zero_align (bool): Whether to align the leftmost position of each course with x=0 in the figure. Defaults to True.
+        graph_title (str): The title to display on the generated figure. Defaults to "knit_graph".
+
+    Returns:
+        Figure: The plotly figure object.
+    """
+    return visualize_knit_graph(knit_graph, first_course_index=first_course_index, top_course_index=top_course_index,
+                                start_on_left=start_on_left,
+                                balance_by_base_width=balance_by_base_width,
+                                left_zero_align=left_zero_align, graph_title=graph_title,
+                                show_figure=False)

{knit_graphs-0.0.7 → knit_graphs-0.0.8}/src/knit_graphs/basic_knit_graph_generators.py

@@ -5,6 +5,7 @@ These functions serve as building blocks for testing and demonstration purposes.
 """
 from knit_graphs.artin_wale_braids.Crossing_Direction import Crossing_Direction
 from knit_graphs.Knit_Graph import Knit_Graph
+from knit_graphs.Loop import Loop
 from knit_graphs.Pull_Direction import Pull_Direction
 from knit_graphs.Yarn import Yarn
 
@@ -153,105 +154,53 @@ def seed_swatch(width: int, height: int) -> Knit_Graph:
     return knit_graph
 
 
-def kp_mesh_decrease_left_swatch(width: int, height: int) -> Knit_Graph:
-    """Generate a mesh pattern with left-leaning decreases and yarn overs in knit-purl ribbing.
-
-    This creates an openwork mesh pattern where purl stitches are decreased leftward on even courses and replaced with yarn overs,
-    creating decorative holes in the fabric while maintaining the overall stitch count.
+def lace_mesh(width: int, height: int) -> Knit_Graph:
+    """Generate a mesh pattern with alternating left and right leaning decrease paired to yarn-overs.
+    These pairings create a basic lace pattern with eyelets formed around the increases.
 
     Args:
         width (int): The number of stitches per course (horizontal row).
         height (int): The number of courses (vertical rows) in the swatch.
 
     Returns:
-        Knit_Graph: A knit graph representing a mesh swatch with left-leaning decreases and yarn overs.
+        Knit_Graph: A knit graph representing a mesh swatch.
     """
-    # k<o k<o k <-: 1->2
-    # |\  |\
-    # k p k p k ->: 0->1
-    # 0 1 2 3 4
     knit_graph, yarn = co_loops(width)
     last_course = knit_graph.get_courses()[0]
     next_course = []
-    next_pull = Pull_Direction.BtF
     for parent_loop in reversed(last_course):
         child_loop = yarn.make_loop_on_end()
-        knit_graph.connect_loops(parent_loop, child_loop, pull_direction=next_pull)
-        next_pull = next_pull.opposite()
+        knit_graph.connect_loops(parent_loop, child_loop, pull_direction=Pull_Direction.BtF)
         next_course.append(child_loop)
     last_course = next_course
     for _ in range(1, height):
+        # Make the lace course
         next_course = []
-        for parent_loop in reversed(last_course):
+        yo_parent = None
+        prior_child = None
+        for i, parent_loop in enumerate(reversed(last_course)):
             child_loop = yarn.make_loop_on_end()
-            grand_parent = parent_loop.parent_loops[0]
-            parent_pull = knit_graph.get_pull_direction(grand_parent, parent_loop)
-            if parent_pull is Pull_Direction.BtF:  # knits stay in decrease at bottom of stack
+            if i % 3 == 0:  # Just knit every third stitch
                 knit_graph.connect_loops(parent_loop, child_loop, pull_direction=Pull_Direction.BtF, stack_position=0)
-                prior_parent = yarn.prior_loop(parent_loop)
-                if prior_parent is not None and prior_parent in last_course:
-                    knit_graph.connect_loops(prior_parent, child_loop, pull_direction=Pull_Direction.FtB, stack_position=1)
-            next_course.append(child_loop)
-        last_course = next_course
-        next_course = []
-        for parent_loop in reversed(last_course):
-            child_loop = yarn.make_loop_on_end()
-            if len(parent_loop.parent_loops) == 0:
-                knit_graph.connect_loops(parent_loop, child_loop, pull_direction=Pull_Direction.FtB)
-            else:
-                knit_graph.connect_loops(parent_loop, child_loop, pull_direction=Pull_Direction.BtF)
-            next_course.append(child_loop)
-        last_course = next_course
-    return knit_graph
-
-
-def kp_mesh_decrease_right_swatch(width: int, height: int) -> Knit_Graph:
-    """Generate a mesh pattern with right-leaning decreases and yarn overs in knit-purl ribbing.
-
-    This creates an openwork mesh pattern where purl stitches are decreased rightward on even courses and replaced with yarn overs,
-    creating decorative holes in the fabric while maintaining the overall stitch count.
-
-    Args:
-        width (int): The number of stitches per course (horizontal row).
-        height (int): The number of courses (vertical rows) in the swatch.
-
-    Returns:
-        Knit_Graph: A knit graph representing a mesh swatch with right-leaning decreases and yarn overs.
-    """
-    # k o>k o>k <-: 1->2
-    #    /|  /|
-    # k p k p k ->: 0->1
-    # 0 1 2 3 4
-    knit_graph, yarn = co_loops(width)
-    last_course = knit_graph.get_courses()[0]
-    next_course = []
-    next_pull = Pull_Direction.BtF
-    for parent_loop in reversed(last_course):
-        child_loop = yarn.make_loop_on_end()
-        knit_graph.connect_loops(parent_loop, child_loop, pull_direction=next_pull)
-        next_pull = next_pull.opposite()
-        next_course.append(child_loop)
-    last_course = next_course
-    for _ in range(1, height):
-        next_course = []
-        for parent_loop in reversed(last_course):
-            child_loop = yarn.make_loop_on_end()
-            grand_parent = parent_loop.parent_loops[0]
-            parent_pull = knit_graph.get_pull_direction(grand_parent, parent_loop)
-            if parent_pull is Pull_Direction.BtF:  # knits stay in decrease at bottom of stack
+            elif i % 6 == 1:  # Second of every 6 stitches (0 indexed) is yarn over before a decrease.
+                yo_parent = parent_loop
+            elif i % 6 == 2:  # Third of every 6 stitches is bottom of decrease with prior yarn-over's parent
+                knit_graph.connect_loops(parent_loop, child_loop, pull_direction=Pull_Direction.BtF, stack_position=0)
+                assert isinstance(yo_parent, Loop)
+                knit_graph.connect_loops(yo_parent, child_loop, pull_direction=Pull_Direction.BtF, stack_position=1)
+            elif i % 6 == 4:  # Fifth of every six stitches is bottom of decrease with next yarn-over's parent
                 knit_graph.connect_loops(parent_loop, child_loop, pull_direction=Pull_Direction.BtF, stack_position=0)
-                next_parent = yarn.next_loop(parent_loop)
-                if next_parent is not None:
-                    knit_graph.connect_loops(next_parent, child_loop, pull_direction=Pull_Direction.FtB, stack_position=1)
+                prior_child = child_loop
+            elif i % 6 == 5:  # The last of six stitches is the top of the prior decrease and new yarn-over
+                assert isinstance(prior_child, Loop)
+                knit_graph.connect_loops(parent_loop, prior_child, pull_direction=Pull_Direction.BtF, stack_position=1)
             next_course.append(child_loop)
         last_course = next_course
+        # Make a basic jersey course
         next_course = []
         for parent_loop in reversed(last_course):
             child_loop = yarn.make_loop_on_end()
-            if len(parent_loop.parent_loops) == 0:
-                knit_graph.connect_loops(parent_loop, child_loop, pull_direction=Pull_Direction.FtB)
-            else:
-                knit_graph.connect_loops(parent_loop, child_loop, pull_direction=Pull_Direction.BtF)
+            knit_graph.connect_loops(parent_loop, child_loop, pull_direction=Pull_Direction.BtF)
             next_course.append(child_loop)
         last_course = next_course
     return knit_graph

knit_graphs-0.0.7/docs/source/api/knit_graphs.artin_wale_braids.rst

@@ -1,58 +0,0 @@
-knit\_graphs.artin\_wale\_braids package
-========================================
-
-.. automodule:: knit_graphs.artin_wale_braids
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Submodules
-----------
-
-knit\_graphs.artin\_wale\_braids.Crossing\_Direction module
------------------------------------------------------------
-
-.. automodule:: knit_graphs.artin_wale_braids.Crossing_Direction
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-knit\_graphs.artin\_wale\_braids.Loop\_Braid\_Graph module
-----------------------------------------------------------
-
-.. automodule:: knit_graphs.artin_wale_braids.Loop_Braid_Graph
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-knit\_graphs.artin\_wale\_braids.Wale module
---------------------------------------------
-
-.. automodule:: knit_graphs.artin_wale_braids.Wale
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-knit\_graphs.artin\_wale\_braids.Wale\_Braid module
----------------------------------------------------
-
-.. automodule:: knit_graphs.artin_wale_braids.Wale_Braid
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-knit\_graphs.artin\_wale\_braids.Wale\_Braid\_Word module
----------------------------------------------------------
-
-.. automodule:: knit_graphs.artin_wale_braids.Wale_Braid_Word
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-knit\_graphs.artin\_wale\_braids.Wale\_Group module
----------------------------------------------------
-
-.. automodule:: knit_graphs.artin_wale_braids.Wale_Group
-   :members:
-   :undoc-members:
-   :show-inheritance:

knit_graphs-0.0.7/docs/source/api/knit_graphs.rst

@@ -1,74 +0,0 @@
-knit\_graphs package
-====================
-
-.. automodule:: knit_graphs
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Subpackages
------------
-
-.. toctree::
-   :maxdepth: 4
-
-   knit_graphs.artin_wale_braids
-
-Submodules
-----------
-
-knit\_graphs.Course module
---------------------------
-
-.. automodule:: knit_graphs.Course
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-knit\_graphs.Knit\_Graph module
--------------------------------
-
-.. automodule:: knit_graphs.Knit_Graph
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-knit\_graphs.Knit\_Graph\_Visualizer module
--------------------------------------------
-
-.. automodule:: knit_graphs.Knit_Graph_Visualizer
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-knit\_graphs.Loop module
-------------------------
-
-.. automodule:: knit_graphs.Loop
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-knit\_graphs.Pull\_Direction module
------------------------------------
-
-.. automodule:: knit_graphs.Pull_Direction
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-knit\_graphs.Yarn module
-------------------------
-
-.. automodule:: knit_graphs.Yarn
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-knit\_graphs.basic\_knit\_graph\_generators module
---------------------------------------------------
-
-.. automodule:: knit_graphs.basic_knit_graph_generators
-   :members:
-   :undoc-members:
-   :show-inheritance: