dkist-processing-math 2.1.0rc1__tar.gz → 2.1.1__tar.gz

{dkist-processing-math-2.1.0rc1 → dkist_processing_math-2.1.1}/CHANGELOG.rst

@@ -1,3 +1,22 @@
+v2.1.1 (2024-10-14)
+===================
+
+Misc
+----
+
+- Make and publish wheels at code push in build pipeline (`#15 <https://bitbucket.org/dkistdc/dkist-processing-math/pull-requests/15>`__)
+- Switch from setup.cfg to pyproject.toml for build configuration (`#15 <https://bitbucket.org/dkistdc/dkist-processing-math/pull-requests/15>`__)
+
+
+v2.1.0 (2023-11-28)
+===================
+
+Features
+--------
+
+- Add functions to broadcast matrix multiplication over extra array dimensions. (`#14 <https://bitbucket.org/dkistdc/dkist-processing-math/pull-requests/14>`__)
+
+
 v2.0.0 (2023-06-29)
 ===================
 

{dkist-processing-math-2.1.0rc1 → dkist_processing_math-2.1.1}/PKG-INFO

@@ -1,25 +1,43 @@
 Metadata-Version: 2.1
 Name: dkist-processing-math
-Version: 2.1.0rc1
+Version: 2.1.1
 Summary: Common math functionality used in the DKIST calibrations suite
-Home-page: https://bitbucket.org/dkistdc/dkist_processing_math/src/master/
-Author: NSO / AURA
-Author-email: "dkistdc@nso.edu"
-License: MIT
+Author-email: NSO / AURA <dkistdc@nso.edu>
+License: BSD-3-Clause
+Project-URL: Homepage, https://nso.edu/dkist/data-center/
+Project-URL: Repository, https://bitbucket.org/dkistdc/dkist-processing-math/
 Project-URL: Documentation, https://docs.dkist.nso.edu/projects/math
+Project-URL: Help, https://nso.atlassian.net/servicedesk/customer/portal/5
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+Requires-Dist: dkist-processing-common>=4.0.0
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: scikit-image>=0.21.0
+Requires-Dist: scipy>=1.11.0
+Requires-Dist: peakutils>=1.3.3
 Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+Requires-Dist: hypothesis; extra == "test"
+Requires-Dist: towncrier; extra == "test"
 Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-astropy; extra == "docs"
+Requires-Dist: sphinx-changelog; extra == "docs"
+Requires-Dist: sphinx-autoapi; extra == "docs"
+Requires-Dist: pytest; extra == "docs"
+Requires-Dist: towncrier; extra == "docs"
+Requires-Dist: dkist-sphinx-theme; extra == "docs"
 
 dkist-processing-math
 =====================
 
 dkist-processing-math contains the math functions used throughout the DKIST data processing software stack.
 
-* DKIST: https://nso.edu/telescopes/dki-solar-telescope/
 
 Development
 -----------

{dkist-processing-math-2.1.0rc1 → dkist_processing_math-2.1.1}/README.rst

@@ -3,7 +3,6 @@ dkist-processing-math
 
 dkist-processing-math contains the math functions used throughout the DKIST data processing software stack.
 
-* DKIST: https://nso.edu/telescopes/dki-solar-telescope/
 
 Development
 -----------

{dkist-processing-math-2.1.0rc1 → dkist_processing_math-2.1.1}/bitbucket-pipelines.yml

@@ -60,9 +60,10 @@ definitions:
           - pip
         name: Push
         script:
-          - python setup.py sdist
-          - pip install twine
-          - twine upload dist/*
+          - pip install -U pip
+          - pip install build twine
+          - python -m build --outdir wheelhouse .
+          - python -m twine upload --skip-existing wheelhouse/*
 
 pipelines:
   default:
@@ -73,6 +74,23 @@ pipelines:
       - step: *scan
       - step: *test
       - step: *docs
+  custom:
+    build_rc:  # I.e. skip the doc check (because we might have rc dependencies)
+      - variables:
+        - name: BITBUCKET_TAG
+          description: "Tag version to build (e.g., 'vX.Y.ZrcR')"
+      - step:
+          name: Validate Bitbucket pipeline input
+          script:
+            - git tag | grep -q ${BITBUCKET_TAG} || { echo Tag ${BITBUCKET_TAG} not found!; exit 1; }
+            - echo ${BITBUCKET_TAG} | grep -q "rc[0-9]\+$" || { echo Tag ${BITBUCKET_TAG} is not an rc. SHAME!; exit 1; }
+      - parallel:
+        - step: *lint
+        - step: *changelog
+      - parallel:
+        - step: *scan
+        - step: *test
+      - step: *push
   tags:
     'v*':
       - parallel:

{dkist-processing-math-2.1.0rc1 → dkist_processing_math-2.1.1}/dkist_processing_math/linear_algebra.py

@@ -14,6 +14,11 @@ def nd_left_matrix_multiply(*, vector_stack: np.ndarray, matrix_stack: np.ndarra
     and v is a vector with dimensions ([n1, ...nn], D2).
 
     The higher-order dimensions (n1, ...nn) can be anything (or nothing), but they must be the same for M and v.
+    A special case where either the matrix or vector has NO higher-order dimensions is also allowed; the result will be
+    the single matrix/vector broadcast over the higher-order dimensionality of the other element.
+
+    Processing inputs with different numbers of higher-order dummy dimensions (i.e., dimension of length 1), while
+    technically possible, is not supported because it would be unclear which input should set the output shape.
 
     Parameters
     ----------
@@ -29,13 +34,7 @@ def nd_left_matrix_multiply(*, vector_stack: np.ndarray, matrix_stack: np.ndarra
     np.ndarray
         ([n1, ...nn], D1) ND stack of vectors with length D1
     """
-    matrix_ND_shape = matrix_stack.shape[:-2]
-    vector_ND_shape = vector_stack.shape[:-1]
-    if matrix_ND_shape != vector_ND_shape:
-        raise ValueError(
-            f"Inputs must have the same shape for all but the last dimensions. "
-            f"{matrix_ND_shape} != {vector_ND_shape}"
-        )
+    _check_nd_dimensionality(matrix_stack=matrix_stack, vector_stack=vector_stack)
 
     matrix_shape = matrix_stack.shape[-2:]
     vector_size = vector_stack.shape[-1]
@@ -60,6 +59,11 @@ def nd_right_matrix_multiply(*, vector_stack: np.ndarray, matrix_stack: np.ndarr
     and v is a vector with dimensions ([n1, ...nn], D1).
 
     The higher-order dimensions (n1, ...nn) can be anything (or nothing), but they must be the same for M and v.
+    A special case where either the matrix or vector has NO higher-order dimensions is also allowed; the result will be
+    the single matrix/vector broadcast over the higher-order dimensionality of the other element.
+
+    Processing inputs with different numbers of higher-order dummy dimensions (i.e., dimension of length 1), while
+    technically possible, is not supported because it would be unclear which input should set the output shape.
 
     Parameters
     ----------
@@ -75,13 +79,7 @@ def nd_right_matrix_multiply(*, vector_stack: np.ndarray, matrix_stack: np.ndarr
     np.ndarray
         ([n1, ...nn], D1) ND stack of vectors with length D2
     """
-    matrix_ND_shape = matrix_stack.shape[:-2]
-    vector_ND_shape = vector_stack.shape[:-1]
-    if matrix_ND_shape != vector_ND_shape:
-        raise ValueError(
-            f"Inputs must have the same shape for all but the last dimensions. "
-            f"{matrix_ND_shape} != {vector_ND_shape}"
-        )
+    _check_nd_dimensionality(matrix_stack=matrix_stack, vector_stack=vector_stack)
 
     matrix_shape = matrix_stack.shape[-2:]
     vector_size = vector_stack.shape[-1]
@@ -92,3 +90,20 @@ def nd_right_matrix_multiply(*, vector_stack: np.ndarray, matrix_stack: np.ndarr
 
     result = np.sum(matrix_stack * vector_stack[..., :, None], axis=-2)
     return result
+
+
+def _check_nd_dimensionality(matrix_stack, vector_stack):
+    """
+    Check that the matrix and vector stacks have higher-order dimensions that can be broadcast together.
+
+    Enforces matrix stack shape[:-2] equals vector stack shape[:-1]. Raises a ValueError if the condition is not met.
+
+    A special case of a matrix or vector with no higher-order dimensions is allowed.
+    """
+    matrix_ND_shape = matrix_stack.shape[:-2]
+    vector_ND_shape = vector_stack.shape[:-1]
+    if matrix_ND_shape and vector_ND_shape and matrix_ND_shape != vector_ND_shape:
+        raise ValueError(
+            f"Inputs must have the same shape for all but the last dimensions. "
+            f"{matrix_ND_shape} != {vector_ND_shape}"
+        )

{dkist-processing-math-2.1.0rc1 → dkist_processing_math-2.1.1}/dkist_processing_math/tests/test_linear_algebra.py

@@ -22,23 +22,52 @@ def extra_dims(num_dims) -> tuple[int]:
 
 
 @pytest.fixture
-def matrix_stack(extra_dims, D1, D2) -> np.ndarray:
-    return np.random.random(extra_dims + (D1, D2))
+def matrix_stack(extra_dims: tuple[int, ...], single_matrix: bool, D1: int, D2: int) -> np.ndarray:
+    full_shape = extra_dims + (D1, D2)
+    if single_matrix:
+        full_shape = (D1, D2)
+    return np.random.random(full_shape)
 
 
 @pytest.fixture
-def left_vector_stack(extra_dims, D2) -> np.ndarray:
-    return np.random.random(extra_dims + (D2,))
+def left_vector_stack(extra_dims: tuple[int, ...], single_vector: bool, D2: int) -> np.ndarray:
+    full_shape = extra_dims + (D2,)
+    if single_vector:
+        full_shape = (D2,)
+    return np.random.random(full_shape)
 
 
 @pytest.fixture
-def right_vector_stack(extra_dims, D1) -> np.ndarray:
-    return np.random.random(extra_dims + (D1,))
+def right_vector_stack(extra_dims: tuple[int, ...], single_vector: bool, D1: int) -> np.ndarray:
+    full_shape = extra_dims + (D1,)
+    if single_vector:
+        full_shape = (D1,)
+    return np.random.random(full_shape)
 
 
 # Stopping at 7 for no real reason. We need 0 and 2 for sure and then others to confirm generality.
-@pytest.mark.parametrize("num_dims", [0, 1, 2, 3, 4, 5, 6, 7])
-def test_nd_left_matrix_multiply(matrix_stack, left_vector_stack, extra_dims, D1, D2, num_dims):
+# single_matrix = True tests the case where the matrix has no higher dimensions. Probably only need to test it once
+# but we do it twice just because.
+@pytest.mark.parametrize(
+    "num_dims, single_matrix, single_vector",
+    [
+        (0, False, False),
+        (1, False, False),
+        (2, False, False),
+        (2, True, False),
+        (2, False, True),
+        (3, False, False),
+        (4, False, False),
+        (4, False, True),
+        (5, False, False),
+        (5, True, False),
+        (6, False, False),
+        (7, False, False),
+    ],
+)
+def test_nd_left_matrix_multiply(
+    matrix_stack, left_vector_stack, extra_dims, single_matrix, single_vector, D1, D2, num_dims
+):
     """
     Given: Matrix and vector stacks with arbitrary higher dimensions
     When: Left matrix multiplying them
@@ -48,8 +77,19 @@ def test_nd_left_matrix_multiply(matrix_stack, left_vector_stack, extra_dims, D1
         expected = matrix_stack @ left_vector_stack
     else:
         flattened_size = np.prod(extra_dims)
-        flat_matrix = np.reshape(matrix_stack, (flattened_size, D1, D2))
-        flat_vector = np.reshape(left_vector_stack, (flattened_size, D2))
+
+        # If single_* is True then just tile it out to match the flattened size so the loop below works
+        flat_matrix = (
+            np.reshape(matrix_stack, (flattened_size, D1, D2))
+            if not single_matrix
+            else np.tile(matrix_stack[None, ...], (flattened_size, 1, 1))
+        )
+        flat_vector = (
+            np.reshape(left_vector_stack, (flattened_size, D2))
+            if not single_vector
+            else np.tile(left_vector_stack[None, ...], (flattened_size, 1))
+        )
+
         flat_expected = np.empty((flattened_size, D1))
         for i in range(flattened_size):
             flat_expected[i, :] = flat_matrix[i, :, :] @ flat_vector[i, :]
@@ -77,8 +117,29 @@ def test_nd_left_matrix_multiply_errors():
         )
 
 
-@pytest.mark.parametrize("num_dims", [0, 1, 2, 3, 4, 5, 6, 7])
-def test_nd_right_matrix_multiply(matrix_stack, right_vector_stack, extra_dims, D1, D2, num_dims):
+# Stopping at 7 for no real reason. We need 0 and 2 for sure and then others to confirm generality.
+# single_matrix = True tests the case where the matrix has no higher dimensions. Probably only need to test it once
+# but we do it twice just because.
+@pytest.mark.parametrize(
+    "num_dims, single_matrix, single_vector",
+    [
+        (0, False, False),
+        (1, False, False),
+        (2, False, False),
+        (2, True, False),
+        (2, False, True),
+        (3, False, False),
+        (3, True, False),
+        (4, False, False),
+        (5, False, False),
+        (5, False, True),
+        (6, False, False),
+        (7, False, False),
+    ],
+)
+def test_nd_right_matrix_multiply(
+    matrix_stack, right_vector_stack, extra_dims, single_matrix, single_vector, D1, D2, num_dims
+):
     """
     Given: Matrix and vector stacks with arbitrary higher dimensions
     When: Right matrix multiplying them
@@ -88,8 +149,20 @@ def test_nd_right_matrix_multiply(matrix_stack, right_vector_stack, extra_dims,
         expected = right_vector_stack @ matrix_stack
     else:
         flattened_size = np.prod(extra_dims)
-        flat_matrix = np.reshape(matrix_stack, (flattened_size, D1, D2))
-        flat_vector = np.reshape(right_vector_stack, (flattened_size, D1))
+
+        # If single_* is True then just tile it out to match the flattened size so the loop below works
+        flat_matrix = (
+            np.reshape(matrix_stack, (flattened_size, D1, D2))
+            if not single_matrix
+            else np.tile(matrix_stack[None, ...], (flattened_size, 1, 1))
+        )
+
+        flat_vector = (
+            np.reshape(right_vector_stack, (flattened_size, D1))
+            if not single_vector
+            else np.tile(right_vector_stack[None, ...], (flattened_size, 1))
+        )
+
         flat_expected = np.empty((flattened_size, D2))
         for i in range(flattened_size):
             flat_expected[i, :] = flat_vector[i, :] @ flat_matrix[i, :, :]

{dkist-processing-math-2.1.0rc1 → dkist_processing_math-2.1.1}/dkist_processing_math.egg-info/PKG-INFO

@@ -1,25 +1,43 @@
 Metadata-Version: 2.1
 Name: dkist-processing-math
-Version: 2.1.0rc1
+Version: 2.1.1
 Summary: Common math functionality used in the DKIST calibrations suite
-Home-page: https://bitbucket.org/dkistdc/dkist_processing_math/src/master/
-Author: NSO / AURA
-Author-email: "dkistdc@nso.edu"
-License: MIT
+Author-email: NSO / AURA <dkistdc@nso.edu>
+License: BSD-3-Clause
+Project-URL: Homepage, https://nso.edu/dkist/data-center/
+Project-URL: Repository, https://bitbucket.org/dkistdc/dkist-processing-math/
 Project-URL: Documentation, https://docs.dkist.nso.edu/projects/math
+Project-URL: Help, https://nso.atlassian.net/servicedesk/customer/portal/5
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+Requires-Dist: dkist-processing-common>=4.0.0
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: scikit-image>=0.21.0
+Requires-Dist: scipy>=1.11.0
+Requires-Dist: peakutils>=1.3.3
 Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+Requires-Dist: hypothesis; extra == "test"
+Requires-Dist: towncrier; extra == "test"
 Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-astropy; extra == "docs"
+Requires-Dist: sphinx-changelog; extra == "docs"
+Requires-Dist: sphinx-autoapi; extra == "docs"
+Requires-Dist: pytest; extra == "docs"
+Requires-Dist: towncrier; extra == "docs"
+Requires-Dist: dkist-sphinx-theme; extra == "docs"
 
 dkist-processing-math
 =====================
 
 dkist-processing-math contains the math functions used throughout the DKIST data processing software stack.
 
-* DKIST: https://nso.edu/telescopes/dki-solar-telescope/
 
 Development
 -----------

{dkist-processing-math-2.1.0rc1 → dkist_processing_math-2.1.1}/dkist_processing_math.egg-info/SOURCES.txt

@@ -6,10 +6,7 @@ README.rst
 bitbucket-pipelines.yml
 check_changelog_updated.sh
 pyproject.toml
-setup.cfg
-setup.py
 changelog/.gitempty
-changelog/14.feature.rst
 dkist_processing_math/__init__.py
 dkist_processing_math/arithmetic.py
 dkist_processing_math/feature.py

dkist_processing_math-2.1.1/dkist_processing_math.egg-info/top_level.txt

@@ -0,0 +1,5 @@
+changelog
+dkist_processing_math
+docs
+licenses
+wheelhouse

dkist_processing_math-2.1.1/pyproject.toml

@@ -0,0 +1,100 @@
+[build-system]
+requires = ["setuptools>=64", "setuptools_scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages]
+find = {}
+
+[tool.setuptools_scm]
+
+[project]
+dynamic = ["version"]
+name = "dkist-processing-math"
+requires-python = ">=3.11"
+description = "Common math functionality used in the DKIST calibrations suite"
+readme = "README.rst"
+authors = [ {name = "NSO / AURA", email = "dkistdc@nso.edu"} ]
+license = {text = "BSD-3-Clause"}
+classifiers = [
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+]
+dependencies = [
+  "dkist-processing-common >= 4.0.0",
+  "numpy >= 1.24.0",
+  "scikit-image >= 0.21.0",
+  "scipy >= 1.11.0",
+  "peakutils >= 1.3.3",
+]
+
+[project.urls]
+Homepage = "https://nso.edu/dkist/data-center/"
+Repository = "https://bitbucket.org/dkistdc/dkist-processing-math/"
+Documentation = "https://docs.dkist.nso.edu/projects/math"
+Help = "https://nso.atlassian.net/servicedesk/customer/portal/5"
+
+[project.optional-dependencies]
+test = [
+  "pytest",
+  "pytest-cov",
+  "pytest-mock",
+  "hypothesis",
+  "towncrier",
+]
+docs = [
+  "sphinx",
+  "sphinx-astropy",
+  "sphinx-changelog",
+  "sphinx-autoapi",
+  "pytest",
+  "towncrier",
+  "dkist-sphinx-theme",
+]
+
+[tool.pytest.ini_options]
+markers = [
+  "development: For tests that can only be run while developing with a sidecar proxy (as opposed to in bitbucket pipelines)"
+]
+
+[tool.coverage.run]
+omit = [
+    "dkist_processing_math/tests/*",
+    "dkist_processing_math/__init__.py",
+]
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.towncrier]
+    package = "dkist_processing_math"
+    filename = "CHANGELOG.rst"
+    directory = "changelog/"
+    issue_format = "`#{issue} <https://bitbucket.org/dkistdc/dkist-processing-math/pull-requests/{issue}>`__"
+    title_format = "{version} ({project_date})"
+    ignore = [".gitempty"]
+
+[[tool.towncrier.type]]
+      directory = "feature"
+      name = "Features"
+      showcontent = true
+
+[[tool.towncrier.type]]
+      directory = "bugfix"
+      name = "Bugfixes"
+      showcontent = true
+
+[[tool.towncrier.type]]
+      directory = "removal"
+      name = "Removals"
+      showcontent = true
+
+[[tool.towncrier.type]]
+      directory = "misc"
+      name = "Misc"
+      showcontent = true
+
+[[tool.towncrier.type]]
+      directory = "doc"
+      name = "Documentation"
+      showcontent = true

dkist_processing_math-2.1.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

dkist-processing-math-2.1.0rc1/changelog/14.feature.rst

@@ -1 +0,0 @@
-Add functions to broadcast matrix multiplication over extra array dimensions.

dkist-processing-math-2.1.0rc1/dkist_processing_math.egg-info/top_level.txt

@@ -1 +0,0 @@
-dkist_processing_math

dkist-processing-math-2.1.0rc1/pyproject.toml

@@ -1,31 +0,0 @@
-[tool.towncrier]
-    package = "dkist_processing_math"
-    filename = "CHANGELOG.rst"
-    directory = "changelog/"
-    issue_format = "`#{issue} <https://bitbucket.org/dkistdc/dkist-processing-math/pull-requests/{issue}>`__"
-    title_format = "{version} ({project_date})"
-
-[[tool.towncrier.type]]
-      directory = "feature"
-      name = "Features"
-      showcontent = true
-
-[[tool.towncrier.type]]
-      directory = "bugfix"
-      name = "Bugfixes"
-      showcontent = true
-
-[[tool.towncrier.type]]
-      directory = "removal"
-      name = "Removals"
-      showcontent = true
-
-[[tool.towncrier.type]]
-      directory = "misc"
-      name = "Misc"
-      showcontent = true
-
-[[tool.towncrier.type]]
-      directory = "doc"
-      name = "Documentation"
-      showcontent = true

dkist-processing-math-2.1.0rc1/setup.cfg

@@ -1,60 +0,0 @@
-[metadata]
-name = dkist-processing-math
-description = Common math functionality used in the DKIST calibrations suite
-long_description = file: README.rst
-author = NSO / AURA
-author_email = "dkistdc@nso.edu"
-license = MIT
-url = https://bitbucket.org/dkistdc/dkist_processing_math/src/master/
-project_urls = 
-	Documentation = https://docs.dkist.nso.edu/projects/math
-classifiers = 
-	Programming Language :: Python
-	Programming Language :: Python :: 3
-	Programming Language :: Python :: 3.11
-
-[options]
-python_requires = >=3.11
-setup_requires = setuptools_scm
-packages = find:
-include_package_data = True
-install_requires = 
-	dkist-processing-common >= 4.0.0
-	numpy >= 1.24.0
-	scikit-image >= 0.21.0
-	scipy >= 1.11.0
-	peakutils >= 1.3.3
-
-[options.extras_require]
-test = 
-	pytest
-	pytest-cov
-	pytest-mock
-	hypothesis
-	towncrier
-docs = 
-	sphinx
-	sphinx-astropy
-	sphinx-changelog
-	sphinx-autoapi
-	pytest
-	towncrier
-	dkist-sphinx-theme
-
-[build_docs]
-source-dir = docs
-build-dir = docs/_build
-all_files = 1
-
-[upload_docs]
-upload-dir = docs/_build/html
-show-response = 1
-
-[tool:pytest]
-markers = 
-	development: For tests that can only be  run while developing with a sidecar proxy (as opposed to in bitbucket pipelines)
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

dkist-processing-math-2.1.0rc1/setup.py

@@ -1,4 +0,0 @@
-"""Use setup.cfg to configure packaging."""
-from setuptools import setup
-
-setup(use_scm_version=True)