From 23535d00bbeee7a0b5dfed792bb5d2ff48785bb2 Mon Sep 17 00:00:00 2001 From: Matthew Tino Date: Mon, 27 Oct 2025 19:53:18 -0400 Subject: [PATCH 1/3] LOG: Added more PR links to v1.2 changelog --- docs/changelog.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 693407e..e0b1856 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -8,19 +8,17 @@ All substantial or important changes to `shapelets` will be written in this file - NEW: Introduction of a new component or feature ## [1.2] -- Dec 14, 2024 -- commit 3ece26b391735e749d684419ed33d91c0855df9a - NEW: Introduced CHANGELOG.md for detailed version control history -- NEW: Introduced `shapelets.core` for essential components (i.e., shapelet functions, entry points) +- NEW: Introduced `shapelets.core` for essential components (i.e., shapelet functions, entry points) ([#68](https://github.com/uw-comphys/shapelets/pull/68)) - FIX: Corrected characteristic wavelength overestimation ([#64](https://github.com/uw-comphys/shapelets/pull/64)) - FIX: Corrected optimal filter orientation for steerable shapelets ([#62](https://github.com/uw-comphys/shapelets/pull/62)) -- MNT: Several documentation changes, including fixes for pdoc website compilation errors -- NEW: Added orthonormal (n=1) polar shapelets, with supporting methods and unit tests +- MNT: Several documentation changes, including fixes for pdoc website compilation errors +- NEW: Added orthonormal (n=1) polar shapelets, with supporting methods and unit tests ([#56](https://github.com/uw-comphys/shapelets/pull/56)) - FIX: Fixed entry point bug using incorrect python interpreter from local machine ([#55](https://github.com/uw-comphys/shapelets/pull/55)) -- MNT: Merged setup.cfg and MANIFEST.in into pyproject.toml, which now holds all project specifications -- MNT: Replaced existing Python response distance with C++ implementation, achieving ~15x speed-up! +- MNT: Merged setup.cfg and MANIFEST.in into pyproject.toml, which now holds all project specifications ([#55](https://github.com/uw-comphys/shapelets/pull/55)) +- MNT: Replaced existing Python response distance with C++ implementation, achieving ~15x speed-up! ([#48](https://github.com/uw-comphys/shapelets/pull/48)) ## [1.1] -- Apr 12, 2024 -- commit cd45ff9174503c44179538af2d83cf2c2444d53a - FIX: Fixed issue where unit tests were not available after pip installation ([#45](https://github.com/uw-comphys/shapelets/pull/45)) - MNT: Simplified input parameters and improved readability for `shapelets.self_assembly` methods - MNT: Edits to documentation, including examples, README, and official website @@ -28,5 +26,4 @@ All substantial or important changes to `shapelets` will be written in this file - MNT: Minor modifications and corrections to [JOSS manuscript](https://joss.theoj.org/papers/10.21105/joss.06058) ## [1.0] -- Mar 14, 2024 -- commit 6ce31fbd1194cac024f1f65d2fa7c21ed0c67990 - NEW: Initial complete and functional release following [JOSS manuscript](https://joss.theoj.org/papers/10.21105/joss.06058) acceptance \ No newline at end of file From 08422746c0a6628607fdfb34b46b10df5235a545 Mon Sep 17 00:00:00 2001 From: Matthew Tino Date: Mon, 27 Oct 2025 20:09:24 -0400 Subject: [PATCH 2/3] LOG: Changelog for shapelets v1.3 --- docs/changelog.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/changelog.md b/docs/changelog.md index e0b1856..8c0916f 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -7,6 +7,19 @@ All substantial or important changes to `shapelets` will be written in this file - MNT: General modifications, maintenance (including documentation), or enhancements - NEW: Introduction of a new component or feature +## [1.3] -- Oct 27, 2025 +- FIX: Restored original importing schemes to match JOSS paper, e.g. `from shapelets.self_assembly import orientation` ([#83](https://github.com/uw-comphys/shapelets/pull/83)) +- MNT: Deprecated function warnings; old imports (from JOSS paper) will still work, user notified of new function name ([#83](https://github.com/uw-comphys/shapelets/pull/83)) +- MNT: Exclude `shapelets/docs` from `pip install` ([#82](https://github.com/uw-comphys/shapelets/pull/82)) +- MNT: Documentation maintenance and removed `pdoc` as dependency ([#81](https://github.com/uw-comphys/shapelets/pull/81)) +- MNT: Modify GitHub action for JOSS paper compilation to run only on `publications` branch ([#80](https://github.com/uw-comphys/shapelets/pull/80)) +- NEW: New GitHub actions to run unit-tests on windows, macos, and linux (ubuntu) ([#80](https://github.com/uw-comphys/shapelets/pull/80)) +- NEW: Enforced `numpy` docstring format for all functions ([#77](https://github.com/uw-comphys/shapelets/pull/77)) +- NEW: Added CC as latest author to shapelets package, welcome! ([#77](https://github.com/uw-comphys/shapelets/pull/77)) +- MNT: Support for passing relative/absolute filepaths to config file, e.g. `shapelets-run /path/to/config` ([#76](https://github.com/uw-comphys/shapelets/pull/76)) +- MNT: Change main entry point from `shapelets` to `shapelets-run` ([#76](https://github.com/uw-comphys/shapelets/pull/76)) +- NEW: Addition of unsupervised shapelet method via `auto.py` (is standalone script; needs work to merge into package) ([#73](https://github.com/uw-comphys/shapelets/pull/73)) + ## [1.2] -- Dec 14, 2024 - NEW: Introduced CHANGELOG.md for detailed version control history - NEW: Introduced `shapelets.core` for essential components (i.e., shapelet functions, entry points) ([#68](https://github.com/uw-comphys/shapelets/pull/68)) @@ -22,7 +35,7 @@ All substantial or important changes to `shapelets` will be written in this file - FIX: Fixed issue where unit tests were not available after pip installation ([#45](https://github.com/uw-comphys/shapelets/pull/45)) - MNT: Simplified input parameters and improved readability for `shapelets.self_assembly` methods - MNT: Edits to documentation, including examples, README, and official website -- NEW: Formal library citation now available via CITATION.cff +- NEW: Formal library citation now available via CITATION.cff - MNT: Minor modifications and corrections to [JOSS manuscript](https://joss.theoj.org/papers/10.21105/joss.06058) ## [1.0] -- Mar 14, 2024 From 1ef03fd8e49b96ad677cbe2924e077e035355db2 Mon Sep 17 00:00:00 2001 From: Matthew Tino Date: Mon, 27 Oct 2025 20:09:51 -0400 Subject: [PATCH 3/3] Release shapelets v1.3 --- docs/changelog.md | 30 ++++++++++++++---------------- pyproject.toml | 4 ++-- 2 files changed, 16 insertions(+), 18 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 8c0916f..0152da9 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -2,34 +2,32 @@ All substantial or important changes to `shapelets` will be written in this file, with each release containing its changes in reverse chronological order. ## Commit Message Index -- FIX: Fix for current bug(s), with reference to [GitHub issues](https://github.com/uw-comphys/shapelets/issues) when possible +- FIX: Fix for current bug(s) or potential issues - LOG: Modifications to CHANGELOG for version control documentation - MNT: General modifications, maintenance (including documentation), or enhancements -- NEW: Introduction of a new component or feature +- NEW: Introduction of a new component, feature, or capability ## [1.3] -- Oct 27, 2025 -- FIX: Restored original importing schemes to match JOSS paper, e.g. `from shapelets.self_assembly import orientation` ([#83](https://github.com/uw-comphys/shapelets/pull/83)) -- MNT: Deprecated function warnings; old imports (from JOSS paper) will still work, user notified of new function name ([#83](https://github.com/uw-comphys/shapelets/pull/83)) +- FIX: Restored original importing schemes to match JOSS paper, ([#83](https://github.com/uw-comphys/shapelets/pull/83)) +- MNT: Deprecated function warnings for old function imports (from JOSS paper) ([#83](https://github.com/uw-comphys/shapelets/pull/83)) - MNT: Exclude `shapelets/docs` from `pip install` ([#82](https://github.com/uw-comphys/shapelets/pull/82)) -- MNT: Documentation maintenance and removed `pdoc` as dependency ([#81](https://github.com/uw-comphys/shapelets/pull/81)) -- MNT: Modify GitHub action for JOSS paper compilation to run only on `publications` branch ([#80](https://github.com/uw-comphys/shapelets/pull/80)) -- NEW: New GitHub actions to run unit-tests on windows, macos, and linux (ubuntu) ([#80](https://github.com/uw-comphys/shapelets/pull/80)) +- MNT: Documentation maintenance; removed `pdoc` as dependency ([#81](https://github.com/uw-comphys/shapelets/pull/81)) +- NEW: New GitHub actions to run unit-tests on multiple OS platforms ([#80](https://github.com/uw-comphys/shapelets/pull/80)) - NEW: Enforced `numpy` docstring format for all functions ([#77](https://github.com/uw-comphys/shapelets/pull/77)) - NEW: Added CC as latest author to shapelets package, welcome! ([#77](https://github.com/uw-comphys/shapelets/pull/77)) - MNT: Support for passing relative/absolute filepaths to config file, e.g. `shapelets-run /path/to/config` ([#76](https://github.com/uw-comphys/shapelets/pull/76)) - MNT: Change main entry point from `shapelets` to `shapelets-run` ([#76](https://github.com/uw-comphys/shapelets/pull/76)) -- NEW: Addition of unsupervised shapelet method via `auto.py` (is standalone script; needs work to merge into package) ([#73](https://github.com/uw-comphys/shapelets/pull/73)) +- NEW: Addition of source unsupervised shapelet technique via `auto.py` (not release) ([#73](https://github.com/uw-comphys/shapelets/pull/73)) ## [1.2] -- Dec 14, 2024 -- NEW: Introduced CHANGELOG.md for detailed version control history -- NEW: Introduced `shapelets.core` for essential components (i.e., shapelet functions, entry points) ([#68](https://github.com/uw-comphys/shapelets/pull/68)) -- FIX: Corrected characteristic wavelength overestimation ([#64](https://github.com/uw-comphys/shapelets/pull/64)) -- FIX: Corrected optimal filter orientation for steerable shapelets ([#62](https://github.com/uw-comphys/shapelets/pull/62)) -- MNT: Several documentation changes, including fixes for pdoc website compilation errors -- NEW: Added orthonormal (n=1) polar shapelets, with supporting methods and unit tests ([#56](https://github.com/uw-comphys/shapelets/pull/56)) +- NEW: Introduced CHANGELOG.md for detailed version control history ([#69](https://github.com/uw-comphys/shapelets/pull/69)) +- NEW: Introduced `shapelets.core` for essential components ([#68](https://github.com/uw-comphys/shapelets/pull/68)) +- FIX: Technical shapelets fixes, see PRs ([#62](https://github.com/uw-comphys/shapelets/pull/62)), ([#64](https://github.com/uw-comphys/shapelets/pull/64)) +- MNT: Several documentation changes, such as fixes for pdoc website compilation errors +- NEW: Added orthonormal (n=1) polar shapelets framework and unit tests ([#56](https://github.com/uw-comphys/shapelets/pull/56)) - FIX: Fixed entry point bug using incorrect python interpreter from local machine ([#55](https://github.com/uw-comphys/shapelets/pull/55)) -- MNT: Merged setup.cfg and MANIFEST.in into pyproject.toml, which now holds all project specifications ([#55](https://github.com/uw-comphys/shapelets/pull/55)) -- MNT: Replaced existing Python response distance with C++ implementation, achieving ~15x speed-up! ([#48](https://github.com/uw-comphys/shapelets/pull/48)) +- MNT: Merged setup.cfg and MANIFEST.in into pyproject.toml ([#55](https://github.com/uw-comphys/shapelets/pull/55)) +- MNT: Replaced Python response distance implementation with C++, ~15x speed-up! ([#48](https://github.com/uw-comphys/shapelets/pull/48)) ## [1.1] -- Apr 12, 2024 - FIX: Fixed issue where unit tests were not available after pip installation ([#45](https://github.com/uw-comphys/shapelets/pull/45)) diff --git a/pyproject.toml b/pyproject.toml index 6c1680d..4034bd7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,13 +6,13 @@ build-backend = "setuptools.build_meta" [project] name = "shapelets" -version = "1.2" +version = "1.3" description = "Shapelets provide reference access to various shapelet functions and some of their applications." requires-python = ">=3.10" dependencies = [ "astropy", "matplotlib", - "numpy<2.0", # testing with numpy=2.0.0 broke other dependencies... + "numpy<2.0", "opencv-python", "scikit-learn", "scikit-image",