knit-graphs 0.0.6__py3-none-any.whl → 0.0.8__py3-none-any.whl

knit_graphs-0.0.6.dist-info/licenses/LICENSE → LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Megan Hofmann
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Megan Hofmann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,75 @@
+# knit_graphs
+
+[![PyPI - Version](https://img.shields.io/pypi/v/knit-graphs.svg)](https://pypi.org/project/knit-graphs)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/knit-graphs.svg)](https://pypi.org/project/knit-graphs)
+
+-----
+## Description
+The knit-graphs packaged provides a data structure for representing knitted structures formed of loops of yarn (nodes) connected by various edge structures. Loops are connected by: floats (yarn-edges) in a yarn graph structure, stitch edges (loops pulled through loops), and crossed over each other in a wale-braid structure.
+
+Knit graphs provide a powerful tool for representing knitted structures for digital fabrication systems such as knitting machine programming languages and design tools.
+
+Additional details about this knit-graph construction are available in the ACM publication:
+["KnitPicking Texture: Programming and Modifying Complex Knitted Textures for Machine and Hand Knitting"](https://doi.org/10.1145/3332165.3347886)
+
+## Table of Contents
+- [Description](#description)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Knit Graph Generators](#knit-graph-generators)
+  - [Visualizing Knit Graphs](#visualizing-knit-graphs)
+- [Credits](#credits)
+- [License](#license)
+
+
+
+## Installation
+
+```console
+pip install knit-graphs
+```
+
+## Usage
+
+### Knit Graph Generators
+The [knit-graph-generators subpackage](https://github.com/mhofmann-Khoury/knit_graph/tree/main/src/knit_graphs/knit_graph_generators) provides a library of basic knit graphs to generate such as casting on loops of a knitted structure, creating Jersey (aka Stockinette) tubes and swatches, and other basic textures.
+For example, to generate a swatch of knit-purl ribbing use the following:
+
+```python
+from knit_graphs.basic_knit_graph_generators import kp_rib_swatch
+
+width = 10
+height = 10
+kp_rib_swatch = kp_rib_swatch(width, height)
+```
+Additional examples of knitgraph generator usage can be found in the [Knit_Graph test module](https://github.com/mhofmann-Khoury/knit_graph/blob/main/tests/test_Knit_Graph.py).
+
+Knitgraphs can be created without generators. We encourage users to review the generators as simple examples on creating a knit graph programmatically.
+
+### Visualizing Knit Graphs
+We provide simple support for visualizing knit graphs. This is primarily used to debugging simple knit graph programs.
+
+For example, we can visualize a swatch of seed stitch (checkered knit and purl stitches) with the following code.
+
+```python
+from knit_graphs.basic_knit_graph_generators import seed_swatch
+from knit_graphs.knit_graph_visualizer.Stitch_Visualizer import visualize_stitches
+
+width = 4
+height = 4
+swatch = seed_swatch(width, height)
+visualize_stitches(swatch)
+```
+The visualizer shows knit stitches (loops pulled from the back of the fabric to the front) as blue edges and purl stitches (loops pulled from the front to back) (aka back-knits) as red edges. Loop nodes are circles labeled with their time-ordered index and colored to match their yarn (defaults to dark green). The yarn edges (aka floats) connecting them are made of thin edges the same color as the loop nodes.
+
+Additional examples of using the visualizer are available in the [Stitch Visualizer Tests Module](https://github.com/mhofmann-Khoury/knit_graph/blob/main/tests/test_Stitch_Visualizer.py)
+
+## Credits
+The design of this data scructure was completed by the authors of
+["KnitPicking Texture: Programming and Modifying Complex Knitted Textures for Machine and Hand Knitting"](https://doi.org/10.1145/3332165.3347886).
+
+The inclusion of the Artin-Braide wale crossing construction was inspired by ["An Artin Braid Group Representation of Knitting Machine State with Applications to Validation and Optimization of Fabrication Plans"](https://doi.org/10.1109/ICRA48506.2021.9562113) by Jenny Lin and James McCann.
+
+## License
+
+`knit-graphs` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/api/knit_graphs.Course.rst

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

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:

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:

docs/source/api/knit_graphs.Loop.rst

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

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:

docs/source/api/knit_graphs.Yarn.rst

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

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:

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:

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:

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:

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:

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:

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:

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:

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: