Metadata-Version: 2.4
Name: httomo-backends
Version: 0.7
Summary: Supplementary files for HTTomo backends.
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-backends
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: numpy<2
Requires-Dist: pyyaml
Requires-Dist: cupy==12.3.0
Requires-Dist: nvtx
Requires-Dist: toml
Requires-Dist: imageio
Requires-Dist: h5py
Requires-Dist: astra-toolbox
Requires-Dist: tomobar
Requires-Dist: scikit-image
Requires-Dist: ccpi-regularisation-cupy
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-mock; extra == "dev"
Dynamic: license-file

HTTomo-backends
---------------

Purpose of HTTomo-backends
==========================

**HTTomo-backends** is a package to support `HTTomo <https://diamondlightsource.github.io/httomo/>`_ software and it contains the following elements:

* YAML templates for `backends <https://diamondlightsource.github.io/httomo/backends/list.html>`_. Those include methods from those libraries. The YAML templates can be accessed directly in the environment where `httomo-backends` is installed. 
* Scripts that automatically generate YAML templates during documentation build.
* Supporting scripts to calculate memory, size and padding estimators of the methods


Installation
============

HTTomo-backends is available on PyPI, so it can be installed into either a virtual environment
or a conda environment.

Virtual environment
~~~~~~~~~~~~~~~~~~~
.. code-block:: console

   $ python -m venv httomo-backends
   $ source httomo-backends/bin/activate
   $ pip install httomo-backends

Conda environment
~~~~~~~~~~~~~~~~~

.. code-block:: console

   $ conda create --name httomo-backends
   $ conda activate httomo-backends
   $ conda install -c conda-forge cupy==12.3.0
   $ pip install httomo-backends
