Merge pull request #32 from lanl/repo_config_adjust_3rd_attemp

Enable checks and add placeholder modules for future implementation

.github/workflows/unittest.yaml

@@ -4,9 +4,11 @@ on:
   pull_request:
     branches:
       - main
+      - v2.0
   push:
     branches:
       - main
+      - v2.0
 
 jobs:
   test:

.pre-commit-config.yaml

@@ -9,20 +9,20 @@ repos:
       args: [--allow-multiple-documents]
       exclude: "conda.recipe/meta.yaml"
     - id: end-of-file-fixer
-      exclude: "tests/data/.*"
+      exclude: "(tests/data/.*|src/pleiades/data/.*)"
     - id: trailing-whitespace
-      exclude: "tests/data/.*"
+      exclude: "(tests/data/.*|src/pleiades/data/.*)"
 - repo: https://github.com/astral-sh/ruff-pre-commit
   rev: v0.7.3
   hooks:
     - id: ruff
       args: [--fix, --exit-non-zero-on-fix]
-      exclude: "(tests/data/.*|legacy/.*)"
+      exclude: "(tests/data/.*|legacy/.*|src/pleiades/data/.*)"
     - id: ruff-format
-      exclude: "(tests/data/.*|legacy/.*)"
+      exclude: "(tests/data/.*|legacy/.*|src/pleiades/data/.*)"
 - repo: https://github.com/codespell-project/codespell
   rev: v2.3.0
   hooks:
     - id: codespell
-      exclude: "(tests/data/.*|.*\\.ipynb)|poetry.lock"
+      exclude: "(tests/data/.*|.*\\.ipynb|poetry.lock|src/pleiades/data/.*)"
       args: ["--ignore-words-list=DELTE"]

README.rst

@@ -1,9 +1,8 @@
-.. image:: ./docs/images/PLEIADES.jpg
-   :alt: **PLEIADES:** Python Libraries Extensions for Isotopic Analysis via Detailed Examination of SAMMY.
-   :align: center
-
 PLEIADES
 ========
+.. image:: https://results.pre-commit.ci/badge/github/lanl/PLEIADES/main.svg
+   :target: https://results.pre-commit.ci/latest/github/lanl/PLEIADES/main
+   :alt: pre-commit.ci status
 
 .. image:: https://readthedocs.org/projects/example-sphinx-basic/badge/?version=latest
    :target: https://pleiades-sammy.readthedocs.io/en/latest/

src/pleiades/sammy/parameters/background.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python
+"""Background function card for SAMMY.
+
+TODO: This card will be implemented in the future.
+"""

src/pleiades/sammy/parameters/det_efficiency.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python
+"""Detector efficiency function card for SAMMY.
+
+TODO: This card will be implemented in the future.
+"""

src/pleiades/sammy/parameters/resolution.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python
+"""Resolution function card for SAMMY.
+
+TODO: This module will be implemented in the future.
+"""

tests/unit/pleiades/sammy/parameters/test_background.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+"""Tests for the background function card.
+
+TODO: This test will be implemented in the future when the card is implemented.
+"""
+
+import pytest
+
+if __name__ == "__main__":
+    pytest.main(["-v", __file__])

tests/unit/pleiades/sammy/parameters/test_det_efficiency.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python
+"""Tests for the detector efficiency function card.
+
+
+TODO: This test will be implemented in the future when the card is implemented.
+"""
+
+import pytest
+
+if __name__ == "__main__":
+    pytest.main(["-v", __file__])

tests/unit/pleiades/sammy/parameters/test_resolution.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+"""Tests for the resolution function card.
+
+TODO: This test will be implemented in the future when the card is implemented.
+"""
+
+import pytest
+
+if __name__ == "__main__":
+    pytest.main(["-v", __file__])