Information


Documentation



Maintained installations at facilities

This page aims to be an up-to-date directory of how to get access to CrystFEL where it is installed at facilities. Many of these installations are manintained by the facility staff rather than the CrystFEL authors. Please get in touch if you have updates to any of the information here.

DESY and European XFEL (Maxwell HPC system)

Installations of the most recent few CrystFEL versions are maintained under /software/crystfel. To get access, load the "maxwell" module and then "crystfel/<version>". For example:

$ module load maxwell crystfel/0.10.1

A development version is available as crystfel/0-devel:

$ module load maxwell crystfel/0-devel

These versions include Xgandalf, Pinkindexer and MOSFLM. They use HDF5 1.12 and should therefore be compatible with European XFEL virtual dataset (VDS) files.

Simply running "module load maxwell crystfel" will give you the latest stable version.

The installations under /gpfs/cfel/group/cxi/common/public/development/crystfel and /opt/crystfel are deprecated and no longer updated. Use module load maxwell crystfel/0-devel instead.

SLAC/LCLS (Scientific Data Facility)

An installation of CrystFEL is available, maintained by us, on the Shared Scientific Data Facility (SDF). This version is updated automatically every night to the latest Git 'master' version. To set up your environment, simply do the following:

$ export PATH=/sdf/group/psdm/sw1/cfel/crystfel/devel/bin:$PATH

Note that the SDF system is still in a test phase, and the location of the CrystFEL installation may change.

SLAC/LCLS (LCLS psana system)

For CrystFEL version 0.10.1 and later, simply add one location to your path:

$ export PATH=/cds/sw/package/crystfel/crystfel-0.10.1/bin:$PATH

There is also a "development" version, updated nightly from the Git repository:

$ export PATH=/cds/sw/package/crystfel/crystfel-dev/bin:$PATH

For versions 0.9.1 and earlier, set up your environment using this command:

$ source /reg/g/cfel/crystfel/crystfel-0.9.1/setup-sh

Replace 0.9.1 with the specific version you want.

Diamond Light Source

CrystFEL is available via modules. To get the latest version, simply run:

$ module load crystfel

Older versions are available as well:

$ module avail crystfel
crystfel/0.10.0(default) crystfel/0.7.0           crystfel/0.9.0
crystfel/0.6.3           crystfel/0.8.0           crystfel/0.9.1

These installations include XGandalf and cbf2hdf5.

SACLA HPC system

CrystFEL is provided as part of the SACLA SFX data analysis environment maintained by Takanori Nakane:

$ source ~sacla_sfx_app/setup.sh

SBGrid Consortium laboratories

CrystFEL is installed and supported at SBGrid Consortium laboratories.

Paul Scherrer Institut (SwissFEL, SLS)

CrystFEL is included in the MX software environment. To get access:

$ source /etc/scripts/mx_fel.sh

There are also modules available for individual CrystFEL versions, for example:

$ module load crystfel/0.9.1
$ module load crystfel/0.9.1-pink

Brazilian Synchrotron Light Laboratory (LNLS/Sirius)

CrystFEL is available at the Manaća beamline. More details to be addd soon!