Get started


The OpenQBMM solver suite can be installed following two procedures, depending on the level of expertise of the user. New users unfamiliar with Linux, OpenFOAM® and the OpenQBMM solvers can rapidly gain access to the software by following the easy way approach, which relies on a pre-built Linux image. More experienced users, who enjoy having more control on their system and on the installation process can follow the hard way, which is also recommended to users who already have access to a Linux system with the required version of OpenFOAM® installed.

The easy way

Recommended use cases

This approach is recommended to:

  • new users, without experience with Linux and OpenFOAM
  • users who need to rapidly test the capabilities of the OpenQBMM solver suite
  • users who want to install the software in a virtual machine or on a removable hard-drive

Pre-requisites

  • For installation on a pen-drive or removable hard-drive
    • a pen-drive or hard-drive with at least 16GB of free space. Important: the content of the pen-drive will be erased during the installation procedure.
    • a computer with enough RAM to be able to run the operating system (2GB recommended).
    • a computer capable of performing running an operating system from a USB drive. Users may have to choose the appropriate option when the boot process starts by pressing a function key.
  • For installation in a virtual machine:
    • a properly configured installation of VirtualBox.
    • enough disk space to store the virtual hard-drive and the generated data (20GB recommended).
    • enough RAM to be able to run the virtual machine (2GB recommended).

Procedure

Detailed instructions on how to obtain the OpenQBMM live distribution can be found here.

Notes

While the OpenQBMM live distribution is regularly updated, it may not contain the latest changes made to the solver suite in the git repository. Generally, the code available in the live distribution corresponds to a milestone that is considered stable by the developers. If a more recent version is needed, users of the live distribution can obtain the latest source code as follows:

  • Move to the OpenQBMM directory
  • Type: git pull
  • Recompile the code with the command: ./Allwmake

The changes made to the system will be preserved if the live distribution is run from a writable medium, either physical or virtual.

The hard way

Recommended uses cases

  • Users with an existing and current OpenFOAM installation.
  • Experienced users.
  • Users who want to use the latest release of the OpenQBMM solver suite from the git repository.

Pre-requisites

  • A Linux system running the required version of OpenFOAM
  • git

Procedure

Detailed instructions on the installation procedure of the source code from the git repository are available here.