|
| 1 | +# ITK 5.4.5 Release Notes: Onboarding AI Agents |
| 2 | + |
| 3 | +We are pleased to announce the release of [ITK 5.4.5](https://docs.itk.org/en/release-5.4/releases/5.4.5.html)! |
| 4 | + |
| 5 | +ITK 5.4.5 is a maintenance release focused on critical bug fixes, improved documentation, and platform support, while introducing AI agent onboarding to assist in project maintenance tasks 🤖. This is the latest maintenance update for this cross-platform, open-source toolkit supporting N-dimensional scientific image analysis with spatially-aware algorithms. 🥳 |
| 6 | + |
| 7 | +🔦 Highlights |
| 8 | +------------- |
| 9 | + |
| 10 | +- Bug Fixes: |
| 11 | + - Resolved issues with zero-sized CompositeTransforms and out-of-bounds access in GDCM, addressing possible security vulnerabilities. |
| 12 | + - Addressed bugs in imread with single-element lists and added corresponding tests to reinforce image IO reliability. |
| 13 | +- Documentation: |
| 14 | + - `AnatomicalOrientation` was backported along with usage guidance. |
| 15 | + - Minor corrections including spelling, removal of legacy documentation, and updates to shared guides. |
| 16 | + - The *AGENTS.md* file was introduced to onboard AI agents, outlining project structure and contribution guidelines. |
| 17 | +- Platform Support: |
| 18 | + - Improved testing for macOS-15 (Intel), updates for Python Xcode 16.2 |
| 19 | + - Support for building with newer system Eigen3 |
| 20 | + |
| 21 | +### 🤖 AI Agent Onboarding |
| 22 | + |
| 23 | +A key development in this release is the formal introduction of AI agents to assistent with maintenance. An [AGENTS.md](https://agents.md) file guides a developer's agent through ITK’s processes, ensuring contributions follow established community standards. Additionally, GitHub Copilot agent integration is streamlined by including a setup step to install the [Pixi package manager](https://pixi.sh/latest/), enabling agents to establish reproducible build and test environments quickly-- mirroring the workflow of human contributors. |
| 24 | + |
| 25 | +💾 Download |
| 26 | +----------- |
| 27 | + |
| 28 | +**Python Packages** |
| 29 | + |
| 30 | +Install [ITK Python packages](https://docs.itk.org/en/latest/learn/python_quick_start.html) with: |
| 31 | + |
| 32 | +```bash |
| 33 | +pip install itk |
| 34 | +``` |
| 35 | + |
| 36 | +**Guide and Textbook** |
| 37 | + |
| 38 | +- [InsightSoftwareGuide-Book1-5.4.5.pdf](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4.5/InsightSoftwareGuide-Book1-5.4.5.pdf) |
| 39 | +- [InsightSoftwareGuide-Book2-5.4.5.pdf](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4.5/InsightSoftwareGuide-Book2-5.4.5.pdf) |
| 40 | + |
| 41 | +**Library Sources** |
| 42 | + |
| 43 | +- [InsightToolkit-5.4.5.tar.gz](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4.5/InsightToolkit-5.4.5.tar.gz) |
| 44 | +- [InsightToolkit-5.4.5.zip](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4.5/InsightToolkit-5.4.5.zip) |
| 45 | + |
| 46 | +**Testing Data** |
| 47 | + |
| 48 | +Unpack optional testing data in the same directory where the Library Source is unpacked. |
| 49 | + |
| 50 | +- [InsightData-5.4.5.tar.gz](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4.5/InsightData-5.4.5.tar.gz) |
| 51 | +- [InsightData-5.4.5.zip](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4.5/InsightData-5.4.5.zip) |
| 52 | + |
| 53 | +**Checksums and Signatures** |
| 54 | + |
| 55 | +- [InsightToolkit-5.4.5.tar.gz.asc](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4.5/InsightToolkit-5.4.5.tar.gz.asc) |
| 56 | +- [InsightToolkit-5.4.5.zip.asc](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4.5/InsightToolkit-5.4.5.zip.asc) |
| 57 | + |
| 58 | +- [InsightData-5.4.5.tar.gz.asc](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4.5/InsightData-5.4.5.tar.gz.asc) |
| 59 | +- [InsightData-5.4.5.zip.asc](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4.5/InsightData-5.4.5.zip.asc) |
| 60 | + |
| 61 | +- [MD5SUMS](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4.5/MD5SUMS) |
| 62 | +- [SHA512SUMS](https://github.com/InsightSoftwareConsortium/ITK/releases/download/v5.4.5/SHA512SUMS) |
| 63 | + |
| 64 | +### 🙏 Acknowledgments |
| 65 | + |
| 66 | +Thank you to contributors Jon Haitz Legarreta Gorroño, Bradley Lowekamp, Hans Johnson, Matt McCormick, Dženan Zukić, Michael Cho, and the ITK community for their code, testing, and documentation efforts. |
| 67 | + |
| 68 | +--- |
| 69 | + |
| 70 | +### 🗣️ What's Next |
| 71 | + |
| 72 | +**ITK 6.0 Beta 2 Preparation** |
| 73 | +The community is preparing for **ITK 6.0 Beta 2**, featuring: |
| 74 | + |
| 75 | +- Architectural upgrades for contemporary C++ development |
| 76 | +- Enhanced template metaprogramming capabilities |
| 77 | +- Code modernization for improved readability and maintainability |
| 78 | + |
| 79 | +**5.4 Maintenance Commitment** |
| 80 | + |
| 81 | +We remain dedicated to supporting current users through: |
| 82 | + |
| 83 | +- Regular security and regression patches |
| 84 | +- Critical bug resolution |
| 85 | +- Platform compatibility updates |
| 86 | + |
| 87 | +**Enjoy ITK!** |
| 88 | + |
| 89 | +--- |
| 90 | + |
| 91 | +## ITK Changes Since v5.4.4 |
| 92 | + |
| 93 | +### Bradley Lowekamp (2): |
| 94 | + |
| 95 | +#### Bug Fixes |
| 96 | + |
| 97 | +- Fix setting zero sized CompositeTransforms ([55f1bbb046](https://github.com/InsightSoftwareConsortium/ITK/commit/55f1bbb046)) |
| 98 | +- Backport GDCM out-of-bounds fix ([7db3af9585](https://github.com/InsightSoftwareConsortium/ITK/commit/7db3af9585)) |
| 99 | + |
| 100 | + |
| 101 | +### Dženan Zukić (1): |
| 102 | + |
| 103 | +#### Documentation Updates |
| 104 | + |
| 105 | +- Change version number in download.md from 5.4.3 to 5.4.4 ([5c39ed7c57](https://github.com/InsightSoftwareConsortium/ITK/commit/5c39ed7c57)) |
| 106 | + |
| 107 | + |
| 108 | +### Hans Johnson (8): |
| 109 | + |
| 110 | +#### Enhancements |
| 111 | + |
| 112 | +- Backport AnatomicalOrientation to ITKv5 ([abc05a6a2d](https://github.com/InsightSoftwareConsortium/ITK/commit/abc05a6a2d)) |
| 113 | +- Add minimum policy version specification for external FFTW builds ([066ea6de53](https://github.com/InsightSoftwareConsortium/ITK/commit/066ea6de53)) |
| 114 | +- Specify `CMAKE_OSX_ARCHITECTURES` for external FFTW builds ([34f0432cb7](https://github.com/InsightSoftwareConsortium/ITK/commit/34f0432cb7)) |
| 115 | + |
| 116 | +#### Documentation Updates |
| 117 | + |
| 118 | +- Backport documentation for use of AnatomicalOrientation ([294937f135](https://github.com/InsightSoftwareConsortium/ITK/commit/294937f135)) |
| 119 | + |
| 120 | +#### Platform Fixes |
| 121 | + |
| 122 | +- Remove wrapping for AnatomicalOrientation backport ([54b89d3ee6](https://github.com/InsightSoftwareConsortium/ITK/commit/54b89d3ee6)) |
| 123 | +- Remove LEGACY off mode in backport ([1b746f8d16](https://github.com/InsightSoftwareConsortium/ITK/commit/1b746f8d16)) |
| 124 | +- Replace np.bool with np.bool_ ([5690d5ba51](https://github.com/InsightSoftwareConsortium/ITK/commit/5690d5ba51)) |
| 125 | + |
| 126 | +#### Style Changes |
| 127 | + |
| 128 | +- Fix spelling ignore for named class (Resizeable) ([386e33e9f1](https://github.com/InsightSoftwareConsortium/ITK/commit/386e33e9f1)) |
| 129 | + |
| 130 | + |
| 131 | +### Matt McCormick (13): |
| 132 | + |
| 133 | +#### Enhancements |
| 134 | + |
| 135 | +- Bump ITK version to 5.4.5 ([f51594ad88](https://github.com/InsightSoftwareConsortium/ITK/commit/f51594ad88)) |
| 136 | + |
| 137 | +#### Documentation Updates |
| 138 | + |
| 139 | +- Use --as-is for pixi run in AGENTS.md ([b46eb4a46b](https://github.com/InsightSoftwareConsortium/ITK/commit/b46eb4a46b)) |
| 140 | +- ITK 5.4.4 release notes ([cfd33fd326](https://github.com/InsightSoftwareConsortium/ITK/commit/cfd33fd326)) |
| 141 | +- Fix links to 5.4.4 release artifacts ([6d0bafddea](https://github.com/InsightSoftwareConsortium/ITK/commit/6d0bafddea)) |
| 142 | +- Add AI agent guide for ITK development ([8a9622e5ae](https://github.com/InsightSoftwareConsortium/ITK/commit/8a9622e5ae)) |
| 143 | +- Do not upgrade CMake in emulated Linux ARM build ([f3aae0f198](https://github.com/InsightSoftwareConsortium/ITK/commit/f3aae0f198)) |
| 144 | +- Update Python Xcode version to 16.2 for macos-15 runners ([acd395990d](https://github.com/InsightSoftwareConsortium/ITK/commit/acd395990d)) |
| 145 | + |
| 146 | +#### Platform Fixes |
| 147 | + |
| 148 | +- Replace np.bool with np.bool_ ([a63750180b](https://github.com/InsightSoftwareConsortium/ITK/commit/a63750180b)) |
| 149 | +- igenerator.py %i usage in help string ([bb262e5285](https://github.com/InsightSoftwareConsortium/ITK/commit/bb262e5285)) |
| 150 | +- Migrate macos runners from macos-13 to macos-15-intel ([f052bd7aec](https://github.com/InsightSoftwareConsortium/ITK/commit/f052bd7aec)) |
| 151 | +- Update branch fro ITKClangFormatLinterAction to main ([01248b7848](https://github.com/InsightSoftwareConsortium/ITK/commit/01248b7848)) |
| 152 | +- Avoid PySequence_Fast_GET_ITEM ([1726d3e518](https://github.com/InsightSoftwareConsortium/ITK/commit/1726d3e518)) |
| 153 | +- Exclude BigIO from AzurePipelinesLinux ([cea974eb42](https://github.com/InsightSoftwareConsortium/ITK/commit/cea974eb42)) |
| 154 | + |
| 155 | +### Michael Cho (1): |
| 156 | + |
| 157 | +#### Enhancements |
| 158 | + |
| 159 | +- Support building with system Eigen3 >= 5 ([96e01b5d3b](https://github.com/InsightSoftwareConsortium/ITK/commit/96e01b5d3b)) |
| 160 | + |
| 161 | + |
| 162 | +### copilot-swe-agent[bot] (2): |
| 163 | + |
| 164 | +#### Enhancements |
| 165 | + |
| 166 | +- Add copilot-setup-steps.yml with pixi installation ([78fbad0de5](https://github.com/InsightSoftwareConsortium/ITK/commit/78fbad0de5)) |
| 167 | + |
| 168 | +#### Bug Fixes |
| 169 | + |
| 170 | +- Fix imread with single-element list and add test ([8480b5f6d3](https://github.com/InsightSoftwareConsortium/ITK/commit/8480b5f6d3)) |
| 171 | + |
0 commit comments