README.rst
**TomoPy** is an open-source
Python package for tomographic data processing and image reconstruction.
.. image:: https://readthedocs.org/projects/tomopy/badge/?version=latest
:target: https://readthedocs.org/projects/tomopy/?badge=latest
:alt: Read the Docs
.. image:: https://dev.azure.com/tomopy/tomopy/_apis/build/status/tomopy.tomopy?branchName=master
:target: https://dev.azure.com/tomopy/tomopy
:alt: Azure Pipelines
.. image:: https://coveralls.io/repos/tomopy/tomopy/badge.svg?branch=master
:target: https://coveralls.io/r/tomopy/tomopy?branch=master
:alt: Coveralls
.. image:: https://codeclimate.com/github/tomopy/tomopy/badges/gpa.svg
:target: https://codeclimate.com/github/tomopy/tomopy
:alt: Code Climate
.. image:: https://anaconda.org/conda-forge/tomopy/badges/downloads.svg
:target: https://anaconda.org/conda-forge/tomopy
:alt: Anaconda downloads
.. image:: https://mybinder.org/badge.svg
:target: https://mybinder.org/v2/gh/tomopy/tomopy/master
:alt: Use on Binder
|
Features
========
* Image reconstruction algorithms for tomography.
* Various filters, ring removal algorithms, phase retrieval algorithms.
* Forward projection operator for absorption and wave propagation.
Installation
============
Have `Conda <http://continuum.io/downloads>`_ installed first,
then open a terminal or a command prompt window and run:
.. code-block::
conda install -c conda-forge tomopy
.. warning:: TomoPy will drop support for Python 2 before 1 January 2020. For more information, visit https://python3statement.org/.
Try Now
=======
Some `Example Jupyter notebooks <https://tomopy.readthedocs.io/en/latest/examples.html>`_ will run in your
browser using `binder <https://mybinder.org/v2/gh/tomopy/tomopy/master?filepath=doc%2Fsource%2Fipynb%2Ftomopy.ipynb>`_.
Contribute
==========
* Bugs Tracker: https://github.com/tomopy/tomopy/projects/1
* Issue Tracker: https://github.com/tomopy/tomopy/issues
* Documentation: https://github.com/tomopy/tomopy/tree/master/doc
* Source Code: https://github.com/tomopy/tomopy/tree/master/tomopy
* Tests: https://github.com/tomopy/tomopy/tree/master/test
License
=======
The project is licensed under the
`BSD-3 <https://github.com/tomopy/tomopy/blob/master/LICENSE.txt>`_ license.