Commit 684122f7 authored by Stephen Thompson's avatar Stephen Thompson

Issue #2 updated readme and setup.py, fixed broken links

parent 7b3a7227
Pipeline #2184 passed with stages
in 48 minutes and 27 seconds
scikit-surgery-sphere-fitting
===============================
.. image:: https://weisslab.cs.ucl.ac.uk/StephenThompson/sksurgeryspherefitting/raw/master/project-icon.png
.. image:: https://weisslab.cs.ucl.ac.uk/StephenThompson/scikit-surgery-sphere-fitting/raw/master/project-icon.png
:height: 128px
:width: 128px
:target: https://weisslab.cs.ucl.ac.uk/StephenThompson/sksurgeryspherefitting
:target: https://weisslab.cs.ucl.ac.uk/StephenThompson/scikit-surgery-sphere-fitting
:alt: Logo
.. image:: https://weisslab.cs.ucl.ac.uk/StephenThompson/sksurgeryspherefitting/badges/master/build.svg
:target: https://weisslab.cs.ucl.ac.uk/StephenThompson/sksurgeryspherefitting/pipelines
.. image:: https://weisslab.cs.ucl.ac.uk/StephenThompson/scikit-surgery-sphere-fitting/badges/master/build.svg
:target: https://weisslab.cs.ucl.ac.uk/StephenThompson/scikit-surgery-sphere-fitting/pipelines
:alt: GitLab-CI test status
.. image:: https://weisslab.cs.ucl.ac.uk/StephenThompson/sksurgeryspherefitting/badges/master/coverage.svg
:target: https://weisslab.cs.ucl.ac.uk/StephenThompson/sksurgeryspherefitting/commits/master
.. image:: https://weisslab.cs.ucl.ac.uk/StephenThompson/scikit-surgery-sphere-fitting/badges/master/coverage.svg
:target: https://weisslab.cs.ucl.ac.uk/StephenThompson/scikit-surgery-sphere-fitting/commits/master
:alt: Test coverage
.. image:: https://readthedocs.org/projects/sksurgeryspherefitting/badge/?version=latest
:target: http://sksurgeryspherefitting.readthedocs.io/en/latest/?badge=latest
.. image:: https://readthedocs.org/projects/scikit-surgery-sphere-fitting/badge/?version=latest
:target: http://scikit-surgery-sphere-fitting.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
......@@ -25,16 +25,19 @@ Author: Stephen Thompson
scikit-surgery-sphere-fitting is part of the `SNAPPY`_ software project, developed at the `Wellcome EPSRC Centre for Interventional and Surgical Sciences`_, part of `University College London (UCL)`_.
scikit-surgery-sphere-fitting supports Python 2.7 and Python 3.6.
scikit-surgery-sphere-fitting supports Python 3.6.
scikit-surgery-sphere-fitting is currently a demo project, which will add/multiply two numbers. Example usage:
scikit-surgery-sphere-fitting fits a sphere to a set of 3D points. It includes a user interface that
will read data from a vtk polydata file create an output polydata file showing the fitted sphere.
Example usage:
::
python sksurgeryspherefitting.py 5 8
python sksurgeryspherefitting.py 3 6 --multiply
python sksurgeryspherefitting.py polydata_in.vtp --output polydatata_in.vtp
Please explore the project structure, and implement your own functionality.
It was created in part to provide a simple demonstration of algorithm development as part of a
program of SNAPPY Tutorials, but also provides a useful service should you want to fit a sphere
to some data.
Developing
----------
......@@ -46,7 +49,7 @@ You can clone the repository using the following command:
::
git clone https://weisslab.cs.ucl.ac.uk/StephenThompson/sksurgeryspherefitting
git clone https://weisslab.cs.ucl.ac.uk/StephenThompson/scikit-surgery-sphere-fitting
Running tests
......@@ -76,8 +79,13 @@ You can pip install directly from the repository as follows:
::
pip install git+https://weisslab.cs.ucl.ac.uk/StephenThompson/sksurgeryspherefitting
pip install git+https://weisslab.cs.ucl.ac.uk/StephenThompson/scikit-surgery-sphere-fitting
or directly from pypi
::
pip install scikit-surgery-sphere-fitting
Contributing
......@@ -107,12 +115,12 @@ Supported by `Wellcome`_ and `EPSRC`_.
.. _`Wellcome EPSRC Centre for Interventional and Surgical Sciences`: http://www.ucl.ac.uk/weiss
.. _`source code repository`: https://weisslab.cs.ucl.ac.uk/StephenThompson/sksurgeryspherefitting
.. _`Documentation`: https://sksurgeryspherefitting.readthedocs.io
.. _`source code repository`: https://weisslab.cs.ucl.ac.uk/StephenThompson/scikit-surgery-sphere-fitting
.. _`Documentation`: https://scikit-surgery-sphere-fitting.readthedocs.io
.. _`SNAPPY`: https://weisslab.cs.ucl.ac.uk/WEISS/PlatformManagement/SNAPPY/wikis/home
.. _`University College London (UCL)`: http://www.ucl.ac.uk/
.. _`Wellcome`: https://wellcome.ac.uk/
.. _`EPSRC`: https://www.epsrc.ac.uk/
.. _`contributing guidelines`: https://weisslab.cs.ucl.ac.uk/StephenThompson/sksurgeryspherefitting/blob/master/CONTRIBUTING.rst
.. _`license file`: https://weisslab.cs.ucl.ac.uk/StephenThompson/sksurgeryspherefitting/blob/master/LICENSE
.. _`contributing guidelines`: https://weisslab.cs.ucl.ac.uk/StephenThompson/scikit-surgery-sphere-fitting/blob/master/CONTRIBUTING.rst
.. _`license file`: https://weisslab.cs.ucl.ac.uk/StephenThompson/scikit-surgery-sphere-fitting/blob/master/LICENSE
......@@ -19,7 +19,7 @@ setup(
long_description_content_type='text/x-rst',
url='https://weisslab.cs.ucl.ac.uk/StephenThompson/sksurgeryspherefitting',
author='Stephen Thompson',
author_email='YOUR-EMAIL@ucl.ac.uk',
author_email='s.thompson@ucl.ac.uk',
license='BSD-3 license',
classifiers=[
'Development Status :: 3 - Alpha',
......@@ -34,7 +34,6 @@ setup(
'Programming Language :: Python',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 3',
'Topic :: Scientific/Engineering :: Information Analysis',
......@@ -47,12 +46,15 @@ setup(
exclude=[
'doc',
'tests',
'data'
]
),
install_requires=[
'six>=1.10',
'numpy>=1.11',
scipy,
vtk,
scikit-surgeryvtk
],
entry_points={
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment