scikit-surgerybk

Logo

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

Author: Thomas Dowrick

scikit-surgerybk is a Python library for interfacing with BK ultrasound machines, and 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-surgerybk supports Python 2.7 and Python 3.6/3.7/3.8.

Developing

Cloning

You can clone the repository using the following command:

git clone https://github.com/SciKit-Surgery/scikit-surgerybk

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 sksurgerybk

Installing

You can pip install directly from the repository as follows:

pip install git+https://github.com/SciKit-Surgery/scikit-surgerybk

Contributing

Please see the contributing guidelines.