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.

SLAC/LCLS

An installation of CrystFEL is maintained by us for the "old" psana system. Type one of the following to set up your environment:

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

Use the .sh version if your shell is sh, bash or zsh. Use the .csh version if you use tcsh. If you don't know, your shell is probably bash. Replace the version number (0.9.1) with any other version if you need to, or with "dev" to get the development version. If you use the development version, read /reg/g/cfel/crystfel/crystfel-dev/ChangeLog every now and again to see what's changed.

A separate installation on the Shared Scientific Data Facility (SDF) will be available shortly.

CFEL/DESY/European XFEL (Maxwell HPC system)

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

$ module load maxwell crystfel/0.9.1

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

$ module load maxwell crystfel/0-devel

These versions include Xgandalf, Pinkindexer, DirAx, MOSFLM and XDS (note that XDS is licensed for academic and non-commercial use only). They use HDF5 1.10 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, but see the note below.

An older version is provided by DESY IT under /opt/crystfel. You will get this version if you run "module load crystfel" without previous loading the "maxwell" module. This version uses HDF5 1.8, which does not support virtual data set (VDS) files. Mosflm, Xgandalf, asdf, TakeTwo and PinkIndexer are included for indexing, but not DirAx nor XDS.

An up-to-date development version is also maintained by us (the CrystFEL authors). This includes Mosflm, Xgandalf, asdf, TakeTwo and Pinkindexer, but not DirAx, XDS nor Felix. This version uses HDF5 1.10 and may be more up-to-date than the development version maintained by DESY IT.

$ export PATH=/gpfs/cfel/cxi/common/public/development/crystfel/bin:$PATH

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.