Skip to content

xiaogengen-007/ITKExamples

 
 

Repository files navigation

ITK Examples

image

A set of cookbook examples for the Insight Toolkit, ITK.

Download instructions

Clone the repository using Git:

$ git clone --recursive https://github.com/InsightSoftwareConsortium/ITKExamples.git

Build instructions

See the build instructions in the documentation.

Features

Implemented

  • Stored and editable in Git version control.
  • HTML / PDF / EPUB output.
  • CTest unit testing.
  • CMake ExternalData for binary data storage.
  • Individual examples can be downloaded independently, and easily built/executed/hacked.
  • Download the entire docs for offline viewing.
  • Inline Doxygen class descriptions and links to Doxygen class documentation.
  • Nightly generated Gitstats for contributors.
  • Software quality dashboard.
  • Index of examples that apply to given terms and classes.
  • Quick search.
  • Script to create a new examples from a template.
  • GitHub community development.
  • Selectable light/dark colorscheme.

Todo

  • Anonymous online editing.
  • Editable online with CodeMirror.
  • See Github Issues for a complete list of actions to be performed, bugs, etc.

Build dependencies

Required

Optional

If building the documentation:

PDF generation requires a TeX distribution like TeX Live or MiKTeX.

Development setup

Run the bash script SetupForDevelopment.sh:

$ ./Utilities/SetupForDevelopment.sh

About

Cookbook examples for the Insight Toolkit documented with Sphinx

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 61.3%
  • CMake 21.4%
  • Python 14.9%
  • Shell 1.7%
  • HTML 0.4%
  • JavaScript 0.2%
  • CSS 0.1%