changes found in rtellez repository #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft

xloem wants to merge 189 commits into xloem:back2mecode from rtellez700:main

.github/workflows/docs.yml

-Original file line number
+Diff line change
@@ -0,0 +1,46 @@
+    name: ci
+    on:
+      push:
+        branches:
+          - master
+          - main
+    permissions:
+      contents: write
+    jobs:
+      deploy:
+        runs-on: ubuntu-latest
+        steps:
+          - uses: actions/checkout@v4
+          - name: Configure Git Credentials
+            run: |
+              git config user.name github-actions[bot]
+              git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+          - uses: actions/setup-python@v5
+            with:
+              python-version: 3.x
+          - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+          - uses: actions/cache@v4
+            with:
+              key: mkdocs-material-${{ env.cache_id }}
+              path: .cache
+              restore-keys: |
+                mkdocs-material-
+          - run: pip install mkdocs-material
+          - run: pip install 'mkdocstrings[python]'
+          - run: pip install . # install local mecode
+          - run: pip install mike
+          # Install hatch
+          - run: pip install hatch  # Ensure hatch is installed
+          # Step to get version dynamically using hatch
+          - name: Get version from hatch
+            id: get_version
+            run: |
+              VERSION=$(hatch version)
+              echo "VERSION=$VERSION" >> $GITHUB_ENV
+              echo "Version: $VERSION"
+          - run: mkdocs build  # Build the documentation
+          - run: mike deploy ${{ env.VERSION }} -m "Deploy version ${{ env.VERSION }}" --update-aliases latest  # Deploy using mike

.github/workflows/python-package.yml

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -5,19 +5,22 @@ name: Python package
  
    on:

      push:

        branches: [ "master" ]

        branches:

          - master 

          - main

      pull_request:

        branches: [ "master" ]

        branches:

          - master 

          - main

    jobs:

      build:

        strategy:

          fail-fast: false

          fail-fast: true

          matrix:

            host-os: ["ubuntu-latest", "macos-latest", "windows-latest"]

            # python-version: ["2.7","3.4","3.5","3.6","3.7","3.8","3.9","3.10"]

            python-version: ["3.7","3.8","3.9","3.10"]

            python-version: ["3.11"]

        runs-on: ${{ matrix.host-os }}

    @@ -26,9 +29,9 @@ jobs:
  
            shell: bash -l {0}

        steps:

        - uses: actions/checkout@v3

        - uses: actions/checkout@v4

        - name: Set up Python ${{ matrix.python-version }}

          uses: actions/setup-python@v3

          uses: actions/setup-python@v5

          with:

            python-version: ${{ matrix.python-version }}

        - name: Install dependencies

.gitignore

-Original file line number
+Diff line change
@@ -1,3 +1,4 @@
+    site
     .delete
     *.log
@@ Expand Down @@

.pre-commit-config.yaml

-Original file line number
+Diff line change
@@ -0,0 +1,10 @@
+    repos:
+    - repo: https://github.com/astral-sh/ruff-pre-commit
+      # Ruff version.
+      rev: v0.7.2
+      hooks:
+        # Run the linter.
+        - id: ruff
+          args: [ --fix ]
+        # Run the formatter.
+        - id: ruff-format

.vscode/settings.json

-Original file line number
+Diff line change
@@ -0,0 +1,13 @@
+    {
+        "yaml.schemas": {
+          "https://squidfunk.github.io/mkdocs-material/schema.json": "mkdocs.yml"
+        },
+        "yaml.customTags": [
+          "!ENV scalar",
+          "!ENV sequence",
+          "!relative scalar",
+          "tag:yaml.org,2002:python/name:material.extensions.emoji.to_svg",
+          "tag:yaml.org,2002:python/name:material.extensions.emoji.twemoji",
+          "tag:yaml.org,2002:python/name:pymdownx.superfences.fence_code_format"
+        ]
+      }

0 LICENSE → LICENSE.md

File renamed without changes.

README.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,7 +1,13 @@
  
    Mecode

    ======

      `

    [![Unit Tests](https://github.com/rtellez700/mecode/actions/workflows/python-package.yml/badge.svg)](https://github.com/rtellez700/mecode/actions/workflows/python-package.yml)

    [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)

    [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

    ![](https://img.shields.io/badge/python-3.10+-blue.svg)

    ![Status](https://img.shields.io/badge/status-maintained-yellow.svg)

    [![](https://img.shields.io/github/license/rtellez700/mecode.svg)](https://github.com/rtellez700/mecode/blob/main/LICENSE.md)

    ### GCode for all

    @@ -44,67 +50,11 @@ with G(outfile='file.gcode') as g:
  
    When the `with` block is exited, `g.teardown()` will be automatically called.

    The resulting toolpath can be visualized in 3D using the `mayavi` or `matplotlib`

    package with the `view()` method:

    ```python

    g = G()

    g.meander(10, 10, 1)

    g.view()

    ```

    The graphics backend can be specified when calling the `view()` method, e.g. `g.view('matplotlib')`.

    `mayavi` is the default graphics backend.

    All GCode Methods

    -----------------

    All methods have detailed docstrings and examples.

    * `set_home()`

    * `reset_home()`

    * `feed()`

    * `dwell()`

    * `home()`

    * `move()`

    * `abs_move()`

    * `arc()`

    * `abs_arc()`

    * `rect()`

    * `meander()`

    * `clip()`

    * `triangular_wave()`

    Matrix Transforms

    -----------------

    A wrapper class, `GMatrix` will run all move and arc commands through a 

    2D transformation matrix before forwarding them to `G`.

    To use, simply instantiate a `GMatrix` object instead of a `G` object:

    ```python

    g = GMatrix()

    g.push_matrix()      # save the current transformation matrix on the stack.

    g.rotate(math.pi/2)  # rotate our transformation matrix by 90 degrees.

    g.move(0, 1)         # same as moves (1,0) before the rotate.

    g.pop_matrix()       # revert to the prior transformation matrix.

    ```

    The transformation matrix is 2D instead of 3D to simplify arc support.

    Renaming Axes

    -------------

    When working with a machine that has more than one Z-Axis, it is

    useful to use the `rename_axis()` function. Using this function your

    code can always refer to the vertical axis as 'Z', but you can dynamically

    rename it.

    Installation

    ------------

    *Outdated* The easiest method to install mecode is with pip:

    The easiest method to install mecode is with pip:

    ```bash

    pip install git+https://github.com/rtellez700/mecode.git

    @@ -119,31 +69,24 @@ $ pip install -r requirements.txt
  
    $ python setup.py install

    ```

    Optional Dependencies

    ---------------------

    The following dependencies are optional, and are only needed for

    visualization. An easy way to install them is to use [conda][1].

    Documentation

    -------------

    * numpy

    * matplotlib

    * vpython

    * mayavi

    Full documentation can be found at [https://rtellez700.github.io/mecode/](https://rtellez700.github.io/mecode/)

    [1]: https://www.anaconda.com/

    TODO

    ----

    - [ ] add pressure box comport to `__init__()` method

    - [ ] build out multi-nozzle support

        - [ ] include multi-nozzle support in view method.

    - [ ] factor out aerotech specific methods into their own class

    - [ ] auto set MFO=100% before each print

    - [x] add formal documentation

    - [x] create github page

    - [x] build out multi-nozzle support

        - [x] include multi-nozzle support in view method

    - [ ] add ability to read current status of aerotech

      - [ ] turn off omnicure after aborted runs

    - [ ] add formal sphinx documentation

    - [ ] create github page

    - [ ] add support for identifying part bounds and specifying safe post print "parking"

    - [ ] add support for auto-generating aerotech specific functions only if needed.

      - [ ] add support for easily adding new serial devices: (1) pyserial-based, (2) aerotech, or (3) other??

    Credits

    -------

docs/api-reference/api-reference.md

Empty file.

docs/api-reference/matrix.md

Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		::: mecode.matrix

docs/api-reference/matrix3D.md

Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		::: mecode.matrix3D

docs/api-reference/mecode.md

Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		::: mecode.main

docs/api-reference/printer.md

Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		::: mecode.printer

docs/api-reference/profilometer_parse.md

Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		::: mecode.profilometer_parse

docs/assets/images/MM_cylinder_example.png

Sorry, something went wrong. Reload?