README.rst

scikit-surgeryaudio

Author: Stephen Thompson

scikit-surgeryaudio 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-surgeryaudio is tested on Python 3.7 but should support other modern Python versions.

scikit-surgeryaudio is currently a demo project, which will add/multiply two numbers. Example usage:

python sksaudio.py 5 8
python sksaudio.py 3 6 --multiply

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-surgeryaudio

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 sksaudio

Installing

You can pip install directly from the repository as follows:

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

Contributing

Please see the contributing guidelines.

Useful links

• Source code repository
• Documentation

Licensing and copyright

Copyright 2023 University College London. scikit-surgeryaudio is released under the BSD-3 license. Please see the license file for details.

Acknowledgements

Supported by Wellcome and EPSRC.