# Quick start

If you are using this software from ESRF, first activate the integrator module:

```bash
source /scisoft/tomotools_env/integrator/activate
```

By default, the latest version is selected.

You can also select a version, eg. `source /scisoft/tomotools_env/integrator/activate 2022.1.2`


`integrator` is used in two steps:
  - Create/fill a [configuration file](config_file.md)
  - Run `integrate-XX <config_file>` to distribute azimuthal integration over multiple CPUS/nodes.


## Create a configuration file

Create a [configuration file](config_file):

```bash
integrator-config
```

It will create a file named `integrator.conf` with pre-filled values.
More options are available, see `integrator-config --help`.
For example, to create a template configuration file with all visible parameters, use

```bash
integrator-config --level advanced
```


## Run the integration

Once you filled-in the configuration, to perform [distributed azimuthal integration](integration) on a dataset, 
just run

```bash
integrate-slurm integrator.conf
```

to distribute integration on multiple nodes (SLURM cluster), or

```bash
integrate-mp integrator.conf
```

to distribute integration on the local machine or several GPU machines.


More options are available, see `integrate-slurm --help`.