Merge pull request #7 from mrecos/codex/readme-ci-refresh

Refresh README and add executable CI documentation

Author: mrecos

.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.12"]
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+          cache-dependency-path: pyproject.toml
+
+      - name: Install package and development tools
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install -e ".[dev]"
+
+      - name: Run tests
+        run: python -m pytest tests/ -q
+
+      - name: Check formatting
+        if: matrix.python-version == '3.12'
+        run: python -m black --check klrfome tests examples benchmarks/run_section6_sensitivity.py
+
+      - name: Run Ruff
+        if: matrix.python-version == '3.12'
+        run: python -m ruff check klrfome tests examples benchmarks/run_section6_sensitivity.py
+
+      - name: Run Mypy
+        if: matrix.python-version == '3.12'
+        run: python -m mypy klrfome
+
+      - name: Execute README smoke workflow
+        if: matrix.python-version == '3.12'
+        run: python examples/readme_quickstart.py