Commit 877af696 authored by Pierre Paleo's avatar Pierre Paleo
Browse files

Update README

parent bf62de3d
Pipeline #46591 passed with stage
in 5 minutes and 32 seconds
......@@ -9,16 +9,11 @@ To install the development version:
```bash
pip install [--user] git+https://gitlab.esrf.fr/tomotools/nabu.git
```
The above command should automatically install the following nabu Python dependencies:
To install the stable version:
- numpy, distributed, pytest
- For computations acceleration: pycuda, pyopencl
- silx ([http://www.silx.org/](http://www.silx.org/))
- tomoscan ([https://gitlab.esrf.fr/tomotools/tomoscan](https://gitlab.esrf.fr/tomotools/tomoscan))
All of them can be installed using `pip`.
Please note that Nabu supports Python >= 3.5.
```bash
pip install [--user] nabu
```
## Usage
......@@ -29,7 +24,7 @@ Nabu can be used in several ways:
To get quickly started, launch:
```bash
nabu-config --bootstrap
nabu-config
```
Edit the generated configuration file (`nabu.conf`). Then:
......@@ -41,7 +36,7 @@ will reconstruct the slices 500 to 600, with processing steps depending on `nabu
## Documentation
The documentation can be found on the silx.org page ([http://www.silx.org/pub/nabu/doc](http://www.silx.org/pub/nabu/doc)).
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/)
......
Markdown is supported
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