The SBND Guide to using LArSoft

Contents

The SBND Guide to using LArSoft

DISCLAIMER: There is a lot of material that constantly befalls out of date. Remember that problems that are unknown don't fix by themselves: got a problem? write an e-mail and open a ticket here (you need to be logged in to Redmine).

The following is a quick guide (based largely on MicroBooNE experience) to the things you need to do in order to run and develop applications in LArSoft. The following assumes:

  • You have all your computing privileges and accounts, including an account on the SBND GPVM nodes. If you don’t, then you need to submit a Fermilab Service Desk ticket requesting access to this node. We will approve as soon as possible.
  • You are working on one of the SBND GPVM nodes. Many of these should work on other machines/sites as well, if they are configured in the standard way, but there are no guarantees for that. Talk to your system/local administrator if you’re having trouble, to make sure there’s no differences in the basic setup. Running on your local desktop or laptop is often possible too, but it should be a second step.
  • You have a working knowledge of UNIX.
  • You are using the bash shell (zsh is not well supported to date^[1].

Brief LArSoft overview.

LArSoft is the software framework used by a number of LArTPC experiments for simulation and reconstruction.
It is currently divided into multiple git repositories which contain parts of the whole toolkit. Building the code across the repositories is managed by MRB (Multi Repository Build).

For now, it is highly recommended that you read up on the above, before we compile our own set of experiences.
Hence, helpful reading material:

LArSoft wiki: https://cdcvs.fnal.gov/redmine/projects/larsoft/wiki
LArSoft quick start part: https://cdcvs.fnal.gov/redmine/projects/larsoft/wiki/_Quick-start_guide_to_using_and_developing_LArSoft_code_
MRB reference guide: https://cdcvs.fnal.gov/redmine/projects/mrb/wiki/MrbRefereceGuide

If you are new to LArsoft you might find the Newbie Material page useful as well.

List of SBND code releases

Useful Examples

The links below haven't been updated yet:

^1^ Whenever in Redmine wiki you see the claim "to date", you can verify when that claim was written by exploring the History of that page, via the link on the top right of the page itself.