dkist-processing-math 2.1.0rc2__tar.gz → 2.1.2__tar.gz

dkist_processing_math-2.1.2/.snyk

@@ -0,0 +1,3 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities
+# https://docs.snyk.io/manage-risk/policies/the-.snyk-file#syntax-of-the-.snyk-file
+version: v1.25.0

{dkist-processing-math-2.1.0rc2 → dkist_processing_math-2.1.2}/CHANGELOG.rst

@@ -1,3 +1,37 @@
+v2.1.2 (2024-12-20)
+===================
+
+Misc
+----
+
+- Update Bitbucket pipelines to use standardized lint and scan steps. (`#17 <https://bitbucket.org/dkistdc/dkist-processing-math/pull-requests/17>`__)
+
+
+Documentation
+-------------
+
+- Change the documentation landing page to focus more on users and less on developers. (`#16 <https://bitbucket.org/dkistdc/dkist-processing-math/pull-requests/16>`__)
+
+
+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.0rc2 → dkist_processing_math-2.1.2}/PKG-INFO

@@ -1,25 +1,43 @@
 Metadata-Version: 2.1
 Name: dkist-processing-math
-Version: 2.1.0rc2
+Version: 2.1.2
 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.0rc2 → dkist_processing_math-2.1.2}/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.2/bitbucket-pipelines.yml

@@ -0,0 +1,100 @@
+image: python:3.11
+definitions:
+  steps:
+    - step: &lint
+        caches:
+          - pip
+        name: Lint
+        script:
+          - echo "Retrieving and Executing Lint Script"
+          - curl -fL https://getcli.jfrog.io | sh
+          - ./jfrog rt dl --url $ARTIFACTORY_URL --user $ARTIFACTORY_USER --password $ARTIFACTORY_PASSWORD generic-packages/ci_scripts/latest/lint_python.sh
+          - cat ci_scripts/latest/lint_python.sh
+          - chmod 755 ci_scripts/latest/lint_python.sh
+          - ./ci_scripts/latest/lint_python.sh
+    - step: &changelog
+        caches:
+          - pip
+        name: Changelog
+        script:
+          - pip install towncrier
+          # We need to fetch the main branch to compare against
+          - git remote set-branches --add origin main
+          - git fetch origin main
+          - towncrier check --compare-with origin/main
+    - step: &scan
+        caches:
+          - pip
+        name: Scan
+        script:
+          - echo "Retrieving and Executing Scan Script"
+          - curl -fL https://getcli.jfrog.io | sh
+          - ./jfrog rt dl --url $ARTIFACTORY_URL --user $ARTIFACTORY_USER --password $ARTIFACTORY_PASSWORD generic-packages/ci_scripts/latest/scan_python.sh
+          - cat ci_scripts/latest/scan_python.sh
+          - chmod 755 ci_scripts/latest/scan_python.sh
+          - ./ci_scripts/latest/scan_python.sh
+    - step: &test
+        caches:
+          - pip
+        name: Test
+        script:
+          - pip install .[test]
+          - pytest --cov -m "not development" dkist_processing_math
+    - step: &docs
+        name: Build Docs
+        caches:
+          - pip
+        script:
+          - apt update && apt -y install graphviz
+          - pip install .[docs]
+          - sphinx-build --color -W --keep-going -b html docs docs/_build/html
+    - step: &check_changelog
+        name: Check for updated CHANGELOG
+        script:
+          - ./check_changelog_updated.sh
+    - step: &push
+        caches:
+          - pip
+        name: Push
+        script:
+          - pip install -U pip
+          - pip install build twine
+          - python -m build --outdir wheelhouse .
+          - python -m twine upload --skip-existing wheelhouse/*
+
+pipelines:
+  default:
+    - parallel:
+      - step: *lint
+      - step: *changelog
+    - parallel:
+      - step: *scan
+      - step: *test
+      - step: *docs
+  custom:
+    skip_doc_test_to_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:
+        - step: *check_changelog
+        - step: *lint
+      - parallel:
+        - step: *scan
+        - step: *test
+        - step: *docs
+      - step: *push

{dkist-processing-math-2.1.0rc2 → dkist_processing_math-2.1.2}/check_changelog_updated.sh

@@ -16,7 +16,7 @@ ls changelog/*rst 2>/dev/null && {
   exit 1;
 }
 
-head -n 1 CHANGELOG.rst | grep -q $CURRENT_VERSION - || {
+head -n 1 CHANGELOG.rst | grep -q "^$CURRENT_VERSION (" - || {
   echo -e "\\n${ERROR_PAD}"
   echo -e $ERROR_STR;
   echo -e "${ERROR_PAD}"

{dkist-processing-math-2.1.0rc2 → dkist_processing_math-2.1.2}/dkist_processing_math/linear_algebra.py

@@ -17,6 +17,9 @@ def nd_left_matrix_multiply(*, vector_stack: np.ndarray, matrix_stack: np.ndarra
     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
     ----------
     vector_stack : np.ndarray
@@ -59,6 +62,9 @@ def nd_right_matrix_multiply(*, vector_stack: np.ndarray, matrix_stack: np.ndarr
     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
     ----------
     vector_stack : np.ndarray

{dkist-processing-math-2.1.0rc2 → dkist_processing_math-2.1.2}/dkist_processing_math.egg-info/PKG-INFO

@@ -1,25 +1,43 @@
 Metadata-Version: 2.1
 Name: dkist-processing-math
-Version: 2.1.0rc2
+Version: 2.1.2
 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.0rc2 → dkist_processing_math-2.1.2}/dkist_processing_math.egg-info/SOURCES.txt

@@ -1,15 +1,13 @@
 .gitignore
 .pre-commit-config.yaml
 .readthedocs.yml
+.snyk
 CHANGELOG.rst
 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
@@ -36,6 +34,7 @@ docs/Makefile
 docs/changelog.rst
 docs/conf.py
 docs/index.rst
+docs/landing_page.rst
 docs/make.bat
 docs/requirements.txt
 licenses/LICENSE.rst

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

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

{dkist-processing-math-2.1.0rc2 → dkist_processing_math-2.1.2}/docs/index.rst

@@ -1,4 +1,4 @@
-.. include:: ../README.rst
+.. include:: landing_page.rst
 
 .. toctree::
   :maxdepth: 2

dkist_processing_math-2.1.2/docs/landing_page.rst

@@ -0,0 +1,6 @@
+Overview
+========
+
+The `dkist-processing-math` code repository contains a set of common mathematical functions
+designed to operate efficiently over batches of array data.  The math library is used
+throughout the DKIST data calibration software stack.

dkist_processing_math-2.1.2/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.2/setup.cfg

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

dkist-processing-math-2.1.0rc2/bitbucket-pipelines.yml

@@ -1,85 +0,0 @@
-image: python:3.11
-definitions:
-  steps:
-    - step: &lint
-        caches:
-          - pip
-        name: Lint
-        script:
-          - pip install pre-commit
-          - pre-commit install
-          - pre-commit run --all-files
-    - step: &changelog
-        caches:
-          - pip
-        name: Changelog
-        script:
-          - pip install towncrier
-          # We need to fetch the main branch to compare against
-          - git remote set-branches --add origin main
-          - git fetch origin main
-          - towncrier check --compare-with origin/main
-    - step: &scan
-        caches:
-          - pip
-        name: Scan
-        script:
-          - pip install -e .
-          - pip freeze | grep -v @ > requirements.txt
-          - cat requirements.txt
-          - echo $SNYK_VERSION
-          - curl -L -o snyk https://github.com/snyk/snyk/releases/download/$SNYK_VERSION/snyk-linux
-          - chmod 755 snyk
-          - ./snyk -d auth $SNYK_TOKEN
-          - echo $SNYK_IGNORE
-          - for id in $SNYK_IGNORE; do echo Ignoring $id; ./snyk ignore $id; done
-          - cat .snyk || echo "No .snyk found. Probably because there was nothing to ignore."
-          - echo $SNYK_CLI_COMMAND
-          - $SNYK_CLI_COMMAND
-    - step: &test
-        caches:
-          - pip
-        name: Test
-        script:
-          - pip install .[test]
-          - pytest --cov -m "not development" dkist_processing_math
-    - step: &docs
-        name: Build Docs
-        caches:
-          - pip
-        script:
-          - apt update && apt -y install graphviz
-          - pip install .[docs]
-          - sphinx-build --color -W --keep-going -b html docs docs/_build/html
-    - step: &check_changelog
-        name: Check for updated CHANGELOG
-        script:
-          - ./check_changelog_updated.sh
-    - step: &push
-        caches:
-          - pip
-        name: Push
-        script:
-          - python setup.py sdist
-          - pip install twine
-          - twine upload dist/*
-
-pipelines:
-  default:
-    - parallel:
-      - step: *lint
-      - step: *changelog
-    - parallel:
-      - step: *scan
-      - step: *test
-      - step: *docs
-  tags:
-    'v*':
-      - parallel:
-        - step: *check_changelog
-        - step: *lint
-      - parallel:
-        - step: *scan
-        - step: *test
-        - step: *docs
-      - step: *push

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

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

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

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

dkist-processing-math-2.1.0rc2/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.0rc2/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.0rc2/setup.py

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