ITKModuleTemplate

Linux	macOS	Windows

This is a module for the Insight Toolkit (ITK) for segmentation and registration. It is designed to work with the ITK modular system.

This module is a template to be used as a starting point for a new ITK module.

Getting Started

The following will get an external module started in a new repository:

python -m pip install cookiecutter
python -m cookiecutter gh:InsightSoftwareConsortium/ITKModuleTemplate
# Fill in the information requested at the prompts

Documentation on how to populate the module can be found in the ITK Software Guide.

Remote Module

After an Insight Journal article has been submitted, the module can be included in ITK as a remote module. Add a file in "ITK/Modules/Remote" called "YourModule.remote.cmake", for this module it would be "ExternalExample.remote.cmake" with the followlowing contents:

itk_fetch_module(MyModule
  "A description of the a module."
  GIT_REPOSITORY http://github.com/myuser/ITKMyModule.git
  GIT_TAG abcdef012345
  )

Python Packages

Continuous integration service configurations are included to build Python packages for Linux, macOS, and Windows. These packages can be downloaded and uploaded to the Python Package Index (PyPI).

License

This software is distributed under the Apache 2.0 license. Please see the LICENSE file for details.

Authors