Installation


The source code of the OpenQBMM solver suite is made available to the public by means of a git repository hosted at GithHub. Users who want to use the OpenQBMM solvers directly may be interested in our live Linux distribution, which is available through SUSE Studio for installation on actual hardware or in virtual machines. Stable releases are also available as compressed archives.

Installing git

In order to retrieve the code from the git repository, a working git installation must be present on your computer. Depending on the operating system in use, the installation procedure for git may be different, as illustrated below.

Linux systems

Each Linux distribution provides a version of git in their package selection. The installation of git requires administrative rights on the system, and can be done using the following distributon-specific commands in a root terminal:

  • openSUSE and SUSE Linux Enterprise:
    • zypper in git-core
  • Fedora and Red Hat Enterprise Linux:
    • yum install git
  • Debian and Ubuntu Linux:
    • apt-get install git-core

Windows system

Windows users who may want to examine the OpenQBMM code may use one of the following graphical interfaces to connect to the OpenQBMM git repository:

Mac OS X systems

Mac OS X users who may want to examine the OpenQBMM code may use one of the following graphical interfaces to connect to the OpenQBMM git repository:

Downloading the source code of a stable release

The OpenQBMM source code of the stable release of OpenQBMM can be downloaded as follows:

  1. Create a directory called OpenQBMM
  2. Go to https://github.com/OpenQBMM/OpenQBMM/releases
  3. Select the stable release you desire. The current stable release is 2.0.0 for OpenFOAM 4.x.
  4. Download the tar.gz or .zip file corresponding to the version you want to install
  5. Extract the content of the compressed archive you downloaded in the OpenQBMM directory

Downloading the source code of the development branch

The development version of the OpenQBMM for OpenFOAM-dev source code can be downloaded with the following commands:

  1. Create a directory called OpenQBMM-dev
  2. Open a terminal in that directory
  3. Use the command
    • git clone https://github.com/OpenQBMM/OpenQBMM.git

Due to the frequent changes in both OpenQBMM and OpenFOAM-dev, no compressed archives are made available for the development version.

Building the code

Requirements

It is assumed that:

  • If you use the stable version of OpenQBMM, you will compile it against OpenFOAM 4.x. This is the version of OpenFOAM used for testing the current stable release.
  • If you use the development version of OpenQBMM, you will compile it against OpenFOAM-dev from the OpenFOAM Foundation. While this is a development version of OpenFOAM, we use it for all the new developments we make in OpenQBMM to ensure a smoother transition to new releases, and take advantage of the latest improvements and bug-fixes, and it can easily updated using git. Instructions on how to install OpenFOAM-dev are reported here.

Important note – Read before building the code

We track the number of times our code is built using a curl instruction to a specific URL in the main Allwmake script used to build the code. We perform this operation by invoking the curl command on a bitly URL.

The information collected in this way consists of the total number of times the URL was used, and the country of origin of the curl instruction. This information is used as a metric to know how many times our code is built for our reporting activity, as part of the metrics we adopted to establish the success of our project. We hope this is not considered an intrusive way to count the number of builds of our code, however, if you prefer your build not to be counted, please do the following:

  1. Open the Allwmake file in the top directory of the OpenQBMM code
  2. Comment out (add a # in front of) the curl command at the end of the script

Build instructions for OpenQBMM

The build process of OpenQBMM relies on the OpenFOAM build system. We assume OpenFOAM is installed and working properly on your system. If OpenFOAM is not installed on your system, please refer to the OpenFOAM documentation to install it properly.

The procedure to build the OpenQBMM solvers is the following:

  1. Open a terminal in the OpenQBMM directory (or OpenQBMM-dev for the development release)
  2. Execute: ./Allwmake

If the build is successful, no error messages will be shown, and the OpenQBMM solvers will be ready to use.