Skip to content

DiamondLightSource/httomo

Repository files navigation

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 and 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 .

Documentation

Please check the full documentation.

Running HTTomo:

  • Install the module following any chosen installation path.
  • For help with the command line interface, execute python -m httomo --help
  • Choose the existing YAML pipeline or build a new one using ready-to-be-used templates.
  • Optional: perform the validity check of the YAML pipeline file with the YAML checker.
  • Run HTTomo with python -m httomo run [OPTIONS] IN_DATA_FILE YAML_CONFIG OUT_DIR, see more on that here.

Release Tagging Scheme

We use the setuptools-git-versioning package for automatically determining the version from the latest git tag. For this to work, release tags should start with a v followed by the actual version, e.g. v1.1.0a.