#555: Release v 1.5.0

.github/workflows/action-git-diff-check.yml

@@ -7,7 +7,7 @@ jobs:
     name: Run git check
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: ${{ github.event.pull_request.head.sha }}

.github/workflows/build-and-publish-to-pypi.yml

@@ -7,7 +7,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python 3.8
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: 3.8
       - name: Install build

.github/workflows/check-commit-format.yml

@@ -7,7 +7,7 @@ jobs:
     name: Check commit message format
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: ${{ github.event.pull_request.head.sha }}

.github/workflows/code-quality.yml

@@ -12,21 +12,21 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        python-version: ['3.8', '3.9']
+        python-version: ['3.8', '3.9', '3.10', '3.11']
     runs-on: ${{ matrix.os }}
     env:
       deploy_badges_src_branch: develop
       deploy_badges_dst_branch: deploy-badges
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Install packages
         run: |
           sudo apt-get update -y
           sudo apt-get install -y git xvfb
 
       - name: Python Setup
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -50,7 +50,7 @@ jobs:
           echo "coverage_report_exists=$COVERAGE_REPORT_EXISTS" >> $GITHUB_OUTPUT
 
       - name: Report Test results
-        uses: phoenix-actions/test-reporting@v12
+        uses: phoenix-actions/test-reporting@v15
         if: success() || failure()
         with:
           name: Tests report (${{ matrix.os }}, ${{ matrix.python-version }})
@@ -61,7 +61,7 @@ jobs:
       - name: Upload pylint artifact
         if: |
           steps.run_tox.outputs.pylint_report_exists == 'true'
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: pylint
           path: artifacts/pylint.txt
@@ -70,7 +70,7 @@ jobs:
       - name: Upload coverage artifact
         if: |
           steps.run_tox.outputs.coverage_report_exists == 'true'
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: coverage
           path: artifacts/coverage.txt

.github/workflows/deploy_docs.yml

@@ -1,8 +1,6 @@
 name: Deploy docs
 
-on:
-  push:
-    branches: [ '297-add-automated-generated-documentation-from-LBAF' ]
+on: push
 
 jobs:
   build-and-deploy-docs:
@@ -12,12 +10,12 @@ jobs:
       docs-directory: /home/runner/work/LB-analysis-framework/LB-analysis-framework/docs
       docs-output: /home/runner/work/LB-analysis-framework/LB-analysis-framework/docs/output
       docs-generator: /home/runner/work/LB-analysis-framework/LB-analysis-framework/m.css/documentation
-      python-version: '3.8'
+      python-version: '3.11'
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ env.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ env.python-version }}
           architecture: 'x64'
@@ -43,7 +41,9 @@ jobs:
         working-directory: ${{ env.docs-output }}
         run: touch .nojekyll
       # This action moves the content of `generated_docs` to the `deploy-doc-site` branch
+      # It only runs on pushes to main and develop
       - name: Deploy docs
+        if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develop'
         uses: JamesIves/github-pages-deploy-action@v4
         with:
           token: ${{ secrets.GH_PAT }}

.github/workflows/find-trailing-whitespace.yml

@@ -7,7 +7,7 @@ jobs:
     name: Find Trailing Whitespace
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: DARMA-tasking/find-trailing-whitespace@master
         with:
-          exclude: "doc" # ; separated path to exclude
+          exclude: "doc;.png$" # ; separated path to exclude

.pylintrc

@@ -3,7 +3,7 @@
 # A comma-separated list of package or module names from where C extensions may
 # be loaded. Extensions are loading into the active Python interpreter and may
 # run arbitrary code.
-extension-pkg-allow-list=
+extension-pkg-allow-list=vttv
 
 # A comma-separated list of package or module names from where C extensions may
 # be loaded. Extensions are loading into the active Python interpreter and may
@@ -90,9 +90,10 @@ disable=raw-checker-failed,
         deprecated-pragma,
         use-symbolic-message-instead,
         logging-fstring-interpolation,
-        missing-module-doctring,
-        missing-class-doctring,
-        protected-access
+        missing-module-docstring,
+        missing-class-docstring,
+        protected-access,
+        too-few-public-methods
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -215,6 +216,8 @@ good-names=i, # loop variable
            s,
            e, # exception
            Run,
+           A,
+           B,
            _
 
 # Good variable names regexes, separated by a comma. If names match any regex,
@@ -408,7 +411,7 @@ ignored-classes=optparse.Values,thread._local,_thread._local,lbaf.IO.lbsStatisti
 # (useful for modules/projects where namespaces are manipulated during runtime
 # and thus existing member attributes cannot be deduced by static analysis). It
 # supports qualified module names, as well as Unix pattern matching.
-ignored-modules=vtk
+ignored-modules=
 
 # Show a hint with possible names when a member name was not found. The aspect
 # of finding the hint is based on edit distance.
@@ -515,7 +518,7 @@ max-branches=12
 max-locals=15
 
 # Maximum number of parents for a class (see R0901).
-max-parents=7
+max-parents=8
 
 # Maximum number of public methods for a class (see R0904).
 max-public-methods=20
@@ -575,5 +578,5 @@ preferred-modules=
 
 # Exceptions that will emit a warning when being caught. Defaults to
 # "BaseException, Exception".
-overgeneral-exceptions=BaseException,
-                       Exception
+overgeneral-exceptions=builtins.BaseException,
+                       builtins.Exception

.vscode/launch.json

@@ -42,6 +42,16 @@
             "console": "integratedTerminal",
             "justMyCode": true,
             "args": [ ]
-        }
+        },
+        {
+            "name": "LBAF: Data Files Maker",
+            "python": "${workspaceFolder}/venv311/bin/python",
+            "type": "python",
+            "request": "launch",
+            "program": "${workspaceFolder}/src/lbaf/Utils/lbsJSONDataFilesMaker.py",
+            "console": "integratedTerminal",
+            "justMyCode": true,
+            "args": ["--interactive"]
+        },
     ]
 }

.vscode/settings.json

@@ -1,31 +1,31 @@
 {
-    "python.linting.enabled": true,
-    "python.linting.pylintEnabled": true,
-    "python.linting.pylintPath": "${workspaceFolder}/venv/bin/pylint",
-    "python.linting.ignorePatterns": [
+    // Linting (with PyLint) configuration for VSCode
+    "pylint.args": [
+        "--rcfile=${workspaceFolder}/.pylintrc"
+    ],
+    "pylint.ignorePatterns": [
         "**/site-packages/**/*.py",
         ".vscode/*.py"
     ],
-    "pylint.args": [
-        "--rcfile=${workspaceFolder}/.pylintrc"
+    "pylint.path": [
+        "${workspaceFolder}/venv/bin/pylint"
     ],
     "pylint.importStrategy": "fromEnvironment",
     "python.testing.unittestArgs": [
-        "-v",
+        "discover",
         "-s",
         "./tests",
         "-p",
-        "test_*.py"
+        "test_*.py",
+        "-t",
+        "./",
+        "-v",
     ],
-
-    "python.testing.unittestEnabled": true,
-    "python.testing.pytestEnabled": false,
+    // Unit Tests (with unittest) configuration for VSCode
+    "python.testing.pytestEnabled": false, // disable pytest lib
+    "python.testing.unittestEnabled": true, // enable unitest lib
     "[python]": {
         "editor.defaultFormatter": "ms-python.autopep8"
     },
-    "python.formatting.provider": "none",
-    "python.formatting.autopep8Args": [
-        "--max-line-length",
-        "120"
-    ],
+    "autopep8.args": ["--max-line-length","120"]
 }

LICENSE

@@ -1,8 +1,8 @@
-                          DARMA Toolkit v. 1.0.0
+                          DARMA Toolkit v. 1.5.0
                 DARMA/LBAF => Load Balancing Analysis Framework
                     For version number see VERSION file
 
-Copyright 2019-2021 National Technology & Engineering Solutions of Sandia, LLC
+Copyright 2019-2024 National Technology & Engineering Solutions of Sandia, LLC
 (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, the U.S.
 Government retains certain rights in this software.
 
@@ -32,4 +32,4 @@ CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 POSSIBILITY OF SUCH DAMAGE.
 
-Questions? Contact [email protected]
+Questions? Contact [email protected]