MPHY0026: Computer Assisted Surgery and Therapy

.. image:: https://github.com/UCL/MPHY0026/raw/master/project-icon.png
:height: 128px
:width: 128px
:target: https://github.com/UCL/MPHY0026
:alt: Logo

.. image:: https://github.com/UCL/MPHY0026/workflows/.github/workflows/ci.yml/badge.svg
:target: https://github.com/UCL/MPHY0026/actions
:alt: GitHub Actions CI status

.. image:: https://readthedocs.org/projects/mphy0026/badge/?version=latest
:target: http://mphy0026.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

Authors: Matt Clarkson, Steve Thompson, Ester Bonmati, etc.

This is the git repository of the Computer Assisted Surgery and Therapy (MPHY0026) course
developed at the Wellcome EPSRC Centre for Interventional and Surgical Sciences,
part of University College London (UCL).

The generated documentation lives on Read The Docs_.

Running

To avoid code duplication, look at the instructions online to run Jupyter notebooks <https://mphy0026.readthedocs.io/en/latest/setup/setup.html#>_.

Developing

Cloning
^^^^^^^

You can clone the repository using the following command:

git clone https://github.com/UCL/MPHY0026

Running tests
^^^^^^^^^^^^^

Pytest is used for running unit tests, but you should run pytest using tox.
Please see the instructions online to run tests using tox <https://mphy0026.readthedocs.io/en/latest/setup/setup.html#>_.

Linting
^^^^^^^

This code conforms to the PEP8 standard. Pylint is used to analyse the code.
Again, follow the instructions online to see pylint run via tox <https://mphy0026.readthedocs.io/en/latest/setup/setup.html#>_.

Contributing

Please see the contributing guidelines_.

Useful links

Source code repository_
Documentation_

Licensing and copyright

Copyright 2019 University College London.
MPHY0026 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/UCL/MPHY0026
.. _Documentation: https://MPHY0026.readthedocs.io
.. _Read The Docs: https://MPHY0026.readthedocs.io
.. _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/UCL/MPHY0026/blob/master/CONTRIBUTING.rst
.. _license file: https://github.com/UCL/MPHY0026/blob/master/LICENSE

UCL/MPHY0026