Add CI/CD checks and CONTRIBUTING.md

.github/workflows/autopep8.yml

@@ -0,0 +1,34 @@
+name: autopep8 Check
+
+on: [pull_request]
+
+jobs:
+  autopep8-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install autopep8
+        run: pip install autopep8
+
+      - name: Check formatting with autopep8
+        id: check
+        run: |
+          # Check if autopep8 would make changes
+          formatting_issues=$(autopep8 --diff --recursive .)
+          if [[ formatting_issues ]] then
+            echo "Formatting issues found:"
+            printf "%s\n" "$formatting_issues"
+            echo "------------------------------"
+            echo "-- Formatting issues found! --"
+            echo "------------------------------"
+            exit 1
+          else
+            echo "No formatting issues found."
+          fi
+

.github/workflows/run-tests.yml

@@ -0,0 +1,34 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Run Acceptance and Unit tests
+
+on:
+  # push:
+  #   branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip   # upgrade pip to latest version
+        pip install ".[visualization]"        # install PyProject.toml dependencies (including optional dependencies)
+    - name: Test with pytest
+      run: |
+        python run_tests.py
+        #pytest # test unit tests only
+