Merge branch 'main' into release/0.2

Author: RobPasMue

.github/dependabot.yml

@@ -9,7 +9,7 @@ updates:
       - "dependencies"
     ignore:
       - dependency-name: "grpcio"
-    assignees: 
+    assignees:
       - "pyansys-ci-bot"
 
   - package-ecosystem: "github-actions"
@@ -18,5 +18,5 @@ updates:
       interval: "daily"
     labels:
       - "maintenance"
-    assignees: 
+    assignees:
       - "pyansys-ci-bot"

.github/workflows/build_docker_image.yml

@@ -33,7 +33,7 @@ jobs:
 
   build-windows:
     name: Building Geometry Service - Windows
-    runs-on: [self-hosted, pygeometry-ci-1]
+    runs-on: [self-hosted, pygeometry]
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
@@ -56,6 +56,11 @@ jobs:
         run: |
           docker build -f Dockerfile.windows -t ${{ env.ANSRV_GEO_IMAGE_WINDOWS_TAG }} .
 
+      - name: Check location of self-hosted runner and define license server accordingly
+        if: runner.name == 'pygeometry-ci-1'
+        run:
+          echo "ANSRV_GEO_LICENSE_SERVER=${{ secrets.INTERNAL_LICENSE_SERVER }}" | Out-File -FilePath $env:GITHUB_ENV -Append
+
       - name: Launch Geometry service
         run: |
           docker run --detach --name ${{ env.GEO_CONT_NAME }} -e LICENSE_SERVER=${{ env.ANSRV_GEO_LICENSE_SERVER }} -p ${{ env.ANSRV_GEO_PORT }}:50051 ${{ env.ANSRV_GEO_IMAGE_WINDOWS_TAG }}

.github/workflows/ci_cd.yml

@@ -53,8 +53,8 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
-        should-release: 
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+        should-release:
           - ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }}
         exclude:
           - should-release: false
@@ -110,25 +110,17 @@ jobs:
       - name: Download Geometry service container (if needed)
         run: docker pull $env:ANSRV_GEO_IMAGE_WINDOWS_TAG
 
-      - name: Check runner type
+      - name: Check location of self-hosted runner and define license server accordingly
         if: runner.name == 'pygeometry-ci-1'
-        env:
-          INTERNAL_DOCKER_EXTRA_ENVS: ${{ secrets.INTERNAL_DOCKER_EXTRA_ENVS }}
-        run: |
-          $env:INTERNAL_DOCKER_EXTRA_ENVS | Out-File -FilePath env.list -Encoding UTF8
-
-      - name: Check runner type (not needed)
-        if: runner.name != 'pygeometry-ci-1'
-        run: |
-          echo "" | Out-File -FilePath env.list -Encoding UTF8
+        run:
+          echo "ANSRV_GEO_LICENSE_SERVER=${{ secrets.INTERNAL_LICENSE_SERVER }}" | Out-File -FilePath $env:GITHUB_ENV -Append
 
       - name: Start Geometry service and verify start
         run: |
           .\.venv\Scripts\Activate.ps1
-          $env:ANSRV_GEO_PORT_MAP = $env:ANSRV_GEO_PORT + ":50051"
-          docker run --detach --name $env:GEO_CONT_NAME -e LICENSE_SERVER=$env:ANSRV_GEO_LICENSE_SERVER --env-file .\env.list -p $env:ANSRV_GEO_PORT_MAP $env:ANSRV_GEO_IMAGE_WINDOWS_TAG
+          docker run --detach --name ${{ env.GEO_CONT_NAME }} -e LICENSE_SERVER=${{ env.ANSRV_GEO_LICENSE_SERVER }} -p ${{ env.ANSRV_GEO_PORT }}:50051 ${{ env.ANSRV_GEO_IMAGE_WINDOWS_TAG }}
           python -c "from ansys.geometry.core.connection.validate import validate; validate()"
-      
+
       - name: Restore images cache
         uses: actions/cache@v3
         with:
@@ -212,23 +204,15 @@ jobs:
       - name: Download Geometry service container (if needed)
         run: docker pull $env:ANSRV_GEO_IMAGE_WINDOWS_TAG
 
-      - name: Check runner type
+      - name: Check location of self-hosted runner and define license server accordingly
         if: runner.name == 'pygeometry-ci-1'
-        env:
-          INTERNAL_DOCKER_EXTRA_ENVS: ${{ secrets.INTERNAL_DOCKER_EXTRA_ENVS }}
-        run: |
-          $env:INTERNAL_DOCKER_EXTRA_ENVS | Out-File -FilePath env.list -Encoding UTF8
-
-      - name: Check runner type (not needed)
-        if: runner.name != 'pygeometry-ci-1'
-        run: |
-          echo "" | Out-File -FilePath env.list -Encoding UTF8
+        run:
+          echo "ANSRV_GEO_LICENSE_SERVER=${{ secrets.INTERNAL_LICENSE_SERVER }}" | Out-File -FilePath $env:GITHUB_ENV -Append
 
       - name: Start Geometry service and verify start
         run: |
           .\.venv\Scripts\Activate.ps1
-          $env:ANSRV_GEO_PORT_MAP = $env:ANSRV_GEO_PORT + ":50051"
-          docker run --detach --name $env:GEO_CONT_NAME -e LICENSE_SERVER=$env:ANSRV_GEO_LICENSE_SERVER --env-file .\env.list -p $env:ANSRV_GEO_PORT_MAP $env:ANSRV_GEO_IMAGE_WINDOWS_TAG
+          docker run --detach --name ${{ env.GEO_CONT_NAME }} -e LICENSE_SERVER=${{ env.ANSRV_GEO_LICENSE_SERVER }} -p ${{ env.ANSRV_GEO_PORT }}:50051 ${{ env.ANSRV_GEO_IMAGE_WINDOWS_TAG }}
           python -c "from ansys.geometry.core.connection.validate import validate; validate()"
 
       - name: Build the documentation (HTML)
@@ -344,7 +328,7 @@ jobs:
     name: Fetch release artifacts
     needs: [testing-windows, testing-linux, docs]
     if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
-    runs-on: 
+    runs-on:
       group: ansys-internal
       labels: [self-hosted, Windows, signtool]
 
@@ -353,7 +337,7 @@ jobs:
         run: |
           curl.exe -X GET -H "X-JFrog-Art-Api: ${{ secrets.ARTIFACTORY_KEY }}" ${{ secrets.ARTIFACTORY_URL }}/DockerWindows.zip --output windows-binaries.zip
           curl.exe -X GET -H "X-JFrog-Art-Api: ${{ secrets.ARTIFACTORY_KEY }}" ${{ secrets.ARTIFACTORY_URL }}/DockerLinux.zip --output linux-binaries.zip
-      
+
       - name: Upload Windows binaries as workflow artifacts
         uses: actions/upload-artifact@v3
         with:

.github/workflows/label.yml

@@ -40,7 +40,7 @@ jobs:
     # Label based on branch name
     - uses: actions-ecosystem/action-add-labels@v1
       if: |
-        startsWith(github.event.pull_request.head.ref, 'doc') || 
+        startsWith(github.event.pull_request.head.ref, 'doc') ||
         startsWith(github.event.pull_request.head.ref, 'docs')
       with:
         labels: documentation
@@ -70,7 +70,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Suggest to add labels
-      uses: peter-evans/create-or-update-comment@v2
+      uses: peter-evans/create-or-update-comment@v3
       # Execute only when no labels have been applied to the pull request
       if: toJSON(github.event.pull_request.labels.*.name) == '{}'
       with:

.github/workflows/nightly_docker_test.yml

@@ -58,22 +58,15 @@ jobs:
           docker image rm $env:ANSRV_GEO_IMAGE_WINDOWS_TAG
           docker pull $env:ANSRV_GEO_IMAGE_WINDOWS_TAG
 
-      - name: Check runner type
+      - name: Check location of self-hosted runner and define license server accordingly
         if: runner.name == 'pygeometry-ci-1'
-        env:
-          INTERNAL_DOCKER_EXTRA_ENVS: ${{ secrets.INTERNAL_DOCKER_EXTRA_ENVS }}
-        run: |
-          $env:INTERNAL_DOCKER_EXTRA_ENVS | Out-File -FilePath env.list -Encoding UTF8
-      - name: Check runner type (not needed)
-        if: runner.name != 'pygeometry-ci-1'
-        run: |
-          echo "" | Out-File -FilePath env.list -Encoding UTF8
+        run:
+          echo "ANSRV_GEO_LICENSE_SERVER=${{ secrets.INTERNAL_LICENSE_SERVER }}" | Out-File -FilePath $env:GITHUB_ENV -Append
 
       - name: Start Geometry service and verify start
         run: |
           .\.venv\Scripts\Activate.ps1
-          $env:ANSRV_GEO_PORT_MAP = $env:ANSRV_GEO_PORT + ":50051"
-          docker run --detach --name $env:GEO_CONT_NAME -e LICENSE_SERVER=$env:ANSRV_GEO_LICENSE_SERVER --env-file .\env.list -p $env:ANSRV_GEO_PORT_MAP $env:ANSRV_GEO_IMAGE_WINDOWS_TAG
+          docker run --detach --name ${{ env.GEO_CONT_NAME }} -e LICENSE_SERVER=${{ env.ANSRV_GEO_LICENSE_SERVER }} -p ${{ env.ANSRV_GEO_PORT }}:50051 ${{ env.ANSRV_GEO_IMAGE_WINDOWS_TAG }}          python -c "from ansys.geometry.core.connection.validate import validate; validate()"
           python -c "from ansys.geometry.core.connection.validate import validate; validate()"
 
       - name: Run PyGeometry tests

.pre-commit-config.yaml

@@ -1,15 +1,15 @@
 repos:
 
 - repo: https://github.com/psf/black
-  rev: 23.1.0  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
+  rev: 23.3.0  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
   hooks:
   - id: black
 
 - repo: https://github.com/adamchainz/blacken-docs
   rev: 1.13.0
   hooks:
   - id: blacken-docs
-    additional_dependencies: [black==23.1.0]
+    additional_dependencies: [black==23.3.0]
 
 - repo: https://github.com/pycqa/isort
   rev: 5.12.0
@@ -40,6 +40,8 @@ repos:
   hooks:
   - id: check-merge-conflict
   - id: debug-statements
+  - id: check-yaml
+  - id: trailing-whitespace
 
 # this validates our github workflow files
 - repo: https://github.com/python-jsonschema/check-jsonschema

README.rst

@@ -179,10 +179,10 @@ Installing PyGeometry in developer mode allows
 you to modify the source and enhance it.
 
 .. note::
-   
+
     Before contributing to the project, ensure that you are thoroughly familiar
     with the `PyAnsys Developer's Guide`_.
-    
+
 To install PyGeometry in developer mode, perform these steps:
 
 #. Clone the ``pygeometry`` repository:
@@ -222,7 +222,7 @@ To install PyGeometry in developer mode, perform these steps:
 #. Install the project in editable mode:
 
    .. code:: bash
-      
+
       # Install the minimum requirements
       python -m pip install -e .
 
@@ -244,14 +244,14 @@ archive from the `Releases Page <https://github.com/pyansys/pygeometry/releases>
 corresponding machine architecture.
 
 Each wheelhouse archive contains all the Python wheels necessary to install PyGeometry from scratch on Windows,
-Linux, and MacOS from Python 3.7 to 3.11. You can install this on an isolated system with a fresh Python
+Linux, and MacOS from Python 3.8 to 3.11. You can install this on an isolated system with a fresh Python
 installation or on a virtual environment.
 
-For example, on Linux with Python 3.7, unzip the wheelhouse archive and install it with:
+For example, on Linux with Python 3.8, unzip the wheelhouse archive and install it with:
 
 .. code:: bash
 
-    unzip ansys-geometry-core-v0.2.3-wheelhouse-Linux-3.7.zip wheelhouse
+    unzip ansys-geometry-core-v0.2.3-wheelhouse-Linux-3.8.zip wheelhouse
     pip install ansys-geometry-core -f wheelhouse --no-index --upgrade --ignore-installed
 
 If you're on Windows with Python 3.9, unzip to a wheelhouse directory and install using the preceding command.
@@ -263,7 +263,7 @@ Testing
 
 This project takes advantage of `tox`_. This tool automate common
 development tasks (similar to Makefile), but it is oriented towards Python
-development. 
+development.
 
 Using ``tox``
 ^^^^^^^^^^^^^
@@ -279,7 +279,7 @@ The following environments commands are provided:
 - **tox -e py-coverage**: Checks for unit testing and code coverage.
 - **tox -e doc**: Checks for documentation building process.
 
- .. admonition:: pyvista-pytest plugin 
+ .. admonition:: pyvista-pytest plugin
 
    This plugin facilitates the comparison of the images produced in PyGeometry for testing the plots.
    If you are changing the images, use flag ``--reset_image_cache`` which is not recommended except
@@ -331,7 +331,7 @@ the building requirements and then executing the build module:
 
 .. code:: bash
 
-    python -m pip install -U pip 
+    python -m pip install -U pip
     python -m build
     python -m twine check dist/*
 

doc/make.bat

@@ -36,7 +36,7 @@ goto end
 goto build-examples-py
 
 :clean
-rmdir /s /q %BUILDDIR% > /NUL 2>&1 
+rmdir /s /q %BUILDDIR% > /NUL 2>&1
 for /d /r %SOURCEDIR% %%d in (_autosummary) do @if exist "%%d" rmdir /s /q "%%d"
 goto end
 

doc/source/_static/thumbnails/101_getting_started.png

@@ -6,7 +6,7 @@ Overall guidance on contributing to a PyAnsys library appears in the
 in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar
 with it and all `How-to <https://dev.docs.pyansys.com/how-to/index.html>`_ pages
 before attempting to contribute to PyGeometry.
- 
+
 The following contribution information is specific to PyGeometry.
 
 Clone the repository