dkist-processing-math 2.2.0rc1__tar.gz → 2.2.1__tar.gz

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.4.0
+    rev: v5.0.0
     hooks:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
@@ -10,14 +10,14 @@ repos:
     -   id: check-added-large-files
     -   id: debug-statements
 -   repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 25.1.0
     hooks:
     -   id: black
-        args: [ "-l 100" ]
--   repo: https://github.com/asottile/reorder_python_imports
-    rev: v2.3.5
+-   repo: https://github.com/pycqa/isort
+    rev: 5.12.0
     hooks:
-    -   id: reorder-python-imports
+    -   id: isort
+        name: isort (python)
 -   repo: https://github.com/pycqa/pydocstyle
     rev: 6.1.1  # pick a git hash / tag to point to
     hooks:

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/CHANGELOG.rst

@@ -1,3 +1,31 @@
+v2.2.1 (2025-08-30)
+===================
+
+Misc
+----
+
+- Add code coverage badge to README.rst. (`#21 <https://bitbucket.org/dkistdc/dkist-processing-math/pull-requests/21>`__)
+- Removing usage of the deprecated `pkg_resources`. (`#22 <https://bitbucket.org/dkistdc/dkist-processing-math/pull-requests/22>`__)
+- Update pre-commit hook versions and replace python-reorder-imports with isort. (`#23 <https://bitbucket.org/dkistdc/dkist-processing-math/pull-requests/23>`__)
+
+
+v2.2.0 (2025-02-24)
+===================
+
+Features
+--------
+
+- Add `stddev_numpy_arrays` function for computing the per-pixel standard deviation of an iterable of arrays.
+  If a `generator` is provided this function is very memory-light, even for huge stacks of arrays. (`#20 <https://bitbucket.org/dkistdc/dkist-processing-math/pull-requests/20>`__)
+
+
+Misc
+----
+
+- Update bitbucket pipelines to use common scripts for checking for changelog snippets and verifying doc builds. (`#18 <https://bitbucket.org/dkistdc/dkist-processing-math/pull-requests/18>`__)
+- Update Bitbucket pipelines to use execute script for standard steps. (`#19 <https://bitbucket.org/dkistdc/dkist-processing-math/pull-requests/19>`__)
+
+
 v2.1.2 (2024-12-20)
 ===================
 

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: dkist-processing-math
-Version: 2.2.0rc1
+Version: 2.2.1
 Summary: Common math functionality used in the DKIST calibrations suite
 Author-email: NSO / AURA <dkistdc@nso.edu>
 License: BSD-3-Clause
@@ -36,6 +36,8 @@ Requires-Dist: dkist-sphinx-theme; extra == "docs"
 dkist-processing-math
 =====================
 
+|codecov|
+
 dkist-processing-math contains the math functions used throughout the DKIST data processing software stack.
 
 
@@ -105,3 +107,6 @@ then the Bitbucket pipeline will fail. To be able to use the same tag you must d
     # Re-tag with the same version
     git tag vWHATEVER.THE.VERSION
     git push --tags origin main
+
+.. |codecov| image:: https://codecov.io/bb/dkistdc/dkist-processing-math/graph/badge.svg?token=N0SF93JM6R
+   :target: https://codecov.io/bb/dkistdc/dkist-processing-math

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/README.rst

@@ -1,6 +1,8 @@
 dkist-processing-math
 =====================
 
+|codecov|
+
 dkist-processing-math contains the math functions used throughout the DKIST data processing software stack.
 
 
@@ -70,3 +72,6 @@ then the Bitbucket pipeline will fail. To be able to use the same tag you must d
     # Re-tag with the same version
     git tag vWHATEVER.THE.VERSION
     git push --tags origin main
+
+.. |codecov| image:: https://codecov.io/bb/dkistdc/dkist-processing-math/graph/badge.svg?token=N0SF93JM6R
+   :target: https://codecov.io/bb/dkistdc/dkist-processing-math

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/bitbucket-pipelines.yml

@@ -11,37 +11,44 @@ definitions:
           - chmod 755 ci_scripts/latest/execute_script.sh
         artifacts:
           - ci_scripts/latest/execute_script.sh
+
     - step: &lint
         caches:
           - pip
         name: Lint
         script:
           - ./ci_scripts/latest/execute_script.sh lint_python.sh
+
     - step: &changelog
         caches:
           - pip
         name: Changelog
         script:
           - ./ci_scripts/latest/execute_script.sh check_changelog.sh
+
     - step: &scan
         caches:
           - pip
         name: Scan
         script:
           - ./ci_scripts/latest/execute_script.sh scan_python.sh
+
     - step: &test
         caches:
           - pip
         name: Test
         script:
           - pip install .[test]
-          - pytest --cov -m "not development" dkist_processing_math
+          - pytest --cov -m "not development" dkist_processing_math --cov-report=xml --cov-report=term-missing
+          - ./ci_scripts/latest/execute_script.sh upload_coverage.sh
+
     - step: &docs
         name: Build Docs
         caches:
           - pip
         script:
           - ./ci_scripts/latest/execute_script.sh test_sphinx.sh
+
     - step: &push
         caches:
           - pip

dkist_processing_math-2.2.1/dkist_processing_math/__init__.py

@@ -0,0 +1,10 @@
+"""init."""
+
+from importlib.metadata import PackageNotFoundError
+from importlib.metadata import version
+
+try:
+    __version__ = version(distribution_name=__name__)
+except PackageNotFoundError:
+    # package is not installed
+    __version__ = "unknown"

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/dkist_processing_math/arithmetic.py

@@ -1,4 +1,5 @@
 """Arithmetic."""
+
 from typing import Generator
 from typing import Iterable
 from typing import Union

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/dkist_processing_math/feature.py

@@ -1,4 +1,5 @@
 """Feature finding."""
+
 from typing import Callable
 from typing import Tuple
 

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/dkist_processing_math/linear_algebra.py

@@ -1,4 +1,5 @@
 """Linear algebra functions."""
+
 import numpy as np
 
 

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/dkist_processing_math/statistics.py

@@ -1,4 +1,5 @@
 """Statistics."""
+
 from typing import Iterable
 from typing import Union
 
@@ -65,7 +66,7 @@ def stddev_numpy_arrays(arrays: Iterable[np.ndarray]) -> np.ndarray:
     Parameters
     ----------
     arrays
-        The arrays to be to compute the standard deviation of
+        The arrays to be to compute the standard deviation of. Must be an Iterator of at least two arrays.
 
     Returns
     -------
@@ -82,16 +83,16 @@ def stddev_numpy_arrays(arrays: Iterable[np.ndarray]) -> np.ndarray:
     for array in arrays:
         count += 1
         try:
-            delta = array - running_mean
+            diff_from_prev_mean = array - running_mean
         except ValueError:
             raise ValueError(
                 f"All arrays must be the same shape. "
                 f"Shape of initial array = {running_mean.shape} "
                 f"Shape of current array = {array.shape}"
             )
-        running_mean += delta / count
-        delta2 = array - running_mean
-        running_M2 += delta * delta2
+        running_mean += diff_from_prev_mean / count
+        diff_from_current_mean = array - running_mean
+        running_M2 += diff_from_prev_mean * diff_from_current_mean
 
     match count:
         case 0:

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/dkist_processing_math/transform/__init__.py

@@ -1,4 +1,5 @@
 """init."""
+
 from .affine import affine_transform_arrays
 from .affine import rotate_arrays_about_point
 from .affine import rotation_matrix

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/dkist_processing_math/transform/affine.py

@@ -1,4 +1,5 @@
 """Affine transforms."""
+
 from functools import partial
 from typing import Iterable
 from typing import Iterator

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/dkist_processing_math/transform/binary.py

@@ -1,4 +1,5 @@
 """Functionality for binary images."""
+
 import numpy
 import numpy as np
 from skimage import filters as skif

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/dkist_processing_math/transform/binning.py

@@ -1,4 +1,5 @@
 """Binning transforms."""
+
 from functools import partial
 from typing import Iterable
 from typing import Iterator

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/dkist_processing_math/transform/hough.py

@@ -1,4 +1,5 @@
 """Hough transforms."""
+
 from typing import Tuple
 
 import numpy

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/dkist_processing_math.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: dkist-processing-math
-Version: 2.2.0rc1
+Version: 2.2.1
 Summary: Common math functionality used in the DKIST calibrations suite
 Author-email: NSO / AURA <dkistdc@nso.edu>
 License: BSD-3-Clause
@@ -36,6 +36,8 @@ Requires-Dist: dkist-sphinx-theme; extra == "docs"
 dkist-processing-math
 =====================
 
+|codecov|
+
 dkist-processing-math contains the math functions used throughout the DKIST data processing software stack.
 
 
@@ -105,3 +107,6 @@ then the Bitbucket pipeline will fail. To be able to use the same tag you must d
     # Re-tag with the same version
     git tag vWHATEVER.THE.VERSION
     git push --tags origin main
+
+.. |codecov| image:: https://codecov.io/bb/dkistdc/dkist-processing-math/graph/badge.svg?token=N0SF93JM6R
+   :target: https://codecov.io/bb/dkistdc/dkist-processing-math

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/dkist_processing_math.egg-info/SOURCES.txt

@@ -7,9 +7,6 @@ README.rst
 bitbucket-pipelines.yml
 pyproject.toml
 changelog/.gitempty
-changelog/18.misc.rst
-changelog/19.misc.rst
-changelog/20.feature.rst
 dkist_processing_math/__init__.py
 dkist_processing_math/arithmetic.py
 dkist_processing_math/feature.py

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/docs/conf.py

@@ -1,4 +1,5 @@
 """Configuration file for the Sphinx documentation builder."""
+
 # -- stdlib imports ------------------------------------------------------------
 import importlib
 import sys

{dkist_processing_math-2.2.0rc1 → dkist_processing_math-2.2.1}/pyproject.toml

@@ -98,3 +98,12 @@ show_missing = true
       directory = "doc"
       name = "Documentation"
       showcontent = true
+
+[tool.black]
+line-length = 100
+
+[tool.isort]
+profile = "black"
+force_single_line = true
+combine_as_imports = false
+line_length = 100

dkist_processing_math-2.2.0rc1/changelog/18.misc.rst

@@ -1 +0,0 @@
-Update bitbucket pipelines to use common scripts for checking for changelog snippets and verifying doc builds.

dkist_processing_math-2.2.0rc1/changelog/19.misc.rst

@@ -1 +0,0 @@
-Update Bitbucket pipelines to use execute script for standard steps.

dkist_processing_math-2.2.0rc1/changelog/20.feature.rst

@@ -1,2 +0,0 @@
-Add `stddev_numpy_arrays` function for computing the per-pixel standard deviation of an iterable of arrays.
-If a `generator` is provided this function is very memory-light, even for huge inputs.

dkist_processing_math-2.2.0rc1/dkist_processing_math/__init__.py

@@ -1,9 +0,0 @@
-"""init."""
-from pkg_resources import DistributionNotFound
-from pkg_resources import get_distribution
-
-try:
-    __version__ = get_distribution(__name__).version
-except DistributionNotFound:
-    # package is not installed
-    __version__ = "unknown"