Metadata-Version: 2.1
Name: scikit-surgerytrackervisualisation
Version: 0.0.4
Summary: Provides a live visualisation of tracking data from a scikit-surgerytracker source
Home-page: https://github.com/UCL/scikit-surgerytrackervisualisation
Author: Stephen Thompson
Author-email: s.thompson@ucl.ac.uk
License: BSD-3 license
Description: scikit-surgerytrackervisualisation
        ==================================
        
        .. image:: https://github.com/UCL/scikit-surgerytrackervisualisation/raw/master/project-icon.png
           :height: 128px
           :width: 128px
           :target: https://github.com/UCL/scikit-surgerytrackervisualisation
           :alt: Logo
        
        .. image:: https://github.com/UCL/scikit-surgerytrackervisualisation/workflows/.github/workflows/ci.yml/badge.svg
           :target: https://github.com/UCL/scikit-surgerytrackervisualisation/actions
           :alt: GitHub Actions CI status
        
        .. image:: https://coveralls.io/repos/github/UCL/scikit-surgerytrackervisualisation/badge.svg?branch=master&service=github
            :target: https://coveralls.io/github/UCL/scikit-surgerytrackervisualisation?branch=master 
            :alt: Test coverage
        
        .. image:: https://readthedocs.org/projects/scikit-surgerytrackervisualisation/badge/?version=latest
            :target: http://scikit-surgerytrackervisualisation.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. image:: https://img.shields.io/badge/Cite-SciKit--Surgery-informational
           :target: https://doi.org/10.1007/s11548-020-02180-5
           :alt: The SciKit-Surgery paper
        
        
        Author: Stephen Thompson
        
        scikit-surgerytrackervisualisation is part of the `SciKit-Surgery`_ software project, developed at the `Wellcome EPSRC Centre for Interventional and Surgical Sciences`_, part of `University College London (UCL)`_.
        
        scikit-surgerytrackervisualisation supports Python 2.7 and Python 3.6.
        
        scikit-surgerytrackervisualisation implements a basic interface for showing tracking output from a SciKit-Surgery tracker. 
        
        ::
        
            python scikit-surgerytrackervisualisation.py 
            python scikit-surgerytrackervisualisation.py --config config.json
        
        Please explore the project structure, and implement your own functionality.
        
        Developing
        ----------
        
        Cloning
        ^^^^^^^
        
        You can clone the repository using the following command:
        
        ::
        
            git clone https://github.com/UCL/scikit-surgerytrackervisualisation
        
        
        Running tests
        ^^^^^^^^^^^^^
        Pytest is used for running unit tests:
        ::
        
            pip install pytest
            python -m pytest
        
        
        Linting
        ^^^^^^^
        
        This code conforms to the PEP8 standard. Pylint can be used to analyse the code:
        
        ::
        
            pip install pylint
            pylint --rcfile=tests/pylintrc scikit-surgerytrackervisualisation
        
        
        Installing
        ----------
        
        You can pip install directly from the repository as follows:
        
        ::
        
            pip install git+https://github.com/UCL/scikit-surgerytrackervisualisation
        
        
        
        Contributing
        ^^^^^^^^^^^^
        
        Please see the `contributing guidelines`_.
        
        
        Useful links
        ^^^^^^^^^^^^
        
        * `Source code repository`_
        * `Documentation`_
        
        
        Licensing and copyright
        -----------------------
        
        Copyright 2019 University College London.
        scikit-surgerytrackervisualisation is released under the BSD-3 license. Please see the `license file`_ for details.
        
        
        Acknowledgements
        ----------------
        
        Supported by `Wellcome`_ and `EPSRC`_.
        
        
        .. _`Wellcome EPSRC Centre for Interventional and Surgical Sciences`: http://www.ucl.ac.uk/weiss
        .. _`source code repository`: https://github.com/UCL/scikit-surgerytrackervisualisation
        .. _`Documentation`: https://scikit-surgerytrackervisualisation.readthedocs.io
        .. _`SciKit-Surgery`: https://github.com/UCL/scikit-surgery/wiki
        .. _`University College London (UCL)`: http://www.ucl.ac.uk/
        .. _`Wellcome`: https://wellcome.ac.uk/
        .. _`EPSRC`: https://www.epsrc.ac.uk/
        .. _`contributing guidelines`: https://github.com/UCL/scikit-surgerytrackervisualisation/blob/master/CONTRIBUTING.rst
        .. _`license file`: https://github.com/UCL/scikit-surgerytrackervisualisation/blob/master/LICENSE
        
        
Keywords: medical imaging
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Healthcare Industry
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Description-Content-Type: text/x-rst
