Install the GeoModel Applications and Development kits¶

In this section, you will find instructions on how to install the latest stable version of GeoModel applications and development kits on different platforms. If you are a developer and would like to install the GeoModel toolkit from source, please refer to the Developers installation instructions.

The GeoModel applications include:

• gmex, the geometry explorer, an interactive 3d geometry visualizer
• gmstatistics, tool to monitor the memory consumption
• fullsimlight, a command-line tool to run Geant4 simulation, and its graphical user interface, fsl.
• gmclash, a Geant4 based command-line tool to perform clash detection
• gmgeantino, a Geant4 based command-line tool to generate geantino maps
• gmmasscalc, a Geant4 based command-line tool to compute the mass of a given piece of detector geometry
• gm2gdml and gdml2gm, command line tools to convert GeoModel to and from GDML
• gmcat, a command line tool to assemble geometry from multiple inputs

The development kits include header files and precompiled libraries for the development of detector description code. On some platforms (macOS) the development environment is installed together with the prebuild applications and libraries.

How to install GeoModel on Ubuntu¶

The following instructions have been tested for Ubuntu 20.0.4 (focal, LTS) or 21.0.10 (impish) or 22.0.4 (jammy, LTS). Add the geomodel repository to your source list:

sudo add-apt-repository ppa:kaktusjoe/geomodel
sudo apt-get update

Install geomodel precompiled applications

sudo apt install geomodel-visualization  # to get gmex (the geometry explorer)
sudo apt install fullsimlight            # to get fullsimlight, gm2gdml, gmclash, gmgeantino
sudo apt install geomodel-tools          # to get gmcat, gdml2gm

Install the geomodel development kits (header files and precompiled libraries)

sudo apt install geomodel-core-dev
sudo apt install geomodel-tools-dev
sudo apt install geomodel-g4-dev
sudo apt install geomodel-visualization-dev

If you have outdated packages, these commands will replace those packages with the most recent version.

How to install GeoModel on macOS¶

On macOS, we use the Homebrew package manager to handle and install the GeoModel packages. If you don’t have Homebrew installed on your machine, you should first install it by following the instructions on the Homebrew website: http://brew.sh. Please be attentive to any instructions printed after the installation procedure; there might be environment variables to set.

export DYLD_LIBRARY_PATH=/usr/local/lib:/opt/homebrew/lib

First installation¶

Add the GeoModel tap¶

If this is the first time you install the pre-compiled GeoModel packages through the Homebrew package manager, then first you have to add the dedicated GeoModel Homebrew repository to your local repositories’ list. To do so, you can type:

brew tap atlas/geomodel https://gitlab.cern.ch/GeoModelDev/packaging/homebrew-geomodel.git 
brew update 

The first command will add to your local repositories’ list the GeoModel Homebrew repository (a tap, in Homebrew jargon), which stores all the “recipes” (Formulae in Homebrew) to install the GeoModel libraries on macOS; this command is only needed the first time you install the atlas/geomodel tap. The second command makes sure that all latest versions are taken; this should be run all times you want to update or install a GeoModel package.

Install the GeoModel packages¶

After that, you can install the pre-compiled GeoModel applications:

brew install geomodel-visualization # to get gmex (the geometry explorer)
brew install geomodel-fsl           # to get fullsimlight, the FSL GUI, gm2gdml, gmclash, gmgeantino, gmmasscalc
brew install geomodel-tools         # to get gmcat, gdml2gm
brew install geomodel-extensions-atlas # to get the ATLAS extensions: the LAr custom shape and the MagneticField plugin for FullSimLight

All the above packages also automatically install the core package geomodel, which contains the core libraries and the I/O layer.

The geomodel-fsl package also installs the following packages:

• geomodel-fullsimlight, which contain the standalone Geant4 based application for GeoModel
• geomodel-geomodelg4, which contains the translation layer between GeoModel and Geant4

The geomodel-extensions-atlas package installs the ATLAS experiment’s extensions to be used in FSL/FullSimLight; namely, a custom shape for the LAr electromagnetic calorimeter and a plugin to define a custom magnetic field for the experiment. The package also downloads and installs the magnetic field datafile needed by the plugin. Thos extensions are semi-specific to the ATLAS experiment, but they can certainly be used as foundation and example to build other extensions for other experiments.

The use of pre-compiled packages (Bottles, in the Homebrew jargon) speeds up and simplify the installation on the user’s machine.

The pre-compiled bottles are provided for the latest macOS release, currently:

• 12 “Monterey” (Apple M1 chip and Intel chip)

For older macOS releases, Homebrew will try to compile the packages from source. If that fails, you will have to compile from source by yourself by following the instructions provided in the development section.

Update¶

Quick instructions¶

If your installation is outdated, you can update the GeoModel libraries and tools to the latest version simply by running the commands here below:

brew update
brew upgrade geomodel geomodel-geomodeltools geomodel-visualization geomodel-geomodelg4 geomodel-fullsimlight geomodel-fsl geomodel-extensions-atlas

Some more details¶

After the first command, brew update, you get a summary of the updated repositories and recipes. If there are new versions of the GeoModel tools and libraries, you should see something like the output messages here below:

➜  ~ brew update
Updated Homebrew from e13d04c1d to 784be839b.
Updated 5 taps (homebrew/core, homebrew/cask, homebrew/bundle, homebrew/services and atlas/geomodel).
...
==> Updated Formulae
...
atlas/geomodel/geomodel                     fbthrift                                    libvdpau                                    sdcc
atlas/geomodel/geomodel-fullsimlight        feroxbuster                                 lilv                                        serverless
atlas/geomodel/geomodel-geomodelg4          fheroes2                                    localstack                                  snakemake
atlas/geomodel/geomodel-tools               fizz                                        lua-language-server                         snort
atlas/geomodel/geomodel-visualization
...

You can now update the GeoModel recipes with brew upgrade ....

➜  ~ brew upgrade geomodel
Error: atlas/geomodel/geomodel not installed

Installation from source code.¶

On any other platform (such as Centos or Fedora), you can build GeoModel from sources, following these instructions

Visualize geometry data¶

After installing the tools, you can test your installation on an example ATLAS geometry file. Please note that in order to run GeoModel on the full ATLAS geometry you will need to install the geomodel-extensions-atlas package.

First, download the geometry data file:

On linux:

wget https://geomodel.web.cern.ch/examples/geometry_atlas.db 

On mac:

curl https://geomodel.web.cern.ch/examples/geometry_atlas.db -o geometry_atlas.db

Now, you can interactively visualizing the geometry data by running:

gmex geometry_atlas.db

Uninstall¶

If you want to uninstall GeoModel libraries and applications, you can follow the instructions below

macOS¶

If you installed GeoModel by using Homebrew as suggested above, you can easily uninstall all the GeoModel packages with a single brew command:

brew remove geomodel geomodel-tools geomodel-visualization geomodel-geomodelg4 geomodel-fullsimlight geomodel-thirdparty-simage geomodel-thirdparty-coin geomodel-thirdparty-soqt