Merge pull request #37 from sidratresearch/sidrat-staging

Rail v2.0: Updates for interactive and ephemeral DataStore functionality changes

Author: jscora

.github/ISSUE_TEMPLATE/0-general_issue.md

@@ -5,4 +5,4 @@ title: ''
 labels: ''
 assignees: ''
 
----
+---

.pre-commit-config.yaml

@@ -1,14 +1,13 @@
 fail_fast: true
 repos:
-
-    # Clear output from jupyter notebooks so that only the input cells are committed.
+  # Clear output from jupyter notebooks so that only the input cells are committed.
   - repo: local
     hooks:
       - id: jupyter-nb-clear-output
         name: Clear output from Jupyter notebooks
         description: Clear output from Jupyter notebooks.
         files: \.ipynb$
-        stages: [commit]
+        stages: [pre-commit]
         language: system
         entry: jupyter nbconvert --clear-output
 
@@ -22,7 +21,8 @@ repos:
       - id: check-added-large-files
         name: Check for large files
         description: Prevent the user from committing very large files.
-        args: ['--maxkb=500']
+        args: ["--maxkb=500"]
+      - id: end-of-file-fixer
 
     # verify that pyproject.toml is well formed
   - repo: https://github.com/abravalheri/validate-pyproject
@@ -31,6 +31,21 @@ repos:
       - id: validate-pyproject
         name: Validate pyproject.toml
         description: Verify that pyproject.toml adheres to the established schema.
+
+  # use the black code formatter
+  - repo: https://github.com/psf/black-pre-commit-mirror
+    # Using this mirror lets us use mypyc-compiled black, which is about 2x faster
+    rev: 25.9.0
+    hooks:
+      - id: black
+
+  # use the isort code formatter
+  - repo: https://github.com/pycqa/isort
+    rev: 7.0.0
+    hooks:
+      - id: isort
+        args: ["--profile", "black", "--filter-files"]
+
     # Analyze the src code style and report code that doesn't adhere.
   - repo: local
     hooks:
@@ -40,11 +55,11 @@ repos:
         language: system
         types: [python]
         files: ^src/
-        args:
-          [
+        args: [
             "-rn", # Only display messages
             "-sn", # Don't display the score
           ]
+
     # Analyze the tests code style and report code that doesn't adhere.
   - repo: local
     hooks:
@@ -54,14 +69,13 @@ repos:
         language: system
         types: [python]
         files: ^tests/
-        args:
-          [
+        args: [
             "-rn", # Only display messages
             "-sn", # Don't display the score
           ]
 
     # Run unit tests, verify that they pass. Note that coverage is run against
-    # the ./src directory here because that is what will be committed. In the 
+    # the ./src directory here because that is what will be committed. In the
     # github workflow script, the coverage is run against the installed package
     # and uploaded to Codecov by calling pytest like so:
     # `python -m pytest --cov=<package_name> --cov-report=xml`
@@ -73,4 +87,4 @@ repos:
         entry: bash -c "if python -m pytest --co -qq; then python -m pytest --cov=./src --cov-report=html; fi"
         language: system
         pass_filenames: false
-        always_run: true
+        always_run: true

README.md

@@ -51,4 +51,3 @@ If you use this package, you should also cite the appropriate papers for each
 code used.  A list of such codes is included in the 
 [Citing RAIL](https://lsstdescrail.readthedocs.io/en/stable/source/citing.html)
 section of the main RAIL Read The Docs page.
-

pyproject.toml

@@ -1,10 +1,10 @@
 [project]
 name = "pz-rail-tpz"
 requires-python = ">=3.10"
-license = {file = "LICENSE"}
+license = { file = "LICENSE" }
 readme = "README.md"
 authors = [
-    { name = "LSST Dark Energy Science Collaboration (DESC)", email = "samschmidt@ucdavis.edu" }
+    { name = "LSST Dark Energy Science Collaboration (DESC)", email = "samschmidt@ucdavis.edu" },
 ]
 classifiers = [
     "Development Status :: 4 - Beta",
@@ -20,7 +20,7 @@ dependencies = [
     "astropy",
     "mpi4py",
     "pandas",
-    "pz-rail-base>=1.1.4",
+    "pz-rail-base>=2.0.0-dev",
     "qp-prob[full]",
     "scikit-learn",
 ]
@@ -31,12 +31,12 @@ dev = [
     "pytest",
     "pytest-cov", # Used to report total code coverage
     "pre-commit", # Used to run checks before finalizing a git commit
-    "pylint", # Used for static linting of files
+    "pylint",     # Used for static linting of files
 ]
 
 [build-system]
 requires = [
-    "setuptools>=62", # Used to build and package the Python project
+    "setuptools>=62",      # Used to build and package the Python project
     "setuptools_scm>=6.2", # Gets release version from git. Makes it available programmatically
 ]
 build-backend = "setuptools.build_meta"
@@ -45,13 +45,8 @@ build-backend = "setuptools.build_meta"
 write_to = "src/rail/rail_tpz/_version.py"
 
 [tool.pytest.ini_options]
-testpaths = [
-    "tests",
-]
-addopts = [
-    "--cov=rail",
-    "--cov-report=html"
-]
+testpaths = ["tests"]
+addopts = ["--cov=rail", "--cov-report=html"]
 
 [tool.pylint]
 disable = [