Metadata-Version: 2.4
Name: nabu
Version: 2025.2.4
Summary: Nabu - Tomography software
Author-email: Pierre Paleo <pierre.paleo@esrf.fr>, Henri Payno <henri.payno@esrf.fr>, Alessandro Mirone <mirone@esrf.fr>, Jérôme Lesaint <jerome.lesaint@esrf.fr>
Maintainer-email: Pierre Paleo <pierre.paleo@esrf.fr>
License-Expression: MIT
Project-URL: Homepage, https://gitlab.esrf.fr/tomotools/nabu
Project-URL: Documentation, http://www.silx.org/pub/nabu/doc
Project-URL: Repository, https://gitlab.esrf.fr/tomotools/nabu/-/releases
Project-URL: Changelog, https://gitlab.esrf.fr/tomotools/nabu/-/blob/master/CHANGELOG.md
Keywords: tomography,reconstruction,X-ray imaging,synchrotron radiation,High Performance Computing,Parallel geometry,Conebeam geometry,Helical geometry,Ring artefact correction,Geometric calibration
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
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: Environment :: Console
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>1.9.0
Requires-Dist: scipy
Requires-Dist: h5py>=3.0
Requires-Dist: silx>=0.15.0
Requires-Dist: tomoscan>=2.3.0
Requires-Dist: psutil
Requires-Dist: pytest
Requires-Dist: tifffile
Requires-Dist: tqdm
Provides-Extra: full
Requires-Dist: scikit-image; extra == "full"
Requires-Dist: PyWavelets; extra == "full"
Requires-Dist: glymur; extra == "full"
Requires-Dist: pycudwt; extra == "full"
Requires-Dist: sluurp>=0.3; extra == "full"
Requires-Dist: pyvkfft; extra == "full"
Provides-Extra: full-nocuda
Requires-Dist: scikit-image; extra == "full-nocuda"
Requires-Dist: PyWavelets; extra == "full-nocuda"
Requires-Dist: glymur; extra == "full-nocuda"
Requires-Dist: sluurp>=0.3; extra == "full-nocuda"
Requires-Dist: pyvkfft; extra == "full-nocuda"
Provides-Extra: doc
Requires-Dist: mkdocs; extra == "doc"
Requires-Dist: mkdocs-material; extra == "doc"
Requires-Dist: mkdocs-material-extensions; extra == "doc"
Requires-Dist: mkdocs-gen-files; extra == "doc"
Requires-Dist: mkdocs-markdownextradata-plugin; extra == "doc"
Requires-Dist: mkdocs-pagetree-plugin; extra == "doc"
Requires-Dist: mkapi; extra == "doc"
Requires-Dist: mkdocs-jupyter; extra == "doc"
Requires-Dist: nbconvert; extra == "doc"
Requires-Dist: markdown-exec; extra == "doc"
Dynamic: license-file

# Nabu

ESRF tomography processing software.

## Installation

To install the development version:

```bash
pip install [--user] git+https://gitlab.esrf.fr/tomotools/nabu.git
```
To install the stable version:

```bash
pip install [--user] nabu
```

## Usage

Nabu can be used in several ways:
  - As a Python library, by features like `Backprojector`, `FlatField`, etc
  - As a standalone application with the command line interface
  - From Tomwer ([https://gitlab.esrf.fr/tomotools/tomwer/](https://gitlab.esrf.fr/tomotools/tomwer/))

To get quickly started, launch:
```bash
nabu-config 
```
Edit the generated configuration file (`nabu.conf`). Then:

```bash
nabu nabu.conf --slice 500-600
```

will reconstruct the slices 500 to 600, with processing steps depending on `nabu.conf` contents.

## Documentation

The documentation can be found on the silx.org page ([https://www.silx.org/pub/nabu/doc](http://www.silx.org/pub/nabu/doc)).

The latest documentation built by continuous integration can be found here: [https://tomotools.gitlab-pages.esrf.fr/nabu/](https://tomotools.gitlab-pages.esrf.fr/nabu/)

## Running the tests

Once nabu is installed, running

```bash
nabu-test
```
will execute all the tests. You can also specify specific module(s) to test, for example:
```bash
nabu-test preproc misc
```
You can also provide more `pytest` options, for example increase verbosity with `-v`, exit at the first fail with `-x`, etc. Use `nabu-test --help` for displaying the complete options list.



## Nabu - what's in a name ?

Nabu was the Mesopotamian god of literacy, rational arts, scribes and wisdom.
