Download Instructions for HKL-2000

 

Current Versions:

Linux HKL2000_v720-Linux
MAC OS X HKL2000_v720-Mac

If you want to download version 712 or older, please see the Older HKL-2000 Instructions.

Downloading and unpacking HKL-2000 executable files

You may download HKL-2000  by clicking the link below and signing in as user hkl2000ftp:

          https://hkl2000.hkl-xray.com 

The password can be obtained through the automatic password system (established users only) or by contacting HKL Research, Inc. via e-mail to support@hkl-xray.com.

After login you will see a list of directories for each of the last three releases, as well as archives and test directories. A directory for the release ###, ver### (ex. 721, 720), contains compressed installation files for Linux (32-bit and 64-bit) and Mac operating systems:

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 the package specific to your operating system. After the file is downloaded, unpack it by clicking, or by using the terminal command:

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

Installing HKL-2000

Move the unpacked installation directory to the desired location, for example, /usr/local.

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

[installation directory]/bin/HKL2000

For convenience, a symbolic link may be defined, e.g. :

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

It is often convenient to add HKL-2000 to the PATH environmental variable by running the command below (it can be also incorporated in the login script):  

source [installation directory]/hkl_setup.sh  (for Bourne-type shells, e.g. bash) source [installation directory]/hkl_setup.csh  (for C-type shells, e.g. csh, tcsh)

HKL-2000 also requires a directory hklint for site files. Its default location is /usr/local/hklint, but 
 it can be changed to an arbitrary directory by setting the environmental variable HKLDIR (requires administrative privileges). 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. It is good practice to appropriately name such directories in a way that allows to easily identify the specific facility and the detector, e.g:

/usr/local/hklint/APS-21-ID-D-Eiger9M
/usr/local/hklint/SPring8-BL26B1-RaxisV

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

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

Environmental variable 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, the X11 application should be running - in some cases, you may need to start the X11 application manually (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 HKL-2000 from this window.