sksurgeryspherefitting

https://github.com/mxochicale/sksurgeryspherefitting

Repository

README.rst

scikit-surgery-sphere-fitting
===============================

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

.. image:: https://github.com/mxochicale/sksurgeryspherefitting/badges/master/build.svg
   :target: https://github.com/mxochicale/sksurgeryspherefitting/pipelines
   :alt: GitLab-CI test status

.. image:: https://github.com/mxochicale/sksurgeryspherefitting/badges/master/coverage.svg
    :target: https://github.com/mxochicale/sksurgeryspherefitting/commits/master
    :alt: Test coverage

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



Author: Miguel Xochicale

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

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

::

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

Please explore the project structure, and implement your own functionality.

sksurgeryspherefitting package
==============================

Subpackages
-----------

.. toctree::
   :maxdepth: 4

   sksurgeryspherefitting.algorithms
   sksurgeryspherefitting.ui

Module contents
---------------

.. automodule:: sksurgeryspherefitting
   :members:
   :undoc-members:
   :show-inheritance:


Developing
----------

Cloning
^^^^^^^

You can clone the repository using the following command:

::

    git clone https://github.com/mxochicale/sksurgeryspherefitting


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 sksurgeryspherefitting


Installing
----------

You can pip install directly from the repository as follows:

::

    pip install git+https://github.com/mxochicale/sksurgeryspherefitting



Contributing
^^^^^^^^^^^^

Please see the `contributing guidelines`_.


Useful links
^^^^^^^^^^^^

* `Source code repository`_
* `Documentation`_


Licensing and copyright
-----------------------

Copyright 2022 University College London.
scikit-surgery-sphere-fitting 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/mxochicale/sksurgeryspherefitting
.. _`Documentation`: https://sksurgeryspherefitting.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/mxochicale/sksurgeryspherefitting/blob/master/CONTRIBUTING.rst
.. _`license file`: https://github.com/mxochicale/sksurgeryspherefitting/blob/master/LICENSE

Owner

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use any SciKit-Surgery packages in your research, please cite it as below."
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: "Clarkson"
  given-names: "Matthew"
  orcid: "https://orcid.org/0000-0002-5565-1252"
title: "SciKit-Surgery"
url: "https://github.com/SciKit-Surgery/scikit-surgery"
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

Committers

Last synced: about 1 year ago

Issues and Pull Requests

Last synced: about 1 year ago