Software prerequisites

The following software packages are required for building HALMD. For an automated installation procedure, refer to the next section, Automatic installation. A detailed step-by-step guide for manual installation is given in section Manual installation.

  • NVIDIA CUDA toolkit ≥ 4.1

    Warning

    CUDA driver ≤ 4.1 has a known security vulnerability (CVE-2012-0946). For this reason, we recommend CUDA 4.2 or later.

    Please refer to the installation instructions shipped with the toolkit.

  • CMake ≥ 2.8.8 with a patch for native CUDA support

    The build process of HALMD depends on CMake, a cross-platform, open-source build system.

    Note

    The CMake-CUDA patch adds native CUDA source file compilation and linking support to CMake and is not to be confused nor compatible with the CUDA module in CMake 2.8.

  • Git ≥ 1.5.6.2

    The source code of HALMD is managed by Git, a fast and efficient, distributed version control system. Git is available for many operating systems and their flavours.

  • Boost C++ Libraries ≥ 1.49.0

    The C++ part of HALMD uses of libraries in the Boost C++ collection.

  • Lua interpreter ≥ 5.1

    Note

    We recommend Lua 5.2 or later.

    A simulation with HALMD is setup and configured by means of the Lua scripting language. The fast and lightweight Lua interpreter is embedded in the HALMD executable.

  • HDF5 C++ Library >= 1.8

    “HDF5 is a data model, library, and file format for storing and managing data. It supports an unlimited variety of datatypes, and is designed for flexible and efficient I/O and for high volume and complex data.”

To optionally generate documentation in HTML and PDF format:

  • Sphinx documentation generator ≥ 0.6.1

    “Sphinx is a tool that makes it easy to create intelligent and beautiful documentation.”

  • LaTeX including pdflatex and dvipng

  • graphviz