Metadata-Version: 2.2
Name: httomo
Version: 2.3
Summary: High Throughput Tomography framework.
Author: Garry ODonnell, Jacob Williamson
Author-email: Daniil Kazantsev <daniil.kazantsev@diamond.ac.uk>, Yousef Moazzam <yousef.moazzam@diamond.ac.uk>, Jessica Verschoyle <jessica.verschoyle@diamond.ac.uk>, Naman Gera <naman.gera@diamond.ac.uk>, scientificsoftware@diamond.ac.uk
License: BSD-3-Clause
Project-URL: repository, https://github.com/DiamondLightSource/HTTomo
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: click
Requires-Dist: numpy
Requires-Dist: httomolib
Requires-Dist: loguru
Requires-Dist: typing-extensions
Requires-Dist: tqdm
Requires-Dist: graypy
Provides-Extra: cpu
Requires-Dist: tomopy; extra == "cpu"
Provides-Extra: gpu
Requires-Dist: httomolibgpu; extra == "gpu"
Provides-Extra: dev-cpu
Requires-Dist: pytest; extra == "dev-cpu"
Requires-Dist: pytest-cov; extra == "dev-cpu"
Requires-Dist: pytest-xdist; extra == "dev-cpu"
Requires-Dist: pytest-mock; extra == "dev-cpu"
Requires-Dist: flake8; extra == "dev-cpu"
Requires-Dist: pyproject-flake8; extra == "dev-cpu"
Requires-Dist: pydocstyle; extra == "dev-cpu"
Requires-Dist: toml; extra == "dev-cpu"
Requires-Dist: httomolib[dev]; extra == "dev-cpu"
Requires-Dist: tomopy; extra == "dev-cpu"
Requires-Dist: plumbum; extra == "dev-cpu"
Requires-Dist: typing_extensions; extra == "dev-cpu"
Requires-Dist: mypy; extra == "dev-cpu"
Requires-Dist: types-PyYAML; extra == "dev-cpu"
Requires-Dist: pre-commit; extra == "dev-cpu"
Provides-Extra: dev-gpu
Requires-Dist: pytest; extra == "dev-gpu"
Requires-Dist: pytest-cov; extra == "dev-gpu"
Requires-Dist: pytest-xdist; extra == "dev-gpu"
Requires-Dist: pytest-mock; extra == "dev-gpu"
Requires-Dist: flake8; extra == "dev-gpu"
Requires-Dist: pyproject-flake8; extra == "dev-gpu"
Requires-Dist: pydocstyle; extra == "dev-gpu"
Requires-Dist: toml; extra == "dev-gpu"
Requires-Dist: httomolib[dev]; extra == "dev-gpu"
Requires-Dist: httomolibgpu[dev]; extra == "dev-gpu"
Requires-Dist: tomopy; extra == "dev-gpu"
Requires-Dist: plumbum; extra == "dev-gpu"
Requires-Dist: typing_extensions; extra == "dev-gpu"
Requires-Dist: mypy; extra == "dev-gpu"
Requires-Dist: types-PyYAML; extra == "dev-gpu"
Requires-Dist: pre-commit; extra == "dev-gpu"

HTTomo (High Throughput Tomography pipeline)
*******************************************************

HTTomo is a user interface (UI) written in Python for fast big data processing using MPI protocols.
It orchestrates I/O data operations and enables processing on a CPU and/or a GPU. HTTomo utilises other libraries, such as `TomoPy <https://tomopy.readthedocs.io>`_ and `HTTomolibgpu <https://github.com/DiamondLightSource/httomolibgpu>`_
as backends for data processing. The methods from the libraries are exposed through YAML templates to enable fast task programming.

Installation
============
See detailed instructions for `installation <https://diamondlightsource.github.io/httomo/howto/installation.html>`_ .

Documentation
==============
Please check the full `documentation <https://diamondlightsource.github.io/httomo/>`_.

Running HTTomo:
================

* Install the module following any chosen `installation <https://diamondlightsource.github.io/httomo/howto/installation.html>`_ path.
* For help with the command line interface, execute :code:`python -m httomo --help`
* Choose the existing `YAML pipeline <https://diamondlightsource.github.io/httomo/pipelines/yaml.html>`_ or build a new one using ready-to-be-used `templates <https://diamondlightsource.github.io/httomo/backends/templates.html>`_.
* Optional: perform the validity check of the YAML pipeline file with the `YAML checker <https://diamondlightsource.github.io/httomo/utilities/yaml_checker.html>`_.
* Run HTTomo with :code:`python -m httomo run [OPTIONS] IN_DATA_FILE YAML_CONFIG OUT_DIR`, see more on that `here <https://diamondlightsource.github.io/httomo/howto/run_httomo.html>`_.

Release Tagging Scheme
======================

We use the `setuptools-git-versioning <https://setuptools-git-versioning.readthedocs.io/en/stable/index.html>`_
package for automatically determining the version from the latest git tag.
For this to work, release tags should start with a :code:`v` followed by the actual version,
e.g. :code:`v1.1.0a`.
