Refactor of Weac

.cursorignore

@@ -0,0 +1,6 @@
+/docs/
+/.venv/
+/data/
+/img/
+/demo/
+/LICENSE

.github/workflows/format.yml

@@ -1,6 +1,6 @@
 name: Make sure code is ruff-formatted 🐶
 
-on:
+"on":
   # Run format checks on pull_request events
   pull_request:
     types: [opened, reopened, synchronize, ready_for_review]
@@ -14,21 +14,21 @@ jobs:
     name: Make sure code is ruff-formatted 🐶
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Set up Python 3.12
-      uses: actions/setup-python@v5
-      with:
-        python-version: '3.12'
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
 
-    - name: Install dependencies
-      shell: bash -el {0}
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install ruff
-        python -m pip install -e ".[dev]"
+      - name: Install dependencies
+        run: |
+          # Setup pip
+          python -m pip install --upgrade pip
+          # Install dependencies including ruff
+          python -m pip install -e ".[dev]"
 
-    - name: Check formatting with ruff
-      run: |
-        python -m ruff format . --check
-        python -m ruff check . 
+      - name: Check formatting with ruff
+        run: |
+          ruff format . --check
+          ruff check .

.github/workflows/pylint.yml

@@ -1,6 +1,6 @@
 name: Static code analysis 🔎
 
-on:
+"on":
   # Run static code analysis on pull_request events
   pull_request:
     types: [opened, reopened, synchronize, ready_for_review]
@@ -14,31 +14,54 @@ jobs:
     name: Static code analysis 🔎
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Set up Python 3.12
-      uses: actions/setup-python@v5
-      with:
-        python-version: '3.12'
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: "pip"
 
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install pylint
-        python -m pip install -e ".[dev]"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
 
-    - name: Run pylint analysis
-      # Using .pylintrc with comprehensive configuration for scientific code
-      run: |
-        python -m pylint --output-format=parseable --output=pylint-report.txt weac/ tests/
-        echo
-        echo 'Error type counts:'
-        grep -oP '[A-Z]\d+\([a-z\-]+\)' pylint-report.txt | sort | uniq -c | sort -nr
-        echo
-        echo 'Errors per file:'
-        grep -oP '^[\w\-\/]+\.py' pylint-report.txt | sort | uniq -c | sort -nr
-        echo
-        echo 'Total errors:'
-        grep -oP '^[\w\-\/]+\.py' pylint-report.txt | wc -l
-        echo
-        grep 'Your code' pylint-report.txt 
+      - name: Run pylint analysis
+        # Using repository pylint config (pyproject.toml) with comprehensive settings for scientific code
+        run: |
+          exit_code=0
+          python -m pylint --output-format=parseable --output=pylint-report.txt weac/ tests/ || exit_code=$?
+          echo "Pylint finished with exit code $exit_code."
+          echo
+          echo "Pylint exit code meaning:"
+          if [ $exit_code -eq 0 ]; then echo "-> No issues found"; fi
+          if [ $((exit_code & 1)) -ne 0 ]; then echo "-> Fatal message issued"; fi
+          if [ $((exit_code & 2)) -ne 0 ]; then echo "-> Error message issued"; fi
+          if [ $((exit_code & 4)) -ne 0 ]; then echo "-> Warning message issued"; fi
+          if [ $((exit_code & 8)) -ne 0 ]; then echo "-> Refactor message issued"; fi
+          if [ $((exit_code & 16)) -ne 0 ]; then echo "-> Convention message issued"; fi
+          if [ $((exit_code & 32)) -ne 0 ]; then echo "-> Usage error"; fi
+          echo
+
+          echo 'Error type counts:'
+          grep -oP '[A-Z]\d+\([a-z\-]+\)' pylint-report.txt | sort | uniq -c | sort -nr
+          echo
+          echo 'Errors per file:'
+          grep -oP '^[\w\-\/]+\.py' pylint-report.txt | sort | uniq -c | sort -nr
+          echo
+          echo 'Total errors:'
+          grep -oP '^[\w\-\/]+\.py' pylint-report.txt | wc -l
+          echo
+          grep 'Your code' pylint-report.txt || true
+
+          # Fail on fatal, error, and usage error.
+          # These are severe and should block PRs.
+          # Warnings (4), refactors (8), and conventions (16) will not cause a failure.
+          fail_on_codes=$((1 | 2 | 32))
+          if [ $((exit_code & fail_on_codes)) -ne 0 ]; then
+            echo "Failing CI due to fatal/error/usage messages from pylint."
+            exit 1
+          else
+            echo "Pylint check passed. No fatal/error/usage messages."
+          fi

.github/workflows/tests.yml

@@ -1,8 +1,8 @@
 name: Run unit tests 🤖
 
 # Trigger conditions for the workflow
-on:
-  # Run tests on pull_request events
+"on":
+  # Run unit tests on pull_request events
   pull_request:
     types: [opened, reopened, synchronize, ready_for_review]
   # Allow this workflow to be called by other workflows
@@ -15,17 +15,20 @@ jobs:
     name: Run unit tests 🤖
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
-    - name: Set up Python 3.12
-      uses: actions/setup-python@v5
-      with:
-        python-version: '3.12'
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: 'pip'
+          cache-dependency-path: |
+            pyproject.toml
+          check-latest: true
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e .
 
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install -e .
-
-    - name: Run tests
-      run: python tests/run_tests.py 
+      - name: Run tests
+        run: python tests/run_tests.py

.gitignore

@@ -18,10 +18,32 @@ dist/
 # IDE setup
 .vscode/
 
+# Environments
+.venv/
+venv/
+.python-version
+.weac-reference/
+.venv*
+
+# Secrets
+.env
+.env.local
+.env.*
+
+# Caches
+.ruff_cache/
+.pytest_cache/
+.mypy_cache/
+
+# Coverage
+.coverage
+coverage.xml
 # misc
 *.stats
 plots/
 test/
 scratch/
+temp*
+old*
 
 .weac-reference/

.gitmodules

@@ -0,0 +1,5 @@
+[submodule "data"]
+	path = data
+	url = https://github.com/2phi/weac-data-hub.git
+	shallow = true
+	branch = main