From e01cf9409b2f176c6cd29d98e93370a55a32c2d5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=20Haitz=20Legarreta=20Gorro=C3=B1o?= Date: Fri, 23 Nov 2018 19:47:46 -0500 Subject: [PATCH] DOC: Follow repository naming convention. Follow remote module repository naming convention: add the `ITK` prefix to the **project name**, and keep the prefix out of the **module name**. Specifically: - Fix the **module name** in the main `CMakeLists.txt` file. - Fix the **module name** in the wrapping `CMakeLists.txt` file. - Fix the **module name** in the `itk-module.cmake` file. - Fix the **project name** in the `setup` section of the `setup.py` file. - Change the **project name** in the `config.yml` Circle CI `yml` file. - Fix the **module name** for the `\ingroup` Doxygen documentation keyword. - Take advantage of the change to set the URL to the repository site in `setup.py`. - Take advantage of the change to add keywords describing the module to `setup.py`. --- .circleci/config.yml | 12 ++++++------ CMakeLists.txt | 2 +- README.rst | 18 +++++++++--------- include/itkAdditiveGaussianNoiseMeshFilter.h | 2 +- ...tkAdditiveGaussianNoiseQuadEdgeMeshFilter.h | 2 +- itk-module.cmake | 6 +++--- setup.py | 10 +++++----- wrapping/CMakeLists.txt | 2 +- 8 files changed, 27 insertions(+), 27 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 9794c22..0ea4b93 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -1,12 +1,12 @@ version: 2 jobs: build-and-test: - working_directory: /DVMeshNoise-build + working_directory: /ITKMeshNoise-build docker: - image: insighttoolkit/module-ci:latest steps: - checkout: - path: /DVMeshNoise + path: /ITKMeshNoise - run: name: Fetch CTest driver script command: | @@ -17,12 +17,12 @@ jobs: SHASNIP=$(echo $CIRCLE_SHA1 | cut -c1-7) cat > dashboard.cmake << EOF set(CTEST_SITE "CircleCI") - set(CTEST_BUILD_NAME "External-DVMeshNoise-${CIRCLE_BRANCH}-${CIRCLE_BUILD_NUM}-${SHASNIP}") + set(CTEST_BUILD_NAME "External-ITKMeshNoise-${CIRCLE_BRANCH}-${CIRCLE_BUILD_NUM}-${SHASNIP}") set(CTEST_BUILD_CONFIGURATION "MinSizeRel") set(CTEST_CMAKE_GENERATOR "Unix Makefiles") set(CTEST_BUILD_FLAGS: "-j5") - set(CTEST_SOURCE_DIRECTORY /DVMeshNoise) - set(CTEST_BINARY_DIRECTORY /DVMeshNoise-build) + set(CTEST_SOURCE_DIRECTORY /ITKMeshNoise) + set(CTEST_BINARY_DIRECTORY /ITKMeshNoise-build) set(dashboard_model Experimental) set(dashboard_no_clean 1) set(dashboard_cache " @@ -37,7 +37,7 @@ jobs: command: | ctest -j 2 -VV -S dashboard.cmake package: - working_directory: ~/DVMeshNoise + working_directory: ~/ITKMeshNoise machine: true steps: - checkout diff --git a/CMakeLists.txt b/CMakeLists.txt index 93da25c..fe05b79 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,6 +1,6 @@ cmake_minimum_required(VERSION 3.10.2) -project(DVMeshNoise) +project(MeshNoise) if(NOT ITK_SOURCE_DIR) find_package(ITK REQUIRED) diff --git a/README.rst b/README.rst index 2a8c77d..671d239 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,12 @@ -DVMeshNoise -=========== - -.. |CircleCI| image:: https://circleci.com/gh/InsightSoftwareConsortium/DVMeshNoise.svg?style=shield - :target: https://circleci.com/gh/InsightSoftwareConsortium/DVMeshNoise -.. |TravisCI| image:: https://travis-ci.org/InsightSoftwareConsortium/DVMeshNoise.svg?branch=master - :target: https://travis-ci.org/InsightSoftwareConsortium/DVMeshNoise -.. |AppVeyor| image:: https://img.shields.io/appveyor/ci/itkrobot/dvmeshnoise.svg - :target: https://ci.appveyor.com/project/itkrobot/dvmeshnoise +ITKMeshNoise +============ + +.. |CircleCI| image:: https://circleci.com/gh/InsightSoftwareConsortium/ITKMeshNoise.svg?style=shield + :target: https://circleci.com/gh/InsightSoftwareConsortium/ITKMeshNoise +.. |TravisCI| image:: https://travis-ci.org/InsightSoftwareConsortium/ITKMeshNoise.svg?branch=master + :target: https://travis-ci.org/InsightSoftwareConsortium/ITKMeshNoise +.. |AppVeyor| image:: https://img.shields.io/appveyor/ci/itkrobot/itkmeshnoise.svg + :target: https://ci.appveyor.com/project/itkrobot/itkmeshnoise =========== =========== =========== Linux macOS Windows diff --git a/include/itkAdditiveGaussianNoiseMeshFilter.h b/include/itkAdditiveGaussianNoiseMeshFilter.h index 1659831..7b9a707 100644 --- a/include/itkAdditiveGaussianNoiseMeshFilter.h +++ b/include/itkAdditiveGaussianNoiseMeshFilter.h @@ -35,7 +35,7 @@ namespace itk * counteracting deleterious effects which highly regular regions * of a mesh may occassionally have on mesh processing. * - * \ingroup DVMeshNoise + * \ingroup MeshNoise */ template< typename TInput, typename TOutput = TInput > class AdditiveGaussianNoiseMeshFilter: diff --git a/include/itkAdditiveGaussianNoiseQuadEdgeMeshFilter.h b/include/itkAdditiveGaussianNoiseQuadEdgeMeshFilter.h index d82687c..e62d96a 100644 --- a/include/itkAdditiveGaussianNoiseQuadEdgeMeshFilter.h +++ b/include/itkAdditiveGaussianNoiseQuadEdgeMeshFilter.h @@ -35,7 +35,7 @@ namespace itk * counteracting deleterious effects which highly regular regions * of a mesh may occassionally have on mesh processing. * - * \ingroup DVMeshNoise + * \ingroup MeshNoise */ template< typename TInputMesh, typename TOutputMesh = TInputMesh > class AdditiveGaussianNoiseQuadEdgeMeshFilter: diff --git a/itk-module.cmake b/itk-module.cmake index 3eeff98..5926e24 100644 --- a/itk-module.cmake +++ b/itk-module.cmake @@ -4,13 +4,13 @@ get_filename_component(MY_CURRENT_DIR "${CMAKE_CURRENT_LIST_FILE}" PATH) file(READ "${MY_CURRENT_DIR}/README.rst" DOCUMENTATION) -# itk_module() defines the module dependencies in DVMeshNoise -# The testing module in DVMeshNoise depends on ITKTestKernel +# itk_module() defines the module dependencies in MeshNoise +# The testing module in MeshNoise depends on ITKTestKernel # By convention those modules outside of ITK are not prefixed with # ITK. # define the dependencies of the include module and the tests -itk_module(DVMeshNoise +itk_module(MeshNoise DEPENDS ITKCommon ITKMesh diff --git a/setup.py b/setup.py index 8ba4fdd..7c67c55 100644 --- a/setup.py +++ b/setup.py @@ -12,15 +12,15 @@ sys.exit(1) setup( - name='dvmeshnoise', + name='itk-meshnoise', version='0.0.1', author='Davis Vigneault', author_email='davis.vigneault@gmail.com', packages=['itk'], package_dir={'itk': 'itk'}, - download_url=r'https://github.com/InsightSoftwareConsortium/DVMeshNoise', + download_url=r'https://github.com/InsightSoftwareConsortium/ITKMeshNoise', description=r'Classes to perturb mesh objects with Gaussian noise', - long_description='DVMeshNoise provides classes to perturb mesh objects' + long_description='ITKMeshNoise provides classes to perturb mesh objects' 'with Gaussian noise.\n' 'Please refer to:' 'Vigneault D.,' @@ -46,8 +46,8 @@ "Operating System :: MacOS" ], license='Apache', - keywords='ITK InsightToolkit', - url=r'https://itk.org/', + keywords='ITK InsightToolkit mesh noise', + url=r'https://github.com/InsightSoftwareConsortium/ITKMeshNoise', install_requires=[ r'itk' ] diff --git a/wrapping/CMakeLists.txt b/wrapping/CMakeLists.txt index 5ca53bc..b5feb58 100644 --- a/wrapping/CMakeLists.txt +++ b/wrapping/CMakeLists.txt @@ -1,4 +1,4 @@ -itk_wrap_module(DVMeshNoise) +itk_wrap_module(MeshNoise) set(WRAPPER_SUBMODULE_ORDER AdditiveGaussianNoiseMeshFilter