Installing BLISS at ESRF¶

At the ESRF, it is recommended to follow the Beamline Control Unit guidelines for software installation. In the case of BLISS, a special deployment procedure using the Ansible tool has been put in place in order to ease the work on beamlines.

Updating BLISS installation¶

To update BLISS on an ESRF installation:

release version (bliss)¶

For the “release” version in the bliss Conda environement, update the conda package:

conda update --channel esrf-bcu bliss

conda install bliss=X.Y.Z

development version (bliss_dev)¶

For the development version, i.e in the bliss_dev Conda environement:

update bliss repository:

cd local/bliss.git/
git checkout 1.10.x # or the version you want
git pull

install up-to-date dependencies:

conda install --file ./requirements.txt

Exit and re-enter into the conda environment to ensure using up-to-date modules.
Pip-install BLISS by creating a link in the conda environment directory pointing to the git repository:
```
pip install --no-deps -e .
```

Note

Make sure to keep the Conda channels up-to-date (using conda info) and correct, if needed:

conda config --env --set channel_priority false
conda config --env --add channels conda-forge
conda config --env --append channels defaults
conda config --env --append channels esrf-bcu
conda config --env --append channels tango-controls

NB:

add prepends
append moves to the bottom if already exists.

About BLISS version¶

At BLISS startup, its version is printed. This version’s format depend on the installation mode. If using a package-installed BLISS version, the package number is printed:

...
Welcome to BLISS version 1.1.0-359-gff1e64292 running on pcsht
Copyright (c) 2015-2022 Beamline Control Unit, ESRF
...

If using a git-installed BLISS, a cryptic git version number like 1.1.0-359-gff1e64292 is printed. the three fields correspond to:

1.1.0: last git tag number
359: number of git commits since last tag
gff1e64292: git hash: ff1e64292 (! without the g)

...
Welcome to BLISS version 1.1.0-359-gff1e64292 running on pcsht
Copyright (c) 2015-2022 Beamline Control Unit, ESRF
...

The version can also be printed with:

DEMO [1]: import bliss.release
DEMO [2]: bliss.release.version
 Out [2]: '1.1.0-359-gff1e64292'

Post-installation configuration¶

Instrument name¶

In order to properly fill information about the instrument on which data has been collected in future data files, do not forget to set the instrument field.

Format is free, but it is a good idea to put “ESRF-” followed by the beamline or endstation name. In capital letters.

Example, in file:__init__.yml located at beamline configuration root, add:

    ...
    instrument: ESRF-ID42A
    ...

ESRF data policy¶

The ESRF data policy needs to be configured.

Nexus writer¶

A TANGO server referred to as the Nexus writer needs to be configured and started.

Warning

There must be one Nexus writer device per BLISS session. Do not forget to add a device when a new BLISS session is created.