ITKSoftwareGuide
ITKSoftwareGuide copied to clipboard
InsightSoftwareConsortium
Sources for the ITKSoftwareGuide.
The document at [https://itk.org/ItkSoftwareGuide.pdf](https://itk.org/ItkSoftwareGuide.pdf) shows version 5.2.0 from April 16, 2021. It should be updated.
Follow-up to ITK pull request https://github.com/InsightSoftwareConsortium/ITK/pull/3713 commit https://github.com/InsightSoftwareConsortium/ITK/commit/69151c3a1c97188cf8ef0f9473496998587278bf "STYLE: Remove backslash + indent from literals, to avoid unwanted spaces"
With this commit I was able to get the ITK Software Guide to build with the setting USE_SYSTEM_ITK=ON.
Replace the likes of old-style `"My file is {file}".format(file=my_file)` with new-style `f"My file is {my_file}"`.
This will need to be fixed in the main *ITK* repository. https://open.cdash.org/viewBuildError.php?type=1&buildid=6056900 ``` Examples/RegistrationITKv4/DeformableRegistration5.cxx:308:80: warning: Line length too long for LaTeX printing Examples/RegistrationITKv4/DeformableRegistration5.cxx:338:80: warning: Line length too long for LaTeX...
For some reason, the `Appendices` chapter bookmarks are not generated in the PDF file, although the sections are available in the table of contents. For an easier navigation, it would...
Add a Python style guide. The [System Overview Wrapping](https://github.com/InsightSoftwareConsortium/ITKSoftwareGuide/blob/bf60afa4274dc5c285ac5c8b173a440866def9c8/SoftwareGuide/Latex/Architecture/SystemOverview.tex#L755) section contains [some example code](https://github.com/InsightSoftwareConsortium/ITKSoftwareGuide/blob/bf60afa4274dc5c285ac5c8b173a440866def9c8/SoftwareGuide/Latex/Architecture/SystemOverview.tex#L792) of what an ITK Python code looks like, but we are lacking some guidelines on how...
[Figure 2.1](https://github.com/InsightSoftwareConsortium/ITKSoftwareGuide/blob/master/SoftwareGuide/Latex/Introduction/Installation.tex#L278) shows a very outdated version of CMake. I think it would be desirable to push an updated image for the sake of consistency, and to provide a more...
It may be a nice addition to add a glossary of terms at the end of each chapter that summarizes the most important terms that the chapter presented. The terms...
Metadata
Owner
Metadata
Sources for the ITKSoftwareGuide.