Merge branch 'main' into release/0.2

Author: ansnfernand

.github/workflows/ci_cd.yml

@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys code style checks
-        uses: ansys/actions/code-style@v5
+        uses: ansys/actions/code-style@v7
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
@@ -33,9 +33,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: PyAnsys documentation style checks
-        uses: ansys/actions/doc-style@v5
+        uses: ansys/actions/doc-style@v7
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
+          vale-version: "3.4.1"
 
   smoke-tests:
     name: Build and Smoke tests
@@ -53,7 +54,7 @@ jobs:
             os: macos-latest
     steps:
       - name: Build wheelhouse and perform smoke test
-        uses: ansys/actions/build-wheelhouse@v5
+        uses: ansys/actions/build-wheelhouse@v7
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           library-namespace: ${{ env.PACKAGE_NAMESPACE }}
@@ -115,7 +116,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Run documentation building action
-        uses: ansys/actions/doc-build@v5
+        uses: ansys/actions/doc-build@v7
         with:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
 
@@ -125,7 +126,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Build library source and wheel artifacts
-        uses: ansys/actions/build-library@v5
+        uses: ansys/actions/build-library@v7
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
@@ -137,14 +138,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Release to the public PyPI repository
-        uses: ansys/actions/release-pypi-public@v5
+        uses: ansys/actions/release-pypi-public@v7
         with:
           library-name: ${{ env.PACKAGE_NAME }}
           twine-username: "__token__"
           twine-token: ${{ secrets.PYPI_TOKEN }}
 
       - name: Release to GitHub
-        uses: ansys/actions/release-github@v5
+        uses: ansys/actions/release-github@v7
         with:
           library-name: ${{ env.PACKAGE_NAME }}
 
@@ -155,7 +156,7 @@ jobs:
     needs: [ package ]
     steps:
       - name: Deploy the latest documentation
-        uses: ansys/actions/doc-deploy-dev@v5
+        uses: ansys/actions/doc-deploy-dev@v7
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}
@@ -167,7 +168,7 @@ jobs:
     needs: [ release ]
     steps:
       - name: Deploy the stable documentation
-        uses: ansys/actions/doc-deploy-stable@v5
+        uses: ansys/actions/doc-deploy-stable@v7
         with:
           cname: ${{ env.DOCUMENTATION_CNAME }}
           token: ${{ secrets.GITHUB_TOKEN }}

.pre-commit-config.yaml

@@ -1,32 +1,33 @@
 repos:
 
 - repo: https://github.com/psf/black
-  rev: 23.3.0  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
+  rev: 24.4.2  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
   hooks:
   - id: black
 
 - repo: https://github.com/adamchainz/blacken-docs
-  rev: 1.13.0
+  rev: 1.18.0
   hooks:
   - id: blacken-docs
     additional_dependencies: [black==23.3.0]
 
 - repo: https://github.com/pycqa/isort
-  rev: 5.12.0
+  rev: 5.13.2
   hooks:
   - id: isort
 
 - repo: https://github.com/PyCQA/flake8
-  rev: 6.0.0
+  rev: 7.1.0
   hooks:
   - id: flake8
     args: [src, tests, doc]
 
 - repo: https://github.com/codespell-project/codespell
-  rev: v2.2.4
+  rev: v2.3.0
   hooks:
   - id: codespell
-    args: ["--toml", "pyproject.toml"]
+    args: ["--toml", "pyproject.toml", "--ignore-words",
+           "doc/styles/config/vocabularies/ANSYS/accept.txt"]
     additional_dependencies: ["tomli"]
 
 - repo: https://github.com/pycqa/pydocstyle
@@ -37,7 +38,7 @@ repos:
     files: ^src/
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.4.0
+  rev: v4.6.0
   hooks:
   - id: check-merge-conflict
   - id: debug-statements
@@ -46,6 +47,6 @@ repos:
 
 # this validates our github workflow files
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.22.0
+  rev: 0.29.1
   hooks:
     - id: check-github-workflows

README.rst

@@ -61,6 +61,26 @@ You must have a licensed copy of `Ansys Sherlock <https://www.ansys.com/products
 installed either on your local machine or a remote machine. To use a remote session, a connection to the
 remote machine must be available from your Python program.
 
+Getting Started
+---------------
+PySherlock uses an environment variable called ``AWP_ROOT<ver>``, where ``<ver>`` is the Sherlock release number,
+such as 242 for release 2024 R2. Each release version should have its own environment variable. This variable
+is how PySherlock finds a Sherlock installation for a specific version. If there are multiple versions,
+PySherlock will pick the latest.
+
+On a Windows System, the environment variable ``AWP_ROOT<ver>`` is configured by the Ansys installer.
+
+On a Linux system, the ``AWP_ROOT<ver>`` environment variable must be configured by the user. It must point
+to the absolute path of an Ansys installation directory. For example, if Sherlock 24R2 is installed
+in the following location ``/opt/ansys_inc/v242/sherlock/`` , then an environment variable named ``AWP_ROOT242``
+must be created and set to ``/opt/ansys_inc/v242/``. If there are multiple versions of Ansys tools installed,
+similar environment variables must be created for those versions.
+
+For the rest of the setup please refer to the tutorial videos below.
+
+    * `PySherlock Installation and Usage Demo | Step-by-Step Guide for Beginners <https://www.youtube.com/watch?v=ugiueYuNEKk>`_
+    * `PySherlock Installation and Usage Demo | Advanced Setup Guide <https://www.youtube.com/watch?v=06s_tNvlOTM>`_
+
 Documentation and issues
 ------------------------
 For comprehensive information on PySherlock, see the latest release

doc/.vale.ini

@@ -25,4 +25,6 @@ Vocab = ANSYS
 [*.{md,rst}]
 
 # Apply the following styles
+[*.{rst}]
 BasedOnStyles = Vale, Google
+Vale.Terms = NO

doc/source/api/analysis.rst

@@ -8,4 +8,4 @@ Analysis
 .. autosummary::
      :toctree: _autosummary
 
-     ansys.sherlock.core.analysis.Analysis
+     Analysis

doc/source/api/common.rst

@@ -8,4 +8,4 @@ Common
 .. autosummary::
      :toctree: _autosummary
 
-     ansys.sherlock.core.common.Common
+     Common

doc/source/api/launcher.rst

@@ -9,6 +9,6 @@ Launcher
 .. autosummary::
      :toctree: _autosummary
 
-     ansys.sherlock.core.launcher.launch_sherlock
-     ansys.sherlock.core.launcher.connect_grpc_channel
+     launch_sherlock
+     connect_grpc_channel
 

doc/source/api/layer.rst

@@ -9,4 +9,4 @@ Layer
 .. autosummary::
      :toctree: _autosummary
 
-     ansys.sherlock.core.layer.Layer
+     Layer

doc/source/api/lifecycle.rst

@@ -9,4 +9,4 @@ Lifecycle
 .. autosummary::
      :toctree: _autosummary
 
-     ansys.sherlock.core.lifecycle.Lifecycle
+     Lifecycle

doc/source/api/model.rst

@@ -8,4 +8,4 @@ Model
 .. autosummary::
      :toctree: _autosummary
 
-     ansys.sherlock.core.model.Model
+     Model