Metadata-Version: 2.4
Name: volio
Version: 0.0.0.dev0
Summary: Volume load/save for tomography data at ESRF
Author-email: Henri Payno <henri.payno@esrf.fr>, Pierre Paleo <pierre.paleo@esrf.fr>, Pierre-Olivier Autran <pierre-olivier.autran@esrf.fr>, Jérôme Lesaint <jerome.lesaint@esrf.fr>
License-Expression: MIT
Keywords: tomography,esrf,volume,reconstruction
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Environment :: Console
Classifier: Operating System :: POSIX
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: tomobase>=0.0.0dev0
Requires-Dist: h5py>=3.0
Requires-Dist: silx>=2.0
Requires-Dist: numpy
Requires-Dist: pint
Requires-Dist: packaging>=22.0
Requires-Dist: fabio
Requires-Dist: defusedxml
Requires-Dist: dicttoxml
Requires-Dist: tifffile>=2023.7.4
Provides-Extra: compression-plugins
Requires-Dist: hdf5plugin; extra == "compression-plugins"
Requires-Dist: blosc2-grok; extra == "compression-plugins"
Provides-Extra: full-no-compression-plugins
Requires-Dist: glymur; extra == "full-no-compression-plugins"
Requires-Dist: tqdm; extra == "full-no-compression-plugins"
Requires-Dist: tifffile[zarr]>=2023.7.4; extra == "full-no-compression-plugins"
Requires-Dist: zarr; extra == "full-no-compression-plugins"
Provides-Extra: full
Requires-Dist: volio[full_no_compression_plugins]; extra == "full"
Requires-Dist: volio[compression_plugins]; extra == "full"
Provides-Extra: test
Requires-Dist: volio[full]; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: ruff; extra == "test"
Provides-Extra: doc
Requires-Dist: Sphinx<5.2.0,>=4.0.0; extra == "doc"
Requires-Dist: nbsphinx; extra == "doc"
Requires-Dist: pandoc; extra == "doc"
Requires-Dist: ipykernel; extra == "doc"
Requires-Dist: jupyter_client; extra == "doc"
Requires-Dist: nbconvert; extra == "doc"
Requires-Dist: h5glance; extra == "doc"
Requires-Dist: pydata_sphinx_theme; extra == "doc"
Requires-Dist: sphinx-design; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
Requires-Dist: myst-parser; extra == "doc"
Requires-Dist: sphinx-copybutton; extra == "doc"
Dynamic: license-file

# volio

![volio](doc/img/volio-lockup.svg)

Volume load/save for tomography data at ESRF.

`volio` reads and writes tomography reconstruction volumes stored in several formats:

* HDF5 (`HDF5Volume`)
* single frame EDF (`EDFVolume`)
* single frame or multi-frame TIFF (`TIFFVolume`, `MultiTIFFVolume`)
* JPEG2000 (`JP2KVolume`)
* raw / `.vol` (`RawVolume`)

It also provides utilities to guess volumes from a file or folder, concatenate volumes,
and map reconstruction metadata to the drac/icat data-portal metadata model.

## installation

### using pypi

To install the latest 'volio' pip package

``` bash
pip install volio
```

### using gitlab repository

``` bash
pip install git+https://gitlab.esrf.fr/tomotools/volio.git
```

## documentation

General documentation can be found here: [https://tomotools.gitlab-pages.esrf.fr/volio/](https://tomotools.gitlab-pages.esrf.fr/volio/)
