nc-gcode-interpreter 0.1.7__tar.gz → 0.1.9__tar.gz

{nc_gcode_interpreter-0.1.7 → nc_gcode_interpreter-0.1.9}/.github/workflows/build-and-release.yml

@@ -89,7 +89,8 @@ jobs:
           pip install "${WHL_FILE}[test]"
       - name: Run tests with pytest
         run: pytest
-
+      - name: Type checking with mypy
+        run: mypy python
   linux:
     if: startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch'
     needs: [lint, test]

{nc_gcode_interpreter-0.1.7 → nc_gcode_interpreter-0.1.9}/Cargo.lock

@@ -724,7 +724,7 @@ dependencies = [
 
 [[package]]
 name = "nc-gcode-interpreter"
-version = "0.1.7"
+version = "0.1.9"
 dependencies = [
  "clap",
  "csv",
@@ -819,9 +819,9 @@ checksum = "e3148f5046208a5d56bcfc03053e3ca6334e51da8dfb19b6cdc8b306fae3283e"
 
 [[package]]
 name = "pest"
-version = "2.7.13"
+version = "2.7.14"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fdbef9d1d47087a895abd220ed25eb4ad973a5e26f6a4367b038c25e28dfc2d9"
+checksum = "879952a81a83930934cbf1786752d6dedc3b1f29e8f8fb2ad1d0a36f377cf442"
 dependencies = [
  "memchr",
  "thiserror",

{nc_gcode_interpreter-0.1.7 → nc_gcode_interpreter-0.1.9}/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nc-gcode-interpreter"
-version = "0.1.7"
+version = "0.1.9"
 edition = "2021"
 
 [lib]

{nc_gcode_interpreter-0.1.7 → nc_gcode_interpreter-0.1.9}/Development.md

@@ -42,5 +42,5 @@ rm **/*.csv && cargo build --release && find examples -name "*.mpf" -type f -pri
 ## python test
     
 ```bash
-maturin develop --release && pytest
+maturin develop --release --uv && pytest
 ```

{nc_gcode_interpreter-0.1.7 → nc_gcode_interpreter-0.1.9}/PKG-INFO

@@ -1,20 +1,22 @@
 Metadata-Version: 2.3
 Name: nc-gcode-interpreter
-Version: 0.1.7
+Version: 0.1.9
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: 3.11
 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: polars[pyarrow] >=1.9.0
 Requires-Dist: jupyter >=1.1.1 ; extra == 'dev'
 Requires-Dist: pytest >=8.3.3 ; extra == 'test'
+Requires-Dist: mypy ; extra == 'test'
 Provides-Extra: dev
 Provides-Extra: test
 License-File: LICENSE
-Summary: A interpreter for NC (Numerical Control) code
+Summary: A interpreter for NC (Numerical Control) GCode
 Author-email: CEAD Group <software@ceadgroup.com>
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
@@ -24,44 +26,42 @@ Project-URL: Documentation, https://github.com/CEAD-group/nc-gcode-interpreter/b
 
 # 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.
+A robust interpreter designed for processing Sinumerik-flavored NC G-code, capable of converting MPF files into CSV outputs or Polars DataFrames via 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.
+The **NC-GCode-Interpreter** offers a streamlined and efficient solution for interpreting G-code specifically tailored to Sinumerik specifications. This tool caters to both command-line interface (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.
+- **G Group Commands**: Recognizes G-code groups and modal G-code commands.
+- **Global Transformations**: 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.
+- **Conditional Logic**: Implements conditional execution with `IF`, `ELSE`, and `ENDIF`.
+- **Arithmetic Operations**: Supports basic operations such as addition, subtraction, multiplication, and division.
 - **Array Operations**: Manages arrays and allows operations on them.
-- **Incremental Changes**: Facilitates incremental changes in axes positions like X=IC(2).
+- **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.
+- **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.
-
-
+- **CLI Options**: Numerous command-line options to customize the processing, such as 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
+; Example.MPF
+DEF INT n_layers = 2, layer = 1
+DEF REAL size = 100 ; size of the square
+DEF REAL layer_height = 4 ; height of each layer
+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)
@@ -70,13 +70,12 @@ WHILE (layer <= n_layers)
     Y=IC(-size) Z=IC(layer_height)
     layer = layer + 1
 ENDWHILE
-M31; end of program
-```
+M31 ; end of program
 
 
 ### CLI Usage
 ```bash
-> cargo run -- --help
+$ cargo run -- --help
 A G-code interpreter
 
 Usage: nc-gcode-interpreter [OPTIONS] <input>
@@ -87,13 +86,13 @@ Arguments:
 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
+  -i, --initial_state <INITIAL_STATE>  Optional initial state file to e.g. define global variables or set axis positions
   -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
+$ cargo run -- Example.MPF
 ```
 
 ```csv
@@ -117,6 +116,13 @@ X			,Y			,Z			,F			,M	 ,gg01_motion	,comment
 
 ### python example
 
+To install the Python bindings, run:
+```bash
+pip install nc-gcode-interpreter
+```
+
+Then, you can use the Python bindings to convert an MPF file to a DataFrame:
+
 ```bash
 python -c "\
 from nc_gcode_interpreter import nc_to_dataframe; \
@@ -143,6 +149,17 @@ shape: (14, 7)
 └───────┴───────┴──────┴────────┴───────────┴─────────────┴─────────────────────────────────┘
 ```
 
+The Python bindings also return the state of the program after execution, which can be used for inspection.
+
+Additionally, conversion from a Polars DataFrame back to an MPF (NC) program is also supported:
+
+```bash
+python -c "\
+from nc_gcode_interpreter import nc_to_dataframe, dataframe_to_nc; \
+from pathlib import Path; \
+df, state = nc_to_dataframe(Path('Example.MPF').open(), extra_axes=['ELX']); \
+dataframe_to_nc(df, Path('Example_out.MPF').open('w'))" 
+```
 
 ```bash
 target/release/nc-gcode-interpreter --help
@@ -165,7 +182,7 @@ Options:
 
 ## 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.
+The Sinumerik NC programming guide is extensive, and some of its functionality can be very convenient for making on-the-fly improvements to code. However, to better understand, 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.
 
 Only a limited subset is supported, but the tool is designed to be easily extensible to support more features in the future.
 

{nc_gcode_interpreter-0.1.7 → nc_gcode_interpreter-0.1.9}/README.md

@@ -1,43 +1,41 @@
 # 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.
+A robust interpreter designed for processing Sinumerik-flavored NC G-code, capable of converting MPF files into CSV outputs or Polars DataFrames via 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.
+The **NC-GCode-Interpreter** offers a streamlined and efficient solution for interpreting G-code specifically tailored to Sinumerik specifications. This tool caters to both command-line interface (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.
+- **G Group Commands**: Recognizes G-code groups and modal G-code commands.
+- **Global Transformations**: 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.
+- **Conditional Logic**: Implements conditional execution with `IF`, `ELSE`, and `ENDIF`.
+- **Arithmetic Operations**: Supports basic operations such as addition, subtraction, multiplication, and division.
 - **Array Operations**: Manages arrays and allows operations on them.
-- **Incremental Changes**: Facilitates incremental changes in axes positions like X=IC(2).
+- **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.
+- **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.
-
-
+- **CLI Options**: Numerous command-line options to customize the processing, such as 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
+; Example.MPF
+DEF INT n_layers = 2, layer = 1
+DEF REAL size = 100 ; size of the square
+DEF REAL layer_height = 4 ; height of each layer
+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)
@@ -46,13 +44,12 @@ WHILE (layer <= n_layers)
     Y=IC(-size) Z=IC(layer_height)
     layer = layer + 1
 ENDWHILE
-M31; end of program
-```
+M31 ; end of program
 
 
 ### CLI Usage
 ```bash
-> cargo run -- --help
+$ cargo run -- --help
 A G-code interpreter
 
 Usage: nc-gcode-interpreter [OPTIONS] <input>
@@ -63,13 +60,13 @@ Arguments:
 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
+  -i, --initial_state <INITIAL_STATE>  Optional initial state file to e.g. define global variables or set axis positions
   -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
+$ cargo run -- Example.MPF
 ```
 
 ```csv
@@ -93,6 +90,13 @@ X			,Y			,Z			,F			,M	 ,gg01_motion	,comment
 
 ### python example
 
+To install the Python bindings, run:
+```bash
+pip install nc-gcode-interpreter
+```
+
+Then, you can use the Python bindings to convert an MPF file to a DataFrame:
+
 ```bash
 python -c "\
 from nc_gcode_interpreter import nc_to_dataframe; \
@@ -119,6 +123,17 @@ shape: (14, 7)
 └───────┴───────┴──────┴────────┴───────────┴─────────────┴─────────────────────────────────┘
 ```
 
+The Python bindings also return the state of the program after execution, which can be used for inspection.
+
+Additionally, conversion from a Polars DataFrame back to an MPF (NC) program is also supported:
+
+```bash
+python -c "\
+from nc_gcode_interpreter import nc_to_dataframe, dataframe_to_nc; \
+from pathlib import Path; \
+df, state = nc_to_dataframe(Path('Example.MPF').open(), extra_axes=['ELX']); \
+dataframe_to_nc(df, Path('Example_out.MPF').open('w'))" 
+```
 
 ```bash
 target/release/nc-gcode-interpreter --help
@@ -141,7 +156,7 @@ Options:
 
 ## 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.
+The Sinumerik NC programming guide is extensive, and some of its functionality can be very convenient for making on-the-fly improvements to code. However, to better understand, 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.
 
 Only a limited subset is supported, but the tool is designed to be easily extensible to support more features in the future.
 

nc_gcode_interpreter-0.1.9/examples/function_calls.csv

@@ -0,0 +1,3 @@
+gg01_motion,X,function_call
+,,SETAL(12345)
+G1,1.000,

nc_gcode_interpreter-0.1.9/examples/function_calls.mpf

@@ -0,0 +1,2 @@
+SETAL(12345)
+G1 X1

nc_gcode_interpreter-0.1.9/examples/if_statement.mpf

@@ -0,0 +1,13 @@
+DEF INT aa=1
+IF TRUE
+    X1
+ELSE
+    IF aa
+        X5
+    ELSE
+        X3
+        Y32
+    ENDIF
+ENDIF
+
+