scikit-surgerybk

Interface for BK Medicial Ultrasound

https://github.com/scikit-surgery/scikit-surgerybk

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    3 of 4 committers (75.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.9%) to scientific vocabulary

Keywords

scikit-surgery ucl ultrasound

Keywords from Contributors

surgery
Last synced: 6 months ago · JSON representation ·

Repository

Interface for BK Medicial Ultrasound

Basic Info
  • Host: GitHub
  • Owner: SciKit-Surgery
  • License: other
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 229 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 1
  • Open Issues: 5
  • Releases: 0
Topics
scikit-surgery ucl ultrasound
Created over 5 years ago · Last pushed almost 4 years ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.rst

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

Owner

  • Name: SciKit-Surgery
  • Login: SciKit-Surgery
  • Kind: organization
  • Email: s.thompson@ucl.ac.uk

Compact Libraries for Surgical Navigation

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use SciKit-SurgeryBK in your research, please cite it as below."
authors:
- family-names: "Dowrick"
  given-names: "Thomas"
  orcid: "https://orcid.org/0000-0002-2712-4447"
- family-names: "Thompson"
  given-names: "Stephen"
  orcid: "https://orcid.org/0000-0001-7286-1326"
- family-names: "Ahmad"
  given-names: "Mian"
  orcid: "https://orcid.org/0000-0002-4706-4146"
- family-names: "Clarkson"
  given-names: "Matthew"
  orcid: "https://orcid.org/0000-0002-5565-1252"
title: "SciKit-Surgery"
url: "https://github.com/SciKit-Surgery/scikit-surgerybk"
preferred-citation:
  type: article
  authors:
  - family-names: "Thompson"
    given-names: "Stephen"
    orcid: "https://orcid.org/0000-0001-7286-1326"
  - family-names: "Dowrick"
    given-names: "Thomas"
    orcid: "https://orcid.org/0000-0002-2712-4447"
  - family-names: "Ahmad"
    given-names: "Mian"
    orcid: "https://orcid.org/0000-0002-4706-4146"
  - family-names: "Xiao"
    given-names: "Guofang"
  - family-names: "Koo"
    given-names: "Bongjin"
    orcid: "https://orcid.org/0000-0002-3611-4988"
  - family-names: "Bonmati"
    given-names: "Ester"
    orcid: "https://orcid.org/0000-0001-9217-5438"
  - family-names: "Kahl"
    given-names: "Kim"
  - family-names: "Clarkson"
    given-names: "Matthew"
    orcid: "https://orcid.org/0000-0002-5565-1252"
  doi: 10.1007/s11548-020-02180-5
  journal: "International journal of computer assisted radiology and surgery"
  start: 1075
  end: 1084
  title: "SciKit-Surgery: Compact Libraries for Surgical Navigation"
  volume: 15
  issue: 7
  year: 2020

GitHub Events

Total
  • Fork event: 1
Last Year
  • Fork event: 1

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 105
  • Total Committers: 4
  • Avg Commits per committer: 26.25
  • Development Distribution Score (DDS): 0.562
Top Committers
Name Email Commits
Thomas Dowrick t****k@g****m 46
Roland r****d@u****k 41
Thomas Dowrick t****k@u****k 14
Stephen Thompson s****n@u****k 4
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 23
  • Total pull requests: 3
  • Average time to close issues: 15 days
  • Average time to close pull requests: less than a minute
  • Total issue authors: 3
  • Total pull request authors: 2
  • Average comments per issue: 8.39
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • tdowrick (18)
  • Nicolaas94 (3)
  • thompson318 (2)
Pull Request Authors
  • thompson318 (2)
  • tdowrick (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 40 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 8
  • Total maintainers: 2
pypi.org: scikit-surgerybk

Python package for interfacing with BK Ultrasound machines

  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 40 Last month
Rankings
Dependent packages count: 10.0%
Dependent repos count: 21.7%
Average: 27.9%
Forks count: 29.8%
Stargazers count: 38.8%
Downloads: 39.4%
Maintainers (2)
Last synced: 6 months ago

Dependencies

requirements-dev.txt pypi
  • coverage * development
  • coveralls * development
  • mock * development
  • parameterized * development
  • pyfakefs * development
  • pyinstaller * development
  • pylint * development
  • pytest * development
  • pyyaml * development
  • sphinx * development
  • sphinx_rtd_theme * development
  • tox * development
requirements.txt pypi
  • crcmod *
  • numpy *
  • opencv-contrib-python *
setup.py pypi
  • numpy >=1.8
  • six >=1.10