- Table of contents
- Developing With LArSoft
- Quick links for Developing with LArSoft
- Writing code
- Submitting for next release
Developing With LArSoft¶
Quick links for Developing with LArSoft¶
In order to submit changes to larsoft code, you need developer access to the redmine repositories. Please send email to email@example.com. Please let us know who you are and your institutional association.
To design LArSoft code, it's important to understand the core LArSoft suite and all the components used by it. Reference the items below when designing new software.
LArSoft architecture and design principles¶
LArSoft packages and repositories¶
- LArSoft repositories, packages and dependencies
- Geometry Package
- LArSoft art-independent code and repositories
The art framework¶
- art documentation on WordPress for general information
- art documentation in Redmine for code specific information
- art workbook for examples and tutorials
- Using art in LArSoft
gallery provides lightweight access to event data in art/ROOT files outside the art event processing framework executable. It is not an alternative framework; rather, it provides a library that can be used to write programs that need to read (but not write) art/ROOT files. Information is available at: http://art.fnal.gov/gallery/
These are package written and maintained by the general physics and computing communities for
|Package||Namespace||Short description||Location of headers|
||Extensions to base C++ that are part of the standard language|
|ROOT||See below||Data-analysis tools||
||Class Library for High-Energy Physics||
|Geant4||See below||Detector simulations||
||Neutrino Monte-Carlo Generator||
||General programming tools for C++||
|Message Facility wiki documentation||
||Service for console messages||
||Configuration language and parsing tools||
|nutools and LArSoft||
||Neutrino platform tools||
ROOT and Geant4 do not use namespaces. In general, ROOT classes begin with "T" (e.g., TTree, TH1) while Geant4 classes begin with "G4" (e.g., G4Track, G4Step). Exception: Some of the newer ROOT sub-packages have namespaces (such as
Some of these packages duplicate functionality; e.g., 4-vectors are implemented in both ROOT and CLHEP. Given a choice, use a package that's higher in the above tables over one that's lower; e.g., choose ROOT classes over their CLHEP equivalents.
Policy for including new packages in LArSoft¶
LArSoft's policy for including new external software packages in the LArSoft distribution:
- An experiment makes an official request via redmine.
- LArSoft verifies that it has permission to use the tool for research.
- LArSoft verifies that the package will be be used by more than one experiment. Note: if only one experiment intends to use the package, the SciSoft team can help, but the end product would reside in the experiment’s code, not in LArSoft.
- LArSoft has to be able to build the tool such that it has binary compatibility with other products which will be used at the same time. This means that any dependencies (e.g., python) must be the same as those used by the matching LArSoft distribution. In addition, if the product contains C++ or Fortran code, the product must be buildable with the same compiler used by the matching LArSoft release.
- If the package is built into LArSoft code, it must not have a license that affects the license of the LArSoft code. We must be able to distribute our LArSoft code without having to add their license to our code or change the way we distribute LArSoft code with it in there. For a package that isn’t linked into any part of the main LArSoft distribution, such as an analysis tool, LArSoft still needs to have permission to use the package for research, but isn’t worried about the licensing affecting LArSoft code.
Whether you are writing new code or modifying existing code, please follow the guidelines listed below. There are also development tools and techniques available that can make coding easier.
- Coding guidelines
- Code documentation requirements and guidelines
- Process for contributing code to LArSoft
- Guidelines on writing (and using) services in LArSoft (in general)
- Guidelines on writing (and using) algorithms in LArSoft (not specific to any algorithm)
- Guidelines on using the geometry
- Error handling policy
- some C++ suggestions
- Using git repositories
Multi-threading in LArSoft¶
- ... create and use associations
- ... use the new ROOT vectors and linear algebra classes in the code (GenVector, SMatrix)
Tools and techniques¶
Documenting and browsing code¶
- LArSoft Doxygen - comments in the code are incorporated into documentation using the Doxygen tool.
- LXR Cross Referencer - general purpose source code indexer and cross-referencer that provides web-based browsing of source code with links to the definition and usage of any identifier. Supports multiple languages. Includes LArSoft code. Note, pages may take several seconds to load.
Working with GitHub and contributing code via LArSoft pull requests¶
Start by reviewing the information on the overview page for using LArSoft with GitHub. Contact your experiment offline management to identify acting Level 2 managers. Send any comments to firstname.lastname@example.org, or via Redmine issues.
git and git flow¶NOTE: These are instructions for working with the legacy Redmine-based git repositories, and are recommended for experiments that continue to use Redmine for their experiment code. All LArSoft repositories have been moved to GitHub. Please refer to the instructions on the Working with GitHub page for current instructions on using GitHib and contributing code to LArSoft.
- git guidelines
- git flow quick start
- Git Tips and Tricks
(for the purposes of LArSoft development, please please ignore anything other than how to use various git commands to do specific tasks - and especially ignore the workflow advice)
- Debugging LArSoft with Allinea
- Debugging LArSoft with RogueWave TotalView. (TotalView is no longer being paid for. Please use Allinea above instead.)
- Debugging with gdb
Using the build system¶
- Look for experiment specific guides to using and developing LArSoft code
- Choose the correct release from the List of LArSoft Releases and Release Notes.
- What to do when there is a new release (a.k.a. update LArSoft version)
To get write access to the repositories, speak to the offline coordinator for your experiment. If you have a question, send email to email@example.com.
Understanding CMakeLists.txt and product_deps files¶
- Cetbuildtools cmake modules: such as
cet_add_compiler_flags. Used in
CMakeLists.txtfiles throughout LArSoft
- Art cmake modules: such as
simple_plugin. Used in
CMakeLists.txtfiles throughout LArSoft
- Defining products in the CET build environment: explains the
- Adding Product Dependencies: how to edit the
CMakeLists.txtfiles to add dependencies
- Various helpful tips for coding in the CET C++ environment: things you hope you never need to know
- Building your own code with cmake: pointer to a really simple example
- Using find_global_symbol.sh to find unresolved symbols: automatic library search for symbols
mrb (multi-repository build) tool¶
- mrb user guide
- mrb reference guide
- Documentation for buildtool
- mrb calls
cetbuildtoolsproduct) to perform the build.
- mrb calls
- Getting Started with UPS and About UPS
- About qualifiers: the things after "-q" in setup <prod> <ver> -q <qual>
- More Relocatable UPS Documentation
High-level description of testing is available at larsoft.org
LArSoft Continuous Integration (CI) system¶
Submitting for next release¶
After designing, coding, building and testing a piece of software, submit it to the LArSoft development branch so it is included in a new release.
- Getting new code into a LArSoft release (Procedures and policies for making changes to LArSoft releases)
Also look at Process for contributing code to LArSoft.