From 5fcf89444159a9d72f3bdda0d5c2f734ddbe19c1 Mon Sep 17 00:00:00 2001 From: Matt McCormick Date: Mon, 29 Apr 2019 11:46:40 -0400 Subject: [PATCH 1/2] DOC: Add Python package installation instructions --- README.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.rst b/README.rst index 292f072..5aa6336 100644 --- a/README.rst +++ b/README.rst @@ -46,6 +46,29 @@ Denoised: .. image:: https://user-images.githubusercontent.com/3021667/38002451-b87bed62-3232-11e8-814b-50e8fb0f79cb.png +Installation +------------ + +To install the binary Python packages:: + + python -m pip install itk-totalvariation + +Since ITK 5.0.0, this module is available in the ITK source tree as a remote +module. To enable it, set:: + + Module_TotalVariation:BOOL=ON + +in ITK's CMake build configuration. + +License +------- + +This software is distributed under the Apache 2.0 license. Please see +the *LICENSE* file for details. + +Todo +---- + - [x] Add support for CMake to proxTV. Open PR: And the branch in my fork: - [x] Uses CMake FetchContent to download the third party proxTV. From 9998988c906e81a4729aae6a94bccf3c6c696771 Mon Sep 17 00:00:00 2001 From: Matt McCormick Date: Mon, 29 Apr 2019 17:10:49 -0400 Subject: [PATCH 2/2] DOC: README badges for PyPI and license --- README.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.rst b/README.rst index 5aa6336..5d7318b 100644 --- a/README.rst +++ b/README.rst @@ -5,6 +5,14 @@ ITKTotalVariation :target: https://dev.azure.com/InsightSoftwareConsortium/ITKModules/_build/latest?definitionId=21&branchName=master :alt: Build Status + .. image:: https://img.shields.io/pypi/v/itk-totalvariation.svg + :target: https://pypi.python.org/pypi/itk-totalvariation + :alt: PyPI + +.. image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg + :target: https://github.com/InsightSoftwareConsortium/ITKTotalVariation/blob/master/LICENSE) + :alt: License + Overview --------