Feature #555 replace plotly

.github/workflows/documentation.yaml

@@ -18,8 +18,8 @@ jobs:
     name: Build Documentation
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v6
+      - uses: actions/setup-python@v6
         with:
           python-version: '3.10'
       - name: Install dependencies

.github/workflows/sonarqube.yaml

@@ -43,13 +43,13 @@ jobs:
 
     steps:
 
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
       with:
         # Disable shallow clones for better analysis
         fetch-depth: 0
 
     - name: Set up Python 3.12
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: "3.12"
 

.github/workflows/unit_tests.yaml

@@ -1,6 +1,7 @@
 # This workflow will install Python dependencies, run tests the specified Python version
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
-name: Python 3.12 tests
+name: Python Tests
+run-name: ${{ github.event_name == 'workflow_dispatch' && format('{0} vs. {1}', github.ref_name, github.event.inputs.version_to_compare) || github.event.head_commit.message || github.event.pull_request.title }}
 
 on:
   push:
@@ -17,57 +18,159 @@ on:
       - '.github/ISSUE_TEMPLATE/**'
       - '**/README.md'
       - '**/LICENSE.md'
-      
+
   pull_request:
     types: [opened, reopened, synchronize]
 
-
+  workflow_dispatch:
+    inputs:
+      version_to_compare:
+        description: 'Name of branch to diff against current branch (default: develop)'
+        default: 'develop'
 
 jobs:
+  # New job to determine which branches to test
+  setup-matrix:
+    runs-on: ubuntu-latest
+    outputs:
+      branches: ${{ steps.set-branches.outputs.branches }}
+      python-versions: ${{ steps.set-py-versions.outputs.versions }}
+    steps:
+      - id: set-py-versions
+        run: echo "versions=[\"3.12\", \"3.14\"]" >> $GITHUB_OUTPUT
+      - id: set-branches
+        run: |
+          if [ "${{ github.event_name }}" == "pull_request" ]; then
+            echo "branches=[\"${{ github.head_ref }}\", \"${{ github.base_ref }}\"]" >> $GITHUB_OUTPUT
+          elif [ "${{ github.event_name }}" == "workflow_dispatch" ]; then
+            echo "branches=[\"${{ github.ref_name }}\", \"${{ github.event.inputs.version_to_compare }}\"]" >> $GITHUB_OUTPUT
+          else
+            echo "branches=[\"${{ github.ref_name }}\"]" >> $GITHUB_OUTPUT
+          fi
+
   build:
 
+    needs: setup-matrix
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.12"]
+        python-version: ${{ fromJSON(needs.setup-matrix.outputs.python-versions) }}
+        branch: ${{ fromJSON(needs.setup-matrix.outputs.branches) }}
 
     steps:
-    - uses: actions/checkout@v4
+    # checkout METplotpy
+    - uses: actions/checkout@v6
+      with:
+        ref: ${{ matrix.branch }}
+
+    # checkout METcalcpy
+    - uses: actions/checkout@v6
+      with:
+        repository: dtcenter/METcalcpy
+        path: METcalcpy
+        ref: develop
+
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
-
-    - name: Retrieve METcalcpy repository develop  branch
-      run: |
-         metcalcpy_dir="$RUNNER_WORKSPACE/METcalcpy"
-         git clone https://github.com/dtcenter/METcalcpy ${metcalcpy_dir}
-         cd ${metcalcpy_dir}
-         git -C ${metcalcpy_dir} checkout develop
-         python -m pip install -e ${metcalcpy_dir}
-
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
+
+        # force pandas to be less than 3.0.0 for Python 3.12 to test for backward compatibility
+        if [ ${{ matrix.python-version }} == "3.12" ]; then pip install "pandas<3"; fi
+
+        python -m pip install -e METcalcpy
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-        pip install --upgrade kaleido
-
-
-#    - uses: browser-actions/setup-chrome@v1
-#    - name: Install Google Chrome for Plotly
-#      run: |
-#          chrome --version
-#          ${{ steps.setup-chrome.outputs.chrome-path }} 
-
-
-
-#   Checking the branch name, not necessary but useful when setting things up. 
-#     - name: Extract branch name
-#       shell: bash
-#       run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
-#       id: extract_branch
+
+    - name: Download additional input data
+      run: |
+        mkdir -p ${{ runner.workspace }}/test_input
+        wget -P ${{ runner.workspace }}/test_input \
+        https://dtcenter.ucar.edu/dfiles/code/METplus/METplotpy_Data/develop/sample_data_METplotpy.tgz
+        tar -xzf ${{ runner.workspace }}/test_input/sample_data_METplotpy.tgz -C ${{ runner.workspace }}/test_input
 
     - name: Test with pytest
       run: |
+        export METPLOTPY_TEST_OUTPUT=${{ runner.workspace }}/output/${{ matrix.branch }}
+        export METPLOTPY_TEST_INPUT=${{ runner.workspace }}/test_input/METplotpy_Data
         pytest
+
+    - name: Upload output data artifact
+      uses: actions/upload-artifact@v6
+      with:
+        name: test_output_${{ matrix.branch }}_${{ matrix.python-version }}
+        path: ${{ runner.workspace }}/output/${{ matrix.branch }}/test_output
+
+  compare-output:
+    needs: [setup-matrix, build]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ${{ fromJSON(needs.setup-matrix.outputs.python-versions) }}
+
+    # Only run if there are exactly 2 branches to compare
+    if: fromJSON(needs.setup-matrix.outputs.branches)[1] != null
+    steps:
+      - name: Download artifacts
+        run: |
+          mkdir -p "${{ runner.workspace }}/artifacts"
+          gh run download --repo "$GITHUB_REPOSITORY" "$GITHUB_RUN_ID" --dir "${{ runner.workspace }}/artifacts"
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+      - name: Checkout diff_util.py from METplus
+        uses: actions/checkout@v6
+        with:
+          repository: dtcenter/METplus
+          ref: develop
+          sparse-checkout: |
+            metplus/util/diff_util.py
+          sparse-checkout-cone-mode: false
+          path: METplus
+
+      - name: Set up Python for diff_util.py
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies for diff
+        run: |
+          pip install pillow pandas numpy netCDF4
+
+      - name: Run diff_util.py
+        run: |
+          # Extract branch names from the setup-matrix output
+          # assumes 1st branch is the current branch and the 2nd branch is the truth data
+          OUTPUT_BRANCH=$(echo '${{ needs.setup-matrix.outputs.branches }}' | jq -r '.[0]')
+          TRUTH_BRANCH=$(echo '${{ needs.setup-matrix.outputs.branches }}' | jq -r '.[1]')
+
+          # Define paths to the downloaded data
+          # Note: upload-artifact v4 nested paths differently, usually named by 'name' provided in upload
+          OUTPUT_DIR="${{ runner.workspace }}/artifacts/test_output_${OUTPUT_BRANCH}_${{ matrix.python-version }}"
+          TRUTH_DIR="${{ runner.workspace }}/artifacts/test_output_${TRUTH_BRANCH}_${{ matrix.python-version }}"
+          DIFF_DIR="${{ runner.workspace }}/diff_${{ matrix.python-version }}"
+
+          echo "Comparing $OUTPUT_DIR and $TRUTH_DIR"
+
+          # Ensure directories exist before running script
+          if [ -d "$OUTPUT_DIR" ] && [ -d "$TRUTH_DIR" ]; then
+            export METPLUS_DIFF_SKIP_KEYWORDS=".html,_rank.png"
+            python METplus/metplus/util/diff_util.py "$TRUTH_DIR" "$OUTPUT_DIR" --debug --save_diff --diff_dir "$DIFF_DIR"
+          else
+            echo "One or both data directories are missing."
+            ls ${{ runner.workspace }}/artifacts
+            exit 1
+          fi
+
+      - name: Upload diff artifact
+        if: always()
+        uses: actions/upload-artifact@v7
+        with:
+          name: diff_${{ matrix.python-version }}
+          path: ${{ runner.workspace }}/diff_${{ matrix.python-version }}
+          if-no-files-found: ignore

.github/workflows/vulnerabilities.yaml

@@ -22,7 +22,7 @@ jobs:
   selftest:
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - name: install
         run: |
           python -m venv env/

.gitignore

@@ -14,3 +14,5 @@ __pycache__/
 # files that are generated when package is installed
 build/
 metplotpy.egg-info/
+
+.DS_Store

docs/Users_Guide/histogram.rst

@@ -96,7 +96,7 @@ configuration file, which serves as a starting point for creating a
 will be built.
 
 **NOTE**: This default configuration file is automatically loaded by
-**histogram.py, rank_hist.py, prob_hist.py, and rel_hist.py.**
+**hist.py, rank_hist.py, prob_hist.py, and rel_hist.py.**
 
 
 .. literalinclude:: ../../metplotpy/plots/config/hist_defaults.yaml

docs/Users_Guide/release-notes.rst

@@ -10,7 +10,6 @@ describes the bugfix, enhancement, or new feature:
 METplotpy Version 4.0.0-beta1 release notes (20260205)
 ======================================================
 
-
 .. dropdown:: New Plots
 
    None

docs/Users_Guide/reliability_diagram.rst

@@ -160,7 +160,7 @@ corresponding to the *plot_filename* setting in the default
 configuration file. Otherwise, this will need to be specified in
 *plot_filename* in the **minimal_box.yaml** file):
 
-.. literalinclude:: ../../test/reliability_diagram/custom_reliability_use_defaults.yaml
+.. literalinclude:: ../../test/reliability_diagram/minimal_reliability.yaml
 
 Copy this file to the working directory:
 

docs/copyright.txt

@@ -1,5 +1,5 @@
 # ============================*
-# ** Copyright UCAR (c) 1992 - 2024
+# ** Copyright UCAR (c) 1992 - 2026
 # ** University Corporation for Atmospheric Research (UCAR)
 # ** National Center for Atmospheric Research (NCAR)
 # ** Research Applications Lab (RAL)