Metadata-Version: 2.1
Name: pymedphys
Version: 0.7.0
Summary: Medical Physics python modules
Home-page: UNKNOWN
Author: Simon Biggs
Author-email: me@simonbiggs.net
License: AGPLv3+
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Healthcare Industry
Description-Content-Type: text/x-rst
Provides-Extra: docs
Provides-Extra: testing
Requires-Dist: attrs
Requires-Dist: keyring
Requires-Dist: matplotlib
Requires-Dist: notebook
Requires-Dist: numpy (<1.16,>=1.12)
Requires-Dist: pandas
Requires-Dist: Pillow
Requires-Dist: psutil
Requires-Dist: pydicom (>=1.0)
Requires-Dist: pymssql
Requires-Dist: python-dateutil
Requires-Dist: scipy
Requires-Dist: shapely
Requires-Dist: xarray
Requires-Dist: xlwings; platform_system != "Linux"
Requires-Dist: dataclasses; python_version == "3.6"
Provides-Extra: docs
Requires-Dist: m2r; extra == 'docs'
Requires-Dist: sphinxcontrib-napoleon; extra == 'docs'
Requires-Dist: sphinx (<1.8,>=1.4); extra == 'docs'
Requires-Dist: sphinx-rtd-theme; extra == 'docs'
Requires-Dist: sphinx-argparse; extra == 'docs'
Requires-Dist: nbsphinx; extra == 'docs'
Provides-Extra: testing
Requires-Dist: deepdiff; extra == 'testing'
Requires-Dist: pytest; extra == 'testing'
Requires-Dist: pytest-cov; extra == 'testing'
Requires-Dist: xlwings (>=0.15.4); extra == 'testing'

==========================================================
PyMedPhys |build| |docs| |pypi| |conda| |python| |license|
==========================================================

.. |build| image:: https://dev.azure.com/pymedphys/pymedphys/_apis/build/status/pymedphys.pymedphys?branchName=master
    :target: https://dev.azure.com/pymedphys/pymedphys/_build/latest?definitionId=4&branchName=master

.. |docs| image:: https://readthedocs.org/projects/pymedphys/badge/?version=latest
    :target: https://pymedphys.com/

.. |pypi| image:: https://img.shields.io/pypi/v/pymedphys.svg
    :target: https://pypi.org/project/pymedphys/

.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/pymedphys.svg
    :target: https://anaconda.org/conda-forge/pymedphys/

.. |python| image:: https://img.shields.io/pypi/pyversions/pymedphys.svg
    :target: https://pypi.org/project/pymedphys/

.. |license| image:: https://img.shields.io/pypi/l/pymedphys.svg
    :target: https://choosealicense.com/licenses/agpl-3.0/


Description
-----------

.. START_OF_ABOUT_IMPORT

PyMedPhys is a toolbox for Medical Physicists that we all have access to, and
we will all have access to whatever it becomes in the future. It is inspired
by our physics peers in astronomy and their `Astropy Project`_.

PyMedPhys aims to become not just a library, but instead a Medical Physics
open source `monorepo`_ where we can all store, review, use, and learn off of
each other's code. It is structured and glued together with Python, but
certainly not limited to one programming language.

.. _`Astropy Project`: http://www.astropy.org/

.. _`monorepo`: https://cacm.acm.org/magazines/2016/7/204032-why-google-stores-billions-of-lines-of-code-in-a-single-repository/fulltext

This package is available on PyPI (https://pypi.org/project/pymedphys/),
GitHub (https://github.com/pymedphys/pymedphys), and conda-forge
(https://anaconda.org/conda-forge/pymedphys). Documentation is at
https://pymedphys.com.

Our Team
--------

PyMedPhys is what it is today due to its maintainers and developers. The
currently active developers and maintainers of PyMedPhys are given below
along with their affiliation:

* `Simon Biggs`_
    * `Riverina Cancer Care Centre`_, Australia

.. _`Simon Biggs`: https://github.com/SimonBiggs


* `Matthew Jennings`_
    * `Royal Adelaide Hospital`_, Australia

.. _`Matthew Jennings`: https://github.com/centrus007


* `Paul King`_
    * `Anderson Regional Cancer Center`_, United States

.. _`Paul King`: https://github.com/kingrpaul


* `Matthew Sobolewski`_
    * `Riverina Cancer Care Centre`_, Australia
    * `Northern Beaches Cancer Care`_, Australia

.. _`Matthew Sobolewski`: https://github.com/msobolewski


* `Jacob McAloney`_
    * `Riverina Cancer Care Centre`_, Australia

.. _`Jacob McAloney`: https://github.com/JacobMcAloney


.. image:: https://github.com/pymedphys/pymedphys/raw/master/docs/logos/RCCC_logo.png
    :target: `Riverina Cancer Care Centre`_
    :width: 500 px

.. image:: https://github.com/pymedphys/pymedphys/raw/master/docs/logos/GOSA_logo.png
    :target: `Royal Adelaide Hospital`_
    :width: 500 px

.. image:: https://github.com/pymedphys/pymedphys/raw/master/docs/logos/JARMC_logo.png
    :target: `Anderson Regional Cancer Center`_
    :width: 500 px

.. image:: https://github.com/pymedphys/pymedphys/raw/master/docs/logos/NBCCC_logo.png
    :target: `Northern Beaches Cancer Care`_
    :width: 500 px

.. _`Riverina Cancer Care Centre`: http://www.riverinacancercare.com.au/

.. _`Royal Adelaide Hospital`: http://www.rah.sa.gov.au/

.. _`Anderson Regional Cancer Center`: http://www.andersonregional.org/CancerCenter.aspx

.. _`Northern Beaches Cancer Care`: http://www.northernbeachescancercare.com.au/


We want you on this list. We want you, whether you are a  clinical Medical
Physicist, PhD or Masters student, researcher, or even just someone with an
interest in Python to join our
team. We want you if you have a desire to create and validate a toolbox we can
all use to improve how we care for our patients.

The aim of PyMedPhys is that it will be developed by an open community of
contributors. We use a shared copyright model that enables all contributors
to maintain the copyright on their contributions. All code is licensed under
the AGPLv3+ with additional terms from the Apache-2.0 license.


.. END_OF_ABOUT_IMPORT


Beta stage development
----------------------

These libraries are currently under beta level development.
Be prudent with the code in this library.

Throughout the lifetime of this library the following disclaimer will always
hold:

    In no event and under no legal theory, whether in tort
    (including negligence), contract, or otherwise, unless required by
    applicable law (such as deliberate and grossly negligent acts) or agreed
    to in writing, shall any Contributor be liable to You for damages,
    including any direct, indirect, special, incidental, or consequential
    damages of any character arising as a result of this License or out of
    the use or inability to use the Work (including but not limited to damages
    for loss of goodwill, work stoppage, computer failure or malfunction, or
    any and all other commercial damages or losses), even if such Contributor
    has been advised of the possibility of such damages.

Where the definition of License is taken to be the
AGPLv3+ with additional terms from the Apache 2.0. The definitions of
Contributor, You, and Work for this clause are as defined within the
Apache 2.0 license.


.. END_OF_FRONTPAGE_IMPORT


Installation
------------

For instructions on how to install see the documentation at
https://pymedphys.com/en/latest/getting-started/installation.html.


Contributing
------------

See the contributor documentation at https://pymedphys.com/en/latest/developer/contributing.html
if you wish to create and validate open source Medical Physics tools together.


