feat: include the simple implementation & update docs

.github/workflows/python-package.yml

@@ -13,10 +13,10 @@ jobs:
 
     strategy:
       matrix:
-        python_version: ["3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
 
     concurrency:
-      group: ci-tests-${{ matrix.python_version }}-${{ github.ref }}
+      group: ci-tests-${{ matrix.python-version }}-${{ github.ref }}
       cancel-in-progress: true
 
     steps:
@@ -31,11 +31,6 @@ jobs:
         auto-update-conda: true
         conda-solver: libmamba
 
-    # - name: Run jupyterlab with PySUS
-    #   run: |
-    #     make run-jupyter-pysus
-        # make test-jupyter-pysus  ## takes too long
-
     - name: Linting & Tests
       run: |
         pip install poetry poetry-plugin-export
@@ -47,6 +42,12 @@ jobs:
         pip install -r reqs.txt
         pip install -e ".[dbc]"
 
-        pre-commit run --all-files
+        pre-commit run --files pysus/**/*
+
+        make test-pysus-with-coverage
 
-        make test-pysus
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v5
+      with:
+        files: ./coverage.xml
+        fail_ci_if_error: false

Makefile

@@ -54,6 +54,14 @@ test-jupyter-pysus: ## run pytest for notebooks inside jupyter container
 test-pysus: ## run tests quickly with the default Python
 	poetry run pytest -vv pysus/tests/ --retries 3 --retry-delay 15
 
+.PHONY: test-pysus-with-coverage
+test-pysus-with-coverage: ## run tests with coverage report
+	poetry run pytest -vv pysus/tests/ --retries 3 --retry-delay 15 --cov=pysus --cov-report=xml:coverage.xml --cov-report=term-missing
+
+.PHONY: lint
+lint:
+	pre-commit run --all-files
+
 # RELEASE
 # =======