SlicerITKUltrasound
===================

.. image:: https://travis-ci.org/KitwareMedical/SlicerITKUltrasound.svg?branch=master
    :target: https://travis-ci.org/KitwareMedical/SlicerITKUltrasound

A `3D Slicer <http://slicer.org/>`_ extension for ultrasound image formation, processing, and analysis. Interfaces built off the
`ITKUltrasound <https://github.com/KitwareMedical/ITKUltrasound/>`_ library.

SlicerITKUltrasound
===================

.. image:: https://travis-ci.org/KitwareMedical/SlicerITKUltrasound.svg?branch=master
    :target: https://travis-ci.org/KitwareMedical/SlicerITKUltrasound

A `3D Slicer <http://slicer.org/>`_ extension for ultrasound image formation, processing, and analysis. Interfaces built off the
`ITKUltrasound <https://github.com/KitwareMedical/ITKUltrasound/>`_ library.

Development
-----------

To develop SlicerITKUltrasound, first `build 3D Slicer
<https://www.slicer.org/slicerWiki/index.php/Documentation/Nightly/Developers/Build_Instructions>`_.
Version *r25484* (trunk from 2016-10-28) or later is required.

Use CMake to configure SlicerITKUltrasound, `passing in
<https://www.slicer.org/slicerWiki/index.php/Documentation/Nightly/Developers/Build_Module>`_
the `Slicer_DIR` configuration variable to the
*<Slicer-Superbuild>/Slicer-build* path. Build SlicerITKUltrasound by calling
`make` or the other specific build system generated by CMake.

Run the tests for the extension by running `ctest` from
*<SlicerITKUltrasound-Superbuild>/SlicerITKUltrasound-build*.

To use the modules from Slicer's user interface: add the generated modules to
Slicer's module search path by opening Slicer, then *Edit -> Application
Settings -> Modules -> Additional module paths -> Add
<SlicerITKUltrasound-Superbuild>/SlicerITKUltrasound-build/lib/Slicer-4.N/cli-modules*,
and restart Slicer.

Add documentation on how to development the extension
ENH: Add documentation on how to development the extension
