Difference between revisions of "Code"

From Mu2eWiki
Jump to navigation Jump to search
Line 47: Line 47:
 
* [[Git|git]] - code repository management
 
* [[Git|git]] - code repository management
 
* [[scons]] - primary code build tool
 
* [[scons]] - primary code build tool
 +
* [[Muse]] - Mu2e multi-repo build system
 
* [[LinkLists|Link Lists]]
 
* [[LinkLists|Link Lists]]
 
* [http://cdcvs.fnal.gov/lxr/mu2eofflinesoftware/index.html LXR] - cross-linked code browser
 
* [http://cdcvs.fnal.gov/lxr/mu2eofflinesoftware/index.html LXR] - cross-linked code browser

Revision as of 18:35, 5 March 2021

Building code

Consult the OfflineStatus page to learn which branch or tag of Mu2e Offline you should start from.

  • Basic recipe for creating a satellite release based on 'Mu2e_release' installed in cvmfs
source /cvmfs/fermilab.opensciencegrid.org/products/common/etc/setups
setup mu2e
/cvmfs/mu2e.opensciencegrid.org/Offline/'Mu2e_release'/SLF6/prof/Offline/bin/createSatelliteRelease
cd Satellite
source setup.sh
[add content]
scons -j 4 
  • Basic recipe for setup, full checkout and build (GitHub) (For more details see GitHubWorkflow). The following will produce a working directory that CANNOT be used to update the remote repository. It is useful only for running tests, not for developing code.
source /cvmfs/fermilab.opensciencegrid.org/products/common/etc/setups
setup mu2e
git clone git@github.com:Mu2e/Offline
cd Offline
git checkout -b work
source setup.sh
scons -j 4 
  • Basic recipe for setup, full checkout and build (Redmine)
source /cvmfs/fermilab.opensciencegrid.org/products/common/etc/setups
setup mu2e

- The following will produce a working directory that CANNOT be used to update the remote repository.  It is useful only for running tests, not for developing code. -
git clone http://cdcvs.fnal.gov/projects/mu2eofflinesoftwaremu2eoffline/Offline.git

- For a read-write working directory appropriate for developing code.-
git clone ssh://p-mu2eofflinesoftwaremu2eoffline@cdcvs.fnal.gov/cvs/projects/mu2eofflinesoftwaremu2eoffline/Offline.git

cd Offline
git checkout -b work
source setup.sh
scons -j 4 
  • for building options (debug,trigger,visualization) see ./buildopts --help


  • ReleaseList - notes on purpose for each published release
  • UPS - notes on using the UPS product setup
  • git - code repository management
  • scons - primary code build tool
  • Muse - Mu2e multi-repo build system
  • Link Lists
  • LXR - cross-linked code browser
  • pgit - git partial checkout for building only the part of the code base you need
  • Satellite Releases - for building only the part of the code base you need
  • Debugging
  • CVS - a few pieces of code are still in the CVS repository

Configuring executables

Modules, Products, and Services

Code Management

Standards and Practices

External Packages