Skip to content

ENH: Retire FEM modules to InsightSoftwareConsortium/ITKFEM remote#6524

Draft
hjmjohnson wants to merge 1 commit into
InsightSoftwareConsortium:mainfrom
hjmjohnson:remove-fem-module
Draft

ENH: Retire FEM modules to InsightSoftwareConsortium/ITKFEM remote#6524
hjmjohnson wants to merge 1 commit into
InsightSoftwareConsortium:mainfrom
hjmjohnson:remove-fem-module

Conversation

@hjmjohnson

Copy link
Copy Markdown
Member

Retires the FEM modules (ITKFEM, ITKFEMRegistration) from the ITK main tree, replacing them with a Modules/Remote/FEM.remote.cmake breadcrumb pointing at the new full-history remote repository InsightSoftwareConsortium/ITKFEM. Phase 1 of #6511.

What this does
  • Removes Modules/Numerics/FEM (ITKFEM) and Modules/Registration/FEM (ITKFEMRegistration) — both opt-in (EXCLUDE_FROM_DEFAULT); no in-tree module depended on them.
  • Adds Modules/Remote/FEM.remote.cmake (MODULE_COMPLIANCE_LEVEL 1, pinned GIT_TAG) with a loud enable-time warning that the module is unmaintained and slated for removal in ITK 7, asking dependents to comment on Tracking: Retire the FEM module (ITKFEM / ITKFEMRegistration) to reduce maintenance burden #6511.
  • Removes the two FEM-based deformable-registration examples + their data, drops FEM references from the Registration module-group doc and the license attribution list, and documents the retirement in the ITK 6 migration guide.
History preservation + verification

The remote repo was produced with git filter-repo from a fresh clone, retaining the complete history (1,290 commits back to the original 2001 check-in by Aljaž Noe, 137 merges) with legacy Code/-era paths normalized onto today's Modules/.../FEM layout. Content is tree-hash identical to upstream/main FEM.

End-to-end verified locally: enabling Module_FEM clones the remote, fires the warning, discovers both nested modules, and builds libITKFEM + libITKFEMRegistration.

Remove the opt-in (EXCLUDE_FROM_DEFAULT) ITKFEM (Modules/Numerics/FEM)
and ITKFEMRegistration (Modules/Registration/FEM) modules from the main
tree and replace them with a Modules/Remote/FEM.remote.cmake breadcrumb
pointing at the extracted, full-history InsightSoftwareConsortium/ITKFEM
repository. The remote is compliance-level 1 (the lowest itk_fetch_module
can express; 0 is promoted to 1), emits a loud enable-time warning, and is
scheduled for removal in ITK 7 (see InsightSoftwareConsortium#6511).

Also remove the two FEM-based deformable registration examples and their
data files, drop FEM references from the Registration module group
documentation and the license attribution list, and document the
retirement in the ITK 6 migration guide.
@github-actions github-actions Bot added the type:Enhancement Improvement of existing methods or implementation label Jun 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:Enhancement Improvement of existing methods or implementation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant