Code

Building code

• CodeEnvironment how to setup the linux environment
• GitIntro code management preliminaries for newcomers
• OfflineStatus which branch or tag of Mu2e Offline you should start from
• GitHubWorkflow - code repository checkout and commit procedures
• IncludeFiles - where to find include files
• Muse - Mu2e code setup and build scripts
• scons - internal commercial build tool, called by Muse
• Debugging code debugging tools and tips
• Mu2e github organization
• UPS - using the Fermilab UPS product setup
• Redmine - a few pieces of code are still in the redmine git repository
• CVS - a few pieces of code are still in the CVS repository

Configuring executables

• fcl - intro to fcl art job control language
  • 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 - an overview
  • SimulationFCL - fcl procedures for MDC2020 and later
  • Generators - generating the first particle
    • CORSIKA cosmic ray simulation
  • 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
  • RunNumbers - how run numbers ranges are used
• Other applications
  • EventDisplays
  • Ntuples - data access at the interactive level
  • Machine learning - neural networks

Modules, Products, and Services

• Modules
  • Modules
  • I/O modules
  • Filter Modules
• Products
  • Reading products
  • Listing and printing
  • Making data products
  • Handles
  • PhysicalVolumeInfoCollection
  • Provenance
  • cet::map_vector
  • Schema Evolution
• Geometry
  • Units and Coordinate Systems
• Alignment
• Random numbers:
  • Basic Instructions
  • Complete Instructions
• Magnetic Field Maps
• Conditions Data
  • CalibrationSets
• Services
  • Framework services
• SimpleConfig
• Exceptions
• Message logger
• PyWrap - wrap compiled c++ code so it can be used in python
• art error codes

Code Management

• Spack - setup and build tool to replace UPS and MRB
• MuseMaintenance - Muse procedures for experts
• ReleaseList
• git - overview and pointers to detailed and mu2e-specific instructions
• Validation - automatic and occasional procedures for validation
• Jenkins - a central build platform
• CVMFS - a virtual disk mount containing our code
• Docker a portable software container to hold and run our environment and software
• Download - pull a local copy to remote institutions or laptops
• scisoft - server for product manifests
• BTrk - (deprecated) the Kalman fitter code is in this non-standard product
• KinKal - a repo and UPS product containing the core track Kalman fit code
• CVS
• CodeDepencyGraph - how to make the code dependency graph
• DAQ DAQ redmine
• building root
• checkPrerequisites tool - check linux has rpms needed by art
• SconsUPS - how to build a new version of scons, packaged for UPS
• Pyana - setting up python analysis packages
• Github CI Maintenance - information about the CI repo, used by Jenkins for build tests

Standards and Practices

• CodingStandards - an overview of code issues
• CodeTools - code formatting and checking tools
• Magic numbers - where to get value of pi, etc.
• Editors - tips on editors and policy of not using tab characters.
• Debugging
• GeantTips
• ISO 8601 time format
• CMS code references:
  • Home
  • Offline WorkBook
  • SW Guide
• FAQs
  • c++
  • linux
  • root
  • move semantics and r-value references

External Packages

• UPS manual getting started
• Mu2e github redmine lab LXR Mu2e LXR LXR project
• art doc github redmine browser art-users product flags error codes
• gcc features development gcc library dependence
• recent art stakeholders meetings; older art stakeholders meetings
• artdaq wiki
• Paterno memory profiling instructions
• valgrind]
• MAP and DDT debuggers
• CMS Framework LXR
• CMS github PR more info
• root docs
• geant at Fermilab DOxygen(v9.4.p01) LXR
• G4Beamline Mu2e manual
• CLHEP CLHEP(v.2.2.0.4)
• HepPDT
• fhicl fhicl-cpp
• cetlib browser cetmodules
• Message Facility browser
• cpp0x browser
• boost browser
• BTrk browser
• LXR browsers for many Fermilab projects
• scons
• MARS (password protected)