Skip to content
Snippets Groups Projects
README.md 1.92 KiB
Newer Older
Pierre Paleo's avatar
Pierre Paleo committed
# Nabu

Pierre Paleo's avatar
Pierre Paleo committed
ESRF tomography processing software.
Pierre Paleo's avatar
Pierre Paleo committed

Pierre Paleo's avatar
Pierre Paleo committed
## Installation
Pierre Paleo's avatar
Pierre Paleo committed

Nicola Vigano's avatar
Nicola Vigano committed
To install the development version:
pip install [--user] git+https://gitlab.esrf.fr/tomotools/nabu.git
```
The above command should automatically install the following nabu Python dependencies:

- numpy, distributed, pytest
- For computations acceleration: pycuda, pyopencl
Nicola Vigano's avatar
Nicola Vigano committed
- silx ([http://www.silx.org/](http://www.silx.org/))
- tomoscan ([https://gitlab.esrf.fr/tomotools/tomoscan](https://gitlab.esrf.fr/tomotools/tomoscan))
Nicola Vigano's avatar
Nicola Vigano committed
All of them can be installed using `pip`.

Please note that Nabu supports Python >= 3.5.

Pierre Paleo's avatar
Pierre Paleo committed
## 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
Nicola Vigano's avatar
Nicola Vigano committed
  - From Tomwer ([https://gitlab.esrf.fr/tomotools/tomwer/](https://gitlab.esrf.fr/tomotools/tomwer/))
Pierre Paleo's avatar
Pierre Paleo committed

Nicola Vigano's avatar
Nicola Vigano committed
To get quickly started, launch:
Pierre Paleo's avatar
Pierre Paleo committed
```bash
nabu-config --bootstrap
```
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

Nicola Vigano's avatar
Nicola Vigano committed
The documentation can be found on the silx.org page ([http://www.silx.org/pub/nabu/doc](http://www.silx.org/pub/nabu/doc)).
Nicola Vigano's avatar
Nicola Vigano committed
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

Nicola Vigano's avatar
Nicola Vigano committed
Once nabu is installed, running

```bash
nabu-test
```
Pierre Paleo's avatar
Pierre Paleo committed
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.
Pierre Paleo's avatar
Pierre Paleo committed

Pierre Paleo's avatar
Pierre Paleo committed
## Nabu - what's in a name ?
Pierre Paleo's avatar
Pierre Paleo committed

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