{"id":21994225,"url":"https://github.com/scikit-surgery/snappysonic","last_synced_at":"2025-08-14T19:23:35.379Z","repository":{"id":43714916,"uuid":"259654629","full_name":"SciKit-Surgery/snappysonic","owner":"SciKit-Surgery","description":"SnappySonic is an Ultrasound Simulator for use in research and public engagement.","archived":false,"fork":false,"pushed_at":"2023-05-04T11:58:19.000Z","size":10222,"stargazers_count":19,"open_issues_count":3,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-30T10:13:46.136Z","etag":null,"topics":["education","medical-imaging","scikit-surgery","simulation","ucl","ultrasound"],"latest_commit_sha":null,"homepage":"https://openresearchsoftware.metajnl.com/articles/10.5334/jors.289/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SciKit-Surgery.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-04-28T14:06:30.000Z","updated_at":"2025-05-28T16:35:31.000Z","dependencies_parsed_at":"2022-08-22T03:00:34.363Z","dependency_job_id":"1de6cf4a-a5b2-4977-8ee1-a6aee828207f","html_url":"https://github.com/SciKit-Surgery/snappysonic","commit_stats":{"total_commits":99,"total_committers":2,"mean_commits":49.5,"dds":"0.010101010101010055","last_synced_commit":"ae870694870260882367aa7ae64952b3d8ead169"},"previous_names":["ucl/snappysonic"],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/SciKit-Surgery/snappysonic","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SciKit-Surgery%2Fsnappysonic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SciKit-Surgery%2Fsnappysonic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SciKit-Surgery%2Fsnappysonic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SciKit-Surgery%2Fsnappysonic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SciKit-Surgery","download_url":"https://codeload.github.com/SciKit-Surgery/snappysonic/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SciKit-Surgery%2Fsnappysonic/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262788741,"owners_count":23364399,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["education","medical-imaging","scikit-surgery","simulation","ucl","ultrasound"],"created_at":"2024-11-29T21:08:01.116Z","updated_at":"2025-06-30T14:09:04.761Z","avatar_url":"https://github.com/SciKit-Surgery.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"SnappySonic\n===============================\n\n.. image:: https://github.com/SciKit-Surgery/snappysonic/raw/master/snappysonic.gif\n   :height: 134px\n   :target: https://github.com/SciKit-Surgery/snappysonic\n   :alt: Logo\n\n|\n\n.. image:: https://github.com/SciKit-Surgery/snappysonic/workflows/.github/workflows/ci.yml/badge.svg\n   :target: https://github.com/SciKit-Surgery/snappysonic/actions\n   :alt: GitHub Actions CI status\n\n.. image:: https://coveralls.io/repos/github/SciKit-Surgery/snappysonic/badge.svg?branch=master\u0026service=github\n    :target: https://coveralls.io/github/SciKit-Surgery/snappysonic?branch=master\n    :alt: Test coverage\n\n.. image:: https://readthedocs.org/projects/snappysonic/badge/?version=latest\n    :target: http://snappysonic.readthedocs.io/en/latest/?badge=latest\n    :alt: Documentation Status\n\n.. image:: https://img.shields.io/badge/DOI-10.5334%2Fjors.289-blue\n    :target: http://doi.org/10.5334/jors.289\n    :alt: The SnappySonic Paper\n\n.. image:: https://api.codeclimate.com/v1/badges/78440062319f61c55177/maintainability\n   :target: https://codeclimate.com/github/SciKit-Surgery/snappysonic/maintainability\n   :alt: Maintainability\n\n.. image:: https://img.shields.io/badge/-Video%20Tutorial-blueviolet?style=flat\u0026logo=youtube\n   :target: https://www.youtube.com/watch?v=BI4qyg9NEOk\n   :alt: Tutorial on YouTube\n\n.. image:: https://img.shields.io/twitter/follow/scikit_surgery?style=social\n   :target: https://twitter.com/scikit_surgery?ref_src=twsrc%5Etfw\n   :alt: Follow scikit_surgery on twitter\n\n\nAuthor: Stephen Thompson\n\nSnappySonic can be used as an ultrasound acquisition simulator. The output from a tracking system (NDI or AruCo tags) is to select a frame of pre-recorded video to show. A suitable video of ultrasound data is included in the data directory, however the user can select a video of their choosing. The software and its use is described in the `SnappySonic paper`_.\n\nSnappySonic 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)`_.\n\nSnappySonic supports Python 3.6.\n\n::\n\n    pip install snappysonic\n    python snappysonic.py --config config.json\n\nThe config file defines the tracking parameters and image buffer, e.g.\n\n::\n\n  {\n   \"ultrasound buffer\": \"data/usbuffer.mp4\",\n\t \"buffer descriptions\": [\n\t\t{\n\t\t \"name\": \"glove\",\n\t\t \"start frame\": 0,\n\t\t \"end frame\": 284,\n\t\t \"x0\": 20, \"x1\": 200,\n\t\t \"y0\": 200, \"y1\": 260,\n\t\t \"scan direction\": \"x\"\n\t\t},\n    ]\n    ....\n    \"tracker config\": {\n\t\t\"tracker type\": \"aruco\",\n\t\t\"video source\": 2,\n\t\t\"debug\": true,\n\t\t\"capture properties\": {\n\t\t\t\"CAP_PROP_FRAME_WIDTH\": 640,\n\t\t\t\"CAP_PROP_FRAME_HEIGHT\": 480\n\t\t\n   }\n  }\n\nAn example configuration file can be downloaded from `here`_ and an image buffer from `source code repository data directory`_\n\nDeveloping\n----------\n\nCloning\n^^^^^^^\n\nYou can clone the repository using the following command:\n\n::\n\n    git clone https://github.com/SciKit-Surgery/snappysonic\n\n\nRunning tests\n^^^^^^^^^^^^^\nUnit tests are performed in stand alone environments using tox, which also checks coding style.\n::\n\n    tox\n\n\nInstalling\n----------\n\nYou can pip install from pypi with\n::\n\n  pip install snappysonic\n\nor You can pip install directly from the repository as follows:\n::\n\n    pip install git+https://github.com/SciKit-Surgery/snappysonic\n\nHow to Cite\n-----------\nIf you use this software in your research or teaching, please cite:\n\nThompson, S., Dowrick, T., Xiao, G., Ramalhinho, J., Robu, M., Ahmad, M., Taylor, D. and Clarkson, M.J., 2020. SnappySonic: An Ultrasound Acquisition Replay Simulator. Journal of Open Research Software, 8(1), p.8. DOI: http://doi.org/10.5334/jors.289\n\nContributing\n^^^^^^^^^^^^\n\nPlease see the `contributing guidelines`_.\n\n\nUseful links\n^^^^^^^^^^^^\n\n* `Source code repository`_\n* `Documentation`_\n\n\nLicensing and copyright\n-----------------------\n\nCopyright 2019 University College London.\nsnappysonic is released under the BSD-3 license. Please see the `license file`_ for details.\n\n\nAcknowledgements\n----------------\n\nSupported by `Wellcome`_ and `EPSRC`_.\n\n\n.. _`Wellcome EPSRC Centre for Interventional and Surgical Sciences`: http://www.ucl.ac.uk/weiss\n.. _`source code repository`: https://github.com/SciKit-Surgery/snappysonic\n.. _`here`: https://github.com/SciKit-Surgery/snappysonic/blob/master/config.json\n.. _`source code repository data directory`: https://github.com/SciKit-Surgery/snappysonic/blob/master/data\n.. _`Documentation`: https://snappysonic.readthedocs.io\n.. _`SciKit-Surgery`: https://github.com/SciKit-Surgery\n.. _`University College London (UCL)`: http://www.ucl.ac.uk/\n.. _`Wellcome`: https://wellcome.ac.uk/\n.. _`EPSRC`: https://www.epsrc.ac.uk/\n.. _`contributing guidelines`: https://github.com/SciKit-Surgery/snappysonic/blob/master/CONTRIBUTING.rst\n.. _`license file`: https://github.com/SciKit-Surgery/snappysonic/blob/master/LICENSE\n.. _`SnappySonic paper`: http://doi.org/10.5334/jors.289\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscikit-surgery%2Fsnappysonic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscikit-surgery%2Fsnappysonic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscikit-surgery%2Fsnappysonic/lists"}