nc-gcode-interpreter 0.1.7__cp311-none-win_amd64.whl

nc_gcode_interpreter/__init__.py

@@ -0,0 +1,33 @@
+from .nc_gcode_interpreter import nc_to_dataframe as _nc_to_dataframe
+from .nc_gcode_interpreter import __doc__  # noqa: F401
+
+__all__ = ["nc_to_dataframe"]
+
+
+# nc_gcode_interpreter.pyi
+import polars as pl
+from typing import Protocol
+
+
+class TextFileLike(Protocol):
+    def read(self) -> str: ...
+
+
+def nc_to_dataframe(
+    input: TextFileLike | str,
+    initial_state: TextFileLike | str | None = None,
+    axis_identifiers: list[str] | None = None,
+    extra_axes: list[str] | None = None,
+    iteration_limit: int = 10000,
+) -> tuple[pl.DataFrame, dict]:
+    if input is None:
+        raise ValueError("input cannot be None")
+    if not isinstance(input, str):
+        input = input.read()
+    if initial_state is not None and not isinstance(initial_state, str):
+        initial_state = initial_state.read()
+
+    df, state = _nc_to_dataframe(
+        input, initial_state, axis_identifiers, extra_axes, iteration_limit
+    )
+    return df, state

nc_gcode_interpreter-0.1.7.dist-info/METADATA

@@ -0,0 +1,174 @@
+Metadata-Version: 2.3
+Name: nc-gcode-interpreter
+Version: 0.1.7
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: maturin >=1.7.4
+Requires-Dist: polars >=1.9.0
+Requires-Dist: jupyter >=1.1.1 ; extra == 'dev'
+Requires-Dist: pytest >=8.3.3 ; extra == 'test'
+Provides-Extra: dev
+Provides-Extra: test
+License-File: LICENSE
+Summary: A interpreter for NC (Numerical Control) code
+Author-email: CEAD Group <software@ceadgroup.com>
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Homepage, https://github.com/CEAD-group/nc-gcode-interpreter
+Project-URL: Repository, https://github.com/CEAD-group/nc-gcode-interpreter.git
+Project-URL: Documentation, https://github.com/CEAD-group/nc-gcode-interpreter/blob/main/README.md
+
+# NC-GCode-Interpreter
+
+A robust interpreter tailored for processing Sinumerik-flavored NC G-code, designed to convert MPF files into CSV outputs or Polars dataframes when used with Python bindings.
+
+## Overview
+
+The NC-GCode-Interpreter provides a streamlined and efficient solution for interpreting G-code specifically designed with Sinumerik specifications in mind. This tool caters to both CLI users and those preferring a Python environment, ensuring versatility and ease of use in processing NC programming commands into structured formats like CSV files or Polars dataframes.
+
+## Features
+
+### Supported G-code Features
+
+- **G Group Commands**: Recognizes G-code groups and modal gcode commands.
+- **Global Translations**: Supports commands like TRANS and ATRANS for adjusting coordinates globally.
+- **Looping Constructs**: Handles loops using WHILE and FOR statements.
+- **Variable Handling**: Supports definition and manipulation of local variables.
+- **Conditional Logic**: Implements conditional execution with IF, ELSE, and ENDIF.
+- **Arithmetic Operations**: Basic operations such as addition, subtraction, multiplication, and division are supported.
+- **Array Operations**: Manages arrays and allows operations on them.
+- **Incremental Changes**: Facilitates incremental changes in axes positions like X=IC(2).
+
+### Additional Functionality
+
+- **Custom Axes**: Allows users to define additional axes beyond the standard X, Y, Z.
+- **Initial State Configuration**: Enables the use of an initial state MPF file to set default values for multiple runs.
+- **CLI Options**: Numerous command-line options to customize the processing like axis overriding, loop limits, and more.
+
+
+
+## Example Usage
+
+
+Consider this example program to generate a square in two layers:
+```scheme
+;Example.MPF
+DEF INT n_layers = 2, layer=1
+DEF REAL size = 100 ;size of the square
+DEF REAL layer_height = 4 ;size of the square
+TRANS Z = 0.5 ; move up all z coordinates by 0.5
+G1 F=1000; Set feed rate in millimeters per minute
+G1 X0 Y500 Z0 ; move to the starting point
+WHILE (layer <= n_layers)
+    X=IC(size)
+    Y=IC(size)
+    X=IC(-size)
+    Y=IC(-size) Z=IC(layer_height)
+    layer = layer + 1
+ENDWHILE
+M31; end of program
+```
+
+
+### CLI Usage
+```bash
+> cargo run -- --help
+A G-code interpreter
+
+Usage: nc-gcode-interpreter [OPTIONS] <input>
+
+Arguments:
+  <input>  Input G-code file (.mpf)
+
+Options:
+  -a, --axes <AXIS>                    Override default axis identifiers (comma-separated, e.g., "X,Y,Z")
+  -e, --extra-axes <EXTRA_AXIS>        Add extra axis identifiers (comma-separated, e.g., "RA1,RA2")
+  -i, --initial_state <INITIAL_STATE>  Optional initial_state file to initialize state
+  -l, --iteration_limit <LIMIT>        Maximum number of iterations for loops [default: 10000]
+  -f, --disable-forward-fill           Disable forward-filling of null values in axes columns
+  -h, --help                           Print help
+  -V, --version                        Print version
+
+> cargo run -- Example.MPF
+```
+
+```csv
+X			,Y			,Z			,F			,M	 ,gg01_motion	,comment
+			,			,			,			,	 ,			    ,;size of the square
+			,			,			,			,	 ,			    ,;size of the square
+			,			,			,			,	 ,			    ,; move up all z coordinates by 0.5
+			,			,			,1000.000	,	 ,G1			,; Set feed rate in millimeters per minute
+0.000		,500.000	,0.500		,1000.000	,	 ,G1			,; move to the starting point
+100.000		,500.000	,0.500		,1000.000	,	 ,G1			,
+100.000		,600.000	,0.500		,1000.000	,	 ,G1			,
+0.000		,600.000	,0.500		,1000.000	,	 ,G1			,
+0.000		,500.000	,5.000		,1000.000	,	 ,G1			,
+100.000		,500.000	,5.000		,1000.000	,	 ,G1			,
+100.000		,600.000	,5.000		,1000.000	,	 ,G1			,
+0.000		,600.000	,5.000		,1000.000	,	 ,G1			,
+0.000		,500.000	,9.500		,1000.000	,	 ,G1			,
+0.000		,500.000	,9.500		,1000.000	,M31 ,G1			,; end of program
+```
+
+
+### python example
+
+```bash
+python -c "\
+from nc_gcode_interpreter import nc_to_dataframe; \
+from pathlib import Path; \
+df, state = nc_to_dataframe(Path('Example.MPF').open()); \
+print(df)"
+shape: (14, 7)
+┌───────┬───────┬──────┬────────┬───────────┬─────────────┬─────────────────────────────────┐
+│ X     ┆ Y     ┆ Z    ┆ F      ┆ M         ┆ gg01_motion ┆ comment                         │
+│ ---   ┆ ---   ┆ ---  ┆ ---    ┆ ---       ┆ ---         ┆ ---                             │
+│ f32   ┆ f32   ┆ f32  ┆ f32    ┆ list[str] ┆ str         ┆ str                             │
+╞═══════╪═══════╪══════╪════════╪═══════════╪═════════════╪═════════════════════════════════╡
+│ null  ┆ null  ┆ null ┆ null   ┆ null      ┆ null        ┆ ;size of the square             │
+│ null  ┆ null  ┆ null ┆ null   ┆ null      ┆ null        ┆ ;size of the square             │
+│ null  ┆ null  ┆ null ┆ null   ┆ null      ┆ null        ┆ ; move up all z coordinates by… │
+│ null  ┆ null  ┆ null ┆ 1000.0 ┆ null      ┆ G1          ┆ ; Set feed rate in millimeters… │
+│ 0.0   ┆ 500.0 ┆ 0.5  ┆ 1000.0 ┆ null      ┆ G1          ┆ ; move to the starting point    │
+│ …     ┆ …     ┆ …    ┆ …      ┆ …         ┆ …           ┆ …                               │
+│ 100.0 ┆ 500.0 ┆ 5.0  ┆ 1000.0 ┆ null      ┆ G1          ┆ null                            │
+│ 100.0 ┆ 600.0 ┆ 5.0  ┆ 1000.0 ┆ null      ┆ G1          ┆ null                            │
+│ 0.0   ┆ 600.0 ┆ 5.0  ┆ 1000.0 ┆ null      ┆ G1          ┆ null                            │
+│ 0.0   ┆ 500.0 ┆ 9.5  ┆ 1000.0 ┆ null      ┆ G1          ┆ null                            │
+│ 0.0   ┆ 500.0 ┆ 9.5  ┆ 1000.0 ┆ ["M31"]   ┆ G1          ┆ ; end of program                │
+└───────┴───────┴──────┴────────┴───────────┴─────────────┴─────────────────────────────────┘
+```
+
+
+```bash
+target/release/nc-gcode-interpreter --help
+A G-code interpreter
+
+Usage: nc-gcode-interpreter [OPTIONS] <input>
+
+Arguments:
+  <input>  Input G-code file (.mpf)
+
+Options:
+  -a, --axes <AXIS>                    Override default axis identifiers (comma-separated, e.g., "X,Y,Z")
+  -e, --extra-axes <EXTRA_AXIS>        Add extra axis identifiers (comma-separated, e.g., "RA1,RA2")
+  -i, --initial_state <INITIAL_STATE>  Optional initial_state file to initialize state
+  -l, --iteration_limit <LIMIT>             Maximum number of iterations for loops [default: 10000]
+  -f, --disable-forward-fill           Disable forward-filling of null values in axes columns
+  -h, --help                           Print help
+  -V, --version                        Print version
+```
+
+## Why?
+
+The Sinumerik NC programming guide is extensive, and some of it's functionality can be very convenient for  making on the fly improvements to cde. However to better uderstand, visualize and simulate the code, it is often necessary to convert it to a more structured format like CSV or a dataframe. This tool aims to provide a simple and efficient way to convert Sinumerik-flavored G-code to a structured format, making it easier to analyze and visualize the code.
+
+Only a limited subset is supported, but the tool is designed to be easily extensible to support more features in the future.
+
+## Contributing
+We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for more details on how to get started.
+

nc_gcode_interpreter-0.1.7.dist-info/RECORD

@@ -0,0 +1,6 @@
+nc_gcode_interpreter-0.1.7.dist-info/METADATA,sha256=QVU9W8NrlUP6ZQ6n6nx2taeR11_A3TZ3diYaPqiFiq0,9144
+nc_gcode_interpreter-0.1.7.dist-info/WHEEL,sha256=bNtRK4IG-ZINiRwRhIvmsDSb0Vife_pt6vsyhyhjHi8,95
+nc_gcode_interpreter-0.1.7.dist-info/licenses/LICENSE,sha256=HrtIztCN6SpmSpwVnrA2SVGeEcM-zoZgUkFWlt-1ikw,1082
+nc_gcode_interpreter/__init__.py,sha256=WqXk0BgTWrJ18rv6eQsImkWTZ0p7-gsJuG4yxj7dQjI,982
+nc_gcode_interpreter/nc_gcode_interpreter.cp311-win_amd64.pyd,sha256=mks-rCRiHJagbV31PO8_dybfyfga8Cr12ISenVRAY18,14203904
+nc_gcode_interpreter-0.1.7.dist-info/RECORD,,

nc_gcode_interpreter-0.1.7.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.7.4)
+Root-Is-Purelib: false
+Tag: cp311-none-win_amd64

nc_gcode_interpreter-0.1.7.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 CEAD
+
+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.