Installation

This page presents how to get going with the GEM Library. The easiest way to do so is by downloading the release package, as described in the first section below. It is also possible to install the library from the source code as described in the second section.

Installing a release

The release includes binaries for Matlab on Linux, Windows and MacOS, as well as for Octave 6 on Linux. After downloading the latest release of the library, uncompress it in a desired_folder. This created the folder desired_folder/gem.

Windows

Due to a forward-compatibility of the C++ standard and C runtime libraries being still in their infancy on the Windows platform, the pre-compiled binaries provided here may not work out of the box on newer Windows systems. If this is the case, a system-specific configuration step may be required to run the latest version of the library on Windows (at least until the situation with standard libraries stabilises and new compiler versions are supported by matlab).

For this, follow the following steps after downloading the latest release:

  1. Install Matlab’s MinGW add-on (called “MATLAB Support for MinGW-w64 C/C++ Compiler”)
  2. Go to the downloaded desired_folder folder and type make(1,0) to prepare the library
  3. If everything goes through, you should be ready to keep with the instructions below

Setting up the path

The only step required to start using the libraries is to include the subfolder desired_folder/gem/gem to the Matlab/Octave path. This is achieved by running the command

addpath('desired_folder/gem/gem')

Once this is done, check out the tutorial to see how to perform your first high precision computation with the GEM Library.

Installing from source

Alternatively, installing the GEM Library from source can be useful for development purpose. For this:

  • Clone the library from GitHub using the command:
git clone --recursive https://www.github.com/gem-library/gem

This creates a folder gem with most of the necessary code (including Eigen, Spectra, MOxUnit and MOcov). To compile the library, follow the detailed instructions. Once the library is compiled, proceed with the following steps.

Setting up the path

To use the GEM Library, the gem/gem subfolder must be added in Matlab/Octave. This can be done through the command addpath as described above.

Testing

The proper working of the GEM Library can be checked by running the test command:

run_tests

This runs checks on all features of the library.

Compiling the documentation

The documentation can be compiled with the command

compile_doc

Running the documentation locally

The documentation website can be run on a local machine thanks to Jekyll. For this, install jekyll and bundle as explained on the Jekyll website. Then run

bundle exec jekyll serve

from within the docs subfolder. This command should provide you a local IP address on which you can consult the website.