Julia interface for the Geometry + Simulation modules (G+Smo)

Gismo.jl: Geometry + Simulation Modules meet Julia

The Gismo.jl package provides an interface to the Geometry + Simulation Modules inside Julia.

Getting started

We provide a hand full of examples in the examples directory, which can be run after installation of the package.

Installation

There are two ways to install Gismo.jl: via Julia's package manager, or by linking it to a local build of G+Smo.

Via Pkg

The Gismo.jl package can be directly downloaded from Julia's package management system Pkg using

] add Gismo

This command fetches the dependency gismo_jll contaning pre-compiled library files, and it fetches the current repository which calls gismo_jll.

Enabling Gismo.jl locally

Alternatively, one can use a local build of G+Smo as a back-end for the Julia bindings. This requires the gsCInterface module to be compiled, and the Gismo.jl package to be fetched as a submodule in G+Smo.

a. Fetching and compiling the required G+Smo submodules

Enable the gsCInterface and the Gismo.jl modules inside G+Smo

cd path/to/gismo/build
cmake . -DGISMO_OPTIONAL="<OTHER OPTIONAL MODULES>;gsCInterface;Gismo.jl" \
        -DGISMO_JL_DEVELOP=ON

And compile everything

make gismo

b. Link libgismo to Gismo.jl

In the file Gismo.jl/src/Gismo.jl, the shared library should be included as follows:

libgismo = "path/to/gismo/build/lib/libgismo"

c. Install Gismo.jl in Julia

Add the local package Gismo.jl to Julia's development packages

cd path/to/gismo/
cd optional
julia -e 'using Pkg; Pkg.develop(path="Gismo.jl")'

Structure of the package

The package is structured according to the src/ folder in gismo's C++ library. That is, for every directory dir in src/dir, Gismo.jl/src contains a jl file.