Add new algorithms (DREAM and HERMES)

.github/workflows/ci.yml

@@ -0,0 +1,59 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  # 1) Run the test suite against every supported Python version.
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          uv sync --all-extras
+
+      - name: Run tests
+        run: |
+          uv run pytest -v
+
+  # 2) Lint and formatting checks with ruff.
+  lint:
+    name: Lint & format (ruff)
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Install dependencies
+        run: |
+          uv sync --group dev
+
+      - name: Ruff lint
+        run: |
+          uv run ruff check .
+
+      - name: Ruff format check
+        run: |
+          uv run ruff format --check .

groupselect/__init__.py

@@ -1,7 +1,13 @@
+"""GroupSelect: allocate participants into diverse groups."""
+
 from groupselect.algorithms import Algorithm
 from groupselect.field_mode import FieldMode
 from groupselect.allocate_numpy import allocate_numpy
-from groupselect.allocation import Allocation, AllocationEnsemble, AllocatorResult
+from groupselect.allocation import (
+    Allocation,
+    AllocationEnsemble,
+    AllocatorResult,
+)
 
 
 try:

groupselect/algorithms/__init__.py

@@ -1,3 +1,5 @@
+"""Available allocation algorithms and lookup of their implementations."""
+
 from enum import Enum, unique
 from importlib import import_module
 
@@ -7,14 +9,20 @@
 # Define Enum data type for different algorithms
 @unique
 class Algorithm(Enum):
+    """Identifier for a supported allocation algorithm."""
+
     Legacy = 0
-    # Heuristic = 1  # TODO: Add heuristic algorithm
+    DREAM = 1
+    HERMES = 2
+
 
 # Define functions of algorithms.
 algorithm_funcs = {
     algorithm: getattr(
-        import_module('groupselect.algorithms.algorithm_' + algorithm.name.lower()),
-        'algorithm_' + algorithm.name.lower()
+        import_module(
+            "groupselect.algorithms.algorithm_" + algorithm.name.lower()
+        ),
+        "algorithm_" + algorithm.name.lower(),
     )
     for algorithm in Algorithm
 }