HKL-3000 Installation Instructions

These instructions are also available as a  PDF document.

The installation of the HKL-3000 software is now guided by the installation program. The HKL-3000 installer can be obtained from HKL Research, Inc. by clicking the link below and signing in as user hkl3000ftp:

          https://hkl3000.hkl-xray.com 

The password can be obtained via the Automatic Password System or by e-mail at support@hkl-xray.com (established users only).

The installer is provided as a compressed file, and the file name indicates for which system the installer will operate.  Currently, there are Two versions are currently available, and the installation process is essentially the same both.

  • HKL3000_v7##_installer-Linux-x86_64.tar.gz
  • HKL3000_v7##_installer-Mac.zip

You may download and unpack the installer anywhere on your system.  The installer will guide you through the installation process, including specifying where the program should be installed. You will need root permission to install HKL-3000 in the default location, but you can install HKL-3000 in any directory.

After downloading the appropriate file, uncompress the file using your preferred method.  For example, on most Linux systems you can use the graphical interface (right-click and select Extract Here) or the command line (tar zxfv HKL3000_installer_filename.tar.gz).

Extracting the compressed file will create a folder that contains the installer, README.txt, access_prod, and a folder named “setup_files”.  Access_prod is a program that gathers information necessary to obtain a license key for HKL.  If you need to obtain a license key, run access_prod and email the results to hkl@hkl-xray.com. A more detailed explanation is available on the HKL Research website (hkl-xray.com/license-key).

You can start the installer by double clicking the installer icon or by using the command line. If you plan to install the program in the standard location, you will need to start the program with sudo permissions (sudo ./HKL_installer). CCP4 and SHELX should be installed before starting HKL. The installer will first verify that your license key is valid. The traditional location of the license key file (cr_info) is /usr/local/lib. The text area at the bottom contains detailed information about your license.

The Installation Type buttons allow you to choose the HKL version you would like to install, provided you have the appropriate license.  HKL-3000sm is for small molecules. HKL-3000 extends the capabilities of HKL-2000, providing an interface for structure solution and refinement. HKL-3000 requires several external programs, as outlined in the README file.  Click “Continue” to view the version specific license.  You must accept the license to proceed.

The screen below will let you choose whether you want to create a new HKL installation or upgrade an existing installation. If you have selected HKL-3000sm or HKL-3000, a dialog box will appear requesting the location of the external programs used by HKL-3000.  The installer may be able to determine the location of some of them based on your environmental variables. If you still need to select some programs, the installer can search for the files for you. Use the “Select” button at the bottom of the dialog to select the parent directory that contains one or more of the necessary programs.  In the example shown below, all of the files not defined by system variable were found using the parent directory “/usr/local/xtalprogs”.

The next dialog allows you to specify the program location and the detector definition directory. The default locations are /usr/local/HKL and /usr/local/hklint.  You can change them if you want to use a different directory or you do not have write permission for these directories.  The default folder for HKL will include the version number. The following example uses non-standard locations that would not require root privileges.

The installer will then check if you have permission to write to these directories and run checks to verify that the external programs are correctly installed.  If everything looks good, click “Install” to finish the setup.

If you let the installer create an icon, you can now use it to launch HKL-3000.