Download Instructions for HKL-2000

 

Current Versions:

Linux HKL2000_v715-Linux
MAC OS X HKL2000_v715-Mac

If you want to download an older version of HKL-2000, see the Older HKL-2000 Instructions.

Downloading and unpacking HKL-2000 executable files

Download the HKL-2000 program package from the ftp server hkl.hkl-xray.com. You may use a web browser by clicking the link below and logging in as user hkl2000ftp:

ftp://hkl2000ftp@hkl.hkl-xray.com

The password can be obtained through the automatic password system (established users only) or via e-mail support@hkl-xray.com.

After login you will see a list of directories for each version that contain the files:

Linux 32-bit:
> HKL2000_v###-Linux-i386.tar.gz
Linux 64-bit:
> HKL2000_v###-Linux-x86_64.tar.gz
Mac:
> HKL2000_v###-Mac.zip

Download by clicking on the package specific to your operating system.

You may also use terminal command "ftp" with the passive option:

ftp -p hkl.hkl-xray.com

To download the appropriate file use the get command:

> get HKL2000_v###-Linux-x86_64.tar.gz

After the file is downloaded, uncompress it by clicking on it, or by using the terminal command:

> tar -zxvf [filename].tar.gz or unzip [filename].zip for Mac

Installing HKL-2000

If necessary, move the unpacked directory to any selected directory, for example /usr/local.

To add HKL-2000 to the desktop use the command:

ln -s [installation directory]/bin/HKL2000 ~/Desktop/HKL2000

To run HKL-2000 from a terminal use the command:

[installation directory]/bin/HKL2000

Optionally, to add HKL-2000 to your PATH use the command (or add it to your login script):

source [installation directory]/hkl_setup.sh

For csh shell, edit hkl_setup.csh to point to the installation directory:

source [installation directory]/hkl_setup.csh

HKL-2000 also requires a directory hklint for site files. Its default location is /usr/local/hklint.
Accessing it requires system privileges, but it it can be changed to an arbitrary location, by setting the environmental variable HKLDIR. For example:

export HKLDIR=/home/joed/programs/hklint (for bash)
setenv HKLDIR /home/joed/programs/hklint (for cshell)

You can check how the environmental variables were set by typing the command:

env | grep HKL

To keep the values of the HKL environmental variables for subsequent logins, you should modify the configuration files for the shell you are using (~/.tcshrc, ~/.cshrc, or ~./bashrc).

The site file (def.site) of each detector/goniostat system (home or synchrotron) should be stored in its own sub-directory. Each such directory should be appropriately named to easily identify the specific facility and the detector.

Examples:

/usr/local/hklint/Raxis4-home
/usr/local/hklint/SPring8-BL23-Quantum4
/usr/local/hklint/BNL-X25-Quantum4

A Site file (def.site) for  synchrotron beamlines can be obtained from the beam line support staff.

Previous versions of HKL-2000 required defining HKLPATH environmental variable unless main programs (xdisp, denzo_3d and scalepack) were placed in /usr/local/bin directory.
Currently those programs are located in [installation directory]/bin directory and do not require HKLPATH to run.

HKLPATH should be unset if it points to an older version of HKL-2000. HKLPATH may still be used to define an alternate location for main programs.

License key

The license key file, cr_info, needs to be present in the /usr/local/lib directory in order for the HKL-2000 programs to run. One cr_info file may contain information about many computers and detectors. The program looks through the cr_info file for the right combination of fields that matches the given detector family and computer information. Other fields are ignored. For more details, please see Access Key.

Troubleshooting

If you receive an error message "no display name and no $DISPLAY environment variable", it means that the X windows system is not working or is not configured properly. On Mac OS X, you need to start the X11 application (from the Finder's Go menu, choose Applications, then choose Utilities and select X11). You should see the X11 icon in the dock, double click on it to open an xterm window and start HKL2000 from this window.