https://github.com/scikit-surgery/scikit-surgerybk
Interface for BK Medicial Ultrasound
https://github.com/scikit-surgery/scikit-surgerybk
scikit-surgery ucl ultrasound
Last synced: about 1 month ago
JSON representation
Interface for BK Medicial Ultrasound
- Host: GitHub
- URL: https://github.com/scikit-surgery/scikit-surgerybk
- Owner: SciKit-Surgery
- License: other
- Created: 2020-06-21T19:18:21.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-01T09:32:36.000Z (over 3 years ago)
- Last Synced: 2025-09-04T22:43:07.225Z (about 1 month ago)
- Topics: scikit-surgery, ucl, ultrasound
- Language: Python
- Homepage:
- Size: 229 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
scikit-surgerybk
===============================
.. image:: https://github.com/SciKit-Surgery/scikit-surgerybk/raw/master/project-icon.png
:height: 128px
:width: 128px
:target: https://github.com/SciKit-Surgery/scikit-surgerybk
:alt: Logo
|
.. image:: https://github.com/SciKit-Surgery/scikit-surgerybk/workflows/.github/workflows/ci.yml/badge.svg
:target: https://github.com/SciKit-Surgery/scikit-surgerybk/actions
:alt: GitHub Actions CI statuss
.. image:: https://coveralls.io/repos/github/SciKit-Surgery/scikit-surgerybk/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/SciKit-Surgery/scikit-surgerybk?branch=master
:alt: Test coverage
.. image:: https://readthedocs.org/projects/scikit-surgerybk /badge/?version=latest
:target: http://scikit-surgerybk .readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
:target: CODE_OF_CONDUCT.md
.. image:: https://img.shields.io/twitter/follow/scikit_surgery?style=social
:target: https://twitter.com/scikit_surgery?ref_src=twsrc%5Etfw
:alt: 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`_.
Useful links
^^^^^^^^^^^^
* `Source code repository`_
* `Documentation`_
Licensing and copyright
-----------------------
Copyright 2019 University College London.
scikit-surgerybk 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/SciKit-Surgery/scikit-surgerybk
.. _`Documentation`: https://scikit-surgerybk.readthedocs.io
.. _`SciKit-Surgery`: https://github.com/SciKit-Surgery
.. _`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/SciKit-Surgery/scikit-surgerybk/blob/master/CONTRIBUTING.rst
.. _`license file`: https://github.com/SciKit-Surgery/scikit-surgerybkblob/master/LICENSE