PEPS Software

Software download

You need two steps to use the auger software:

1. Download and install the externals
2. Clone the auger offline repository, build and enjoy (test, modify, install, run)

Getting externals: ape

The PEPS enabled ape distribution is available form the Auger Ape Distribution page. To compile the externals, you have to make sure that your system has a number of packages installed. They are listed in the Manifest List for PEPS. The one-letter shorthand for key distributions are: a: Alma Linux, u: Ubuntu, d: Debian, r: Rocky Linux, f: Fedora.

You have to configure where you want to install the package to using typically ~/.aperc:

 [DEFAULT]
 base = %(home)s/auger/software/ApePeps
 build = /tmp/ape-lukas
 
 [ape]
 jobs = 32 # Number of cores on your machine
 mirrors = mx de

You can then run

 ./ape install externals

and go for a coffee (depends on your machine). To use the installed package, you have to set up the required environment variables using

 eval $(./ape sh externals)

Note: we currently cannot build the externals on MacOS, but this will be fixed soon (for some suitable definition of soon).

Getting offline from gitlab

The Auger Offline software is available from the offline project at the IAP-KIT gitlab server. You need

1. An account at https://gitlab.iap.kit.edu
2. Configure your account to have ssh keys for cloning. Provides a much more efficient workflow, using git over ssh and not https.

You then run

 git clone -b peps git@gitlab.iap.kit.edu:auger-observatory/offline/offline.git offline-peps

to clone the repository into the offline-peps' directory and switch to the peps' branch. This step takes some time due to the size of the repository.

Configure and build

The software is configured using, for example,

 cmake -S . -B ../offline-peps-build -GNinja -Dprefix=../offline-peps-install -DAUGER_TESTING_ENABLED=ON -DDBHOST=db.auger.unam.mx

The last three parameters are optional:

-GNinja

Use ninja to build. It is about 20% faster than make.

-DAUGER_TESTING_ENABLED=ON

Build unit tests

-DDBHOST=db.auger.unam.mx

Use the UNAM DB server for Auger.

You can now build using

 cmake --build ../offline-peps-build

and install

 cmake --build ../offline-peps-build -t install

You run the unit tests using

 ctest --test-dir ../offline-peps-build -j 32

Activate and use the offline software

You have to set up the environment for the offline software using

 eval $(../offline-peps-install/bin/auger-offline-config --env-sh)

You find validation test in the ValidationTests. We also have example applications and Tutorials:

 ➤ ls ../offline-peps-install/share/auger-offline/doc
 ADST  ExampleApplications  SampleShowers  StandardApplications  Tutorials  UserSkeleton

You are now ready to run any of the validations, standard applications, and examples.