Code

example page for git documentation

Building code

• Basic recipe for creating a satellite release

source /cvmfs/fermilab.opensciencegrid.org/products/common/etc/setups
setup mu2e
/cvmfs/mu2e.opensciencegrid.org/Offline/v6_0_0/SLF6/prof/Offline/bin/createSatelliteRelease
cd Satellite
source setup.sh
[add content]
scons -j 4 

• Basic recipe for setup, full checkout and build

source /cvmfs/fermilab.opensciencegrid.org/products/common/etc/setups
setup mu2e
git clone http://cdcvs.fnal.gov/projects/mu2eofflinesoftwaremu2eoffline/Offline.git
- or -
git clone ssh://p-mu2eofflinesoftwaremu2eoffline@cdcvs.fnal.gov/cvs/projects/mu2eofflinesoftwaremu2eoffline/Offline.git
cd Offline
git checkout -b work
[./buildopts --build=debug]
source setup.sh
scons -j 4 

• ReleaseList
• UPS
• git code repository management
• scons code building tool
• Satellite Releases for building only the part of the code base you need
• CVS - a few pieces of code are still in the CVS repository

Configuring executables

• fcl
  • Introduction
  • paths - which modules and what order
  • I/O modules
  • Message logger
• Search paths - how data, fcl, and other control files are found
• SimpleConfig - another way to input parameters to an executable
• Simulation
  • Introduction - an overview
  • Generators - generating the first particle
  • Staging - how and why of running the simulation in stages
  • Time simulation - adding lifetimes
  • Bunch intensity - simulating bunch-to-bunch variations
  • Mixing - mixing background and signal simulation
• Other applications
  • EventDisplays
  • Stntuple git url - one choice of user ntuple

Modules, Products, and Services

• Modules
  • Modules
  • I/O modules
  • Filter Modules
  • fcl validation
• Products
  • Reading products
  • Listing and printing
  • Making data products
  • Handles
  • PhysicalVolumeInfoCollection
  • Provenance
  • cet::map_vector
• Geometry
  • Units and Coordinate Systems
• Random numbers:
  • Basic Instructions
  • Complete Instructions
• Magnetic Field Maps
• Conditions Data
• Services
  • Framework services
• Exceptions
• SimpleConfig
• Message logger

Code Management

• ReleaseList
• git - overview and pointers to detailed and mu2e-specific instructions
• Validation - automatic and occasional procedures for validation
• Jenkins - a central build platform
  • Jenkins Nightly build results
• CVMFS
• Download - pull a local copy to remote institutions or laptops
• scisoft - server for product manifests
• BTrk - the KalMan fitter code is in this non-standard product
• CVS
• DAQ DAQ redmine

Standards and Practices

• CodingStandards - an overview of code issues
• Magic numbers - where to get value of pi, etc.
• Editors - tips on editors and policy of not using tab characters.
• CMS code references:
  • Home
  • Offline WorkBook
  • SW Guide
• FAQs
  • c++
  • linux
  • root

External Packages

• UPS (needs updating) manual
• Mu2e code LXR
• art doc redmine browser art-users product flags
• Paterno memory profiling instructions
• CMS Framework LXR
• root docs
• geant at Fermilab DOxygen(v9.4.p01) LXR
• G4Beamline Mu2e manual
• CLHEP CLHEP(v.2.2.0.4)
• HepPDT
• fhicl-cpp
• cetlib browser
• Message Facility browser
• cpp0x browser
• boost browser
• BTrk browser
• LXR browsers for many Fermilab projects
• scons
• MARS (password protected)