knit-graphs

A graph representation of knitted structures where each loop is a node and edges represent yarn and stitch relationships.

Quick Start

Installation

Install from PyPI:

pip install knit-graphs

Or install from source:

git clone https://github.com/mhofmann-Khoury/knit-graphs.git
cd your-repo
poetry install

Documentation Contents

User Guide

• Installation
  • Requirements
  • Install from PyPI
  • Install from Source
  • Development Installation
  • Verify Installation

API Reference

• knit_graphs package
  • Subpackages
    • knit_graphs.artin_wale_braids package
      • Submodules
    • knit_graphs.knit_graph_errors package
      • Submodules
  • Submodules
    • knit_graphs.Course module
      • Course
    • knit_graphs.Knit_Graph module
      • Knit_Graph
    • knit_graphs.Knit_Graph_Visualizer module
      • TraceData
      • Knit_Graph_Visualizer
      • visualize_knit_graph()
    • knit_graphs.Loop module
      • Loop
    • knit_graphs.Pull_Direction module
      • Pull_Direction
    • knit_graphs.Yarn module
      • Yarn_Properties
      • Yarn
    • knit_graphs.basic_knit_graph_generators module
      • co_loops()
      • jersey_swatch()
      • jersey_tube()
      • kp_rib_swatch()
      • seed_swatch()
      • lace_mesh()
      • twist_cable()
    • knit_graphs.course_face module
      • Course_Face
    • knit_graphs.directed_loop_graph module
      • Directed_Loop_Graph
      • Stitch_Edge
      • Float_Edge
    • knit_graphs.knit_graph_builder module
      • Knit_Graph_Builder
    • knit_graphs.loop_sequence module
      • Loop_Sequence

Support and Community

• GitHub Repository: https://github.com/mhofmann-Khoury/knit-graphs

• Issue Tracker: https://github.com/mhofmann-Khoury/knit-graphs/issues

• PyPI Package: https://pypi.org/project/knit-graphs/

License

This project is licensed under the MIT License.

Indices and tables

• Index

• Module Index

• Search Page