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

Doc: update configuration file

parent b7d780fb
Pipeline #24684 passed with stage
in 1 minute and 8 seconds
......@@ -2,7 +2,7 @@
## Rationale
A tomography processing can differ notably from one dataset to another: how should the data be read (file format, ignore certain radios, binning, ...) ? What are the preprocessing steps (phase retrieval, CCD hotspots, ...) ? Do we apply some corrections (rotation axis, rings artefacts, ...) ? In which region of interest do we want to reconstruct ?
A tomography processing can differ notably from one dataset to another: how should the data be read (file format, binning, ...) ? What are the preprocessing steps (phase retrieval, CCD hotspots, ...) ? Do we apply some corrections (rotation axis, rings artefacts, ...) ? In which region of interest do we want to reconstruct ?
For this reason, Nabu enables to describe the processing steps in a configuration file. The nabu configuration file ("`nabu.conf`") is therefore a file describing the processing steps, from dataset analysis/preprocessing to the reconstruction. It is the equivalent of PyHST2 "`.par`" files, although sometimes with a different approach.
......@@ -16,6 +16,15 @@ More options are available, see `nabu-config --help`.
The bootstrap command will create a new file (`nabu.conf` by default) in the current directory. You can then edit the relevant fields to describe the processing you want.
All the configuration options are pre-filled with their default value, except the dataset location.
## Options visibility levels
By default, the configuration file is generated with the "most usual" options. In order to add more options, you can tune the `--level` parameter:
- `nabu-config --bootstrap --level required` (default) generates a "minimalistic" configuration file
- `nabu-config --bootstrap --level optional` generates the configuration file with more options
- `nabu-config --bootstrap --level advanced` generates the configuration file with all options
## File format and description
......@@ -56,13 +65,9 @@ The principle is the same: the user defines the processing steps through this co
However, in Nabu, many things are guessed automatically. For example, you don't need to provide the number of pixels horizontally/vertically in the radios, the length of the numerical part, etc. Basically, all the information that can be automatically inferred from the dataset metadata is automatically handled, so that you only have to fill-in relevant parts.
``` seealso:: nabu.resources.dataset_analyzer
```
### Can nabu be used without this configuration file ?
Nabu is foremost a library, meaning that all its component can be accessed via an Application Programming Interface (API). Please see: [Nabu API reference](apidoc/nabu.md).
Yes. Nabu is foremost a library, meaning that all its component can be accessed via an Application Programming Interface (API). Please see: [Nabu API reference](apidoc/nabu.md).
### Compatibility policy
......
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