scikit-surgerytrackervisualisation

Logo

GitHub Actions CI status Test coverage Documentation Status The SciKit-Surgery paper https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg Follow scikit_surgery on twitter

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/SciKit-Surgery/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/SciKit-Surgery/scikit-surgerytrackervisualisation

Contributing

Please see the contributing guidelines.