knitout_interpreter package
knitout_interpreter: A comprehensive library for interpreting knitout files.
This package provides tools for parsing, validating, and executing knitout files used to control automatic V-Bed knitting machines. It includes support for the complete Knitout specification v2 created by McCann et al.
The library bridges the gap between high-level knitting pattern descriptions and machine-level execution, providing comprehensive analysis and simulation capabilities.
- Core Functionality:
run_knitout(): Simple function to parse and execute knitout files
Knitout_Executer: Advanced class for detailed analysis and execution control
- For specialized functionality, import from submodules:
knitout_interpreter.knitout_operations: Individual instruction types
knitout_interpreter.knitout_language: Parsing and grammar support
knitout_interpreter.knitout_execution_structures: Execution data structures
Subpackages
- knitout_interpreter.debugger package
- knitout_interpreter.knitout_errors package
- knitout_interpreter.knitout_execution_structures package
- Submodules
- knitout_interpreter.knitout_execution_structures.Carriage_Pass module
- knitout_interpreter.knitout_execution_structures.Knitout_Knitting_Machine module
- knitout_interpreter.knitout_execution_structures.knitout_header module
- knitout_interpreter.knitout_execution_structures.knitout_loops module
- knitout_interpreter.knitout_execution_structures.knitout_program module
- Submodules
- knitout_interpreter.knitout_language package
- Submodules
- knitout_interpreter.knitout_language.Knitout_Parser module
- knitout_interpreter.knitout_language.knitout_actions module
typed_action()no_op()break_point()comment()comment_line()code_line()magic_string()header_line()machine_op()gauge_op()yarn_op()carriers_op()position_op()in_op()inhook_op()releasehook_op()out_op()outhook_op()rack_op()knit_op()tuck_op()miss_op()kick_op()split_op()drop_op()xfer_op()pause_op()identifier()float_exp()int_exp()needle_id()carrier_set()
- Submodules
- knitout_interpreter.knitout_operations package
- Submodules
- knitout_interpreter.knitout_operations.Header_Line module
- knitout_interpreter.knitout_operations.Knitout_Line module
- knitout_interpreter.knitout_operations.Pause_Instruction module
- knitout_interpreter.knitout_operations.Rack_Instruction module
- knitout_interpreter.knitout_operations.carrier_instructions module
- knitout_interpreter.knitout_operations.knitout_instruction module
- knitout_interpreter.knitout_operations.knitout_instruction_factory module
- knitout_interpreter.knitout_operations.needle_instructions module
- Submodules
- knitout_interpreter.knitout_warnings package
Submodules
- knitout_interpreter.knitout_execution module
Knitout_ExecuterKnitout_Executer.processKnitout_Executer.executed_headerKnitout_Executer.executed_instructionsKnitout_Executer.debuggerKnitout_Executer.__init__()Knitout_Executer.knitout_versionKnitout_Executer.version_lineKnitout_Executer.knitting_machineKnitout_Executer.resulting_knit_graphKnitout_Executer.carriage_passesKnitout_Executer.execution_timeKnitout_Executer.execution_lengthKnitout_Executer.left_most_positionKnitout_Executer.right_most_positionKnitout_Executer.current_carriage_passKnitout_Executer.starting_new_carriage_passKnitout_Executer.attach_debugger()Knitout_Executer.detach_debugger()Knitout_Executer.enable_snapshot()Knitout_Executer.disable_snapshot()Knitout_Executer.relax_validation_policy()Knitout_Executer.test_and_organize_instructions()Knitout_Executer.write_executed_instructions()Knitout_Executer.__class_getitem__()Knitout_Executer.__len__()Knitout_Executer.handle_violations()Knitout_Executer.machine_is_all_needle_rackedKnitout_Executer.machine_rackingKnitout_Executer.machine_specificationKnitout_Executer.needle_count_of_machineKnitout_Executer.rightmost_slot_on_machineKnitout_Executer.set_response_for()Knitout_Executer.violation_policy
execute_knitout()
- knitout_interpreter.run_knitout module