Commit d34f47ef authored by Pierre Paleo's avatar Pierre Paleo
Browse files

Edit doc first page

parent d428b297
Pipeline #24503 passed with stage
in 49 seconds
# Installation
To install the current release:
```
pip install nabu
```
To install the current development version
```bash
pip install git+https://gitlab.esrf.fr/tomotools/nabu.git
```
## Dependencies
The above `pip install` command should automatically install the nabu dependencies.
For the record, the mandatory dependencies are the following:
- numpy
- pytest
- psutil
- [silx](http://www.silx.org/)
- [tomoscan](https://gitlab.esrf.fr/tomotools/tomoscan)
All of them can be installed with `pip`.
There are optional dependencides enabling various features:
- Computations acceleration (GPU/manycore CPU): `pycuda`, `pyopencl`
- Computations distribution: `distributed`, `dask_jobqueue`
Please note that Nabu supports Python >= 3.5.
# Quick start
## Create a configuration file
The configuration file defines the different processing steps and their options.
To create a configuration file from scratch, you can use
```bash
nabu-config --bootstrap
```
More options are available, see `nabu-config --help`.
## Run the reconstruction
Once you filled-in the configuration, just run
```bash
nabu nabu.conf
```
More options are available, see `nabu --help`. For example, to reconstruct slices 1000 to 1100: `nabu nabu.conf --slice 1000-1100`
## See also
[Configuration file](nabu_config_file.md)
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment