OfflineStatus

From Mu2eWiki
Jump to navigation Jump to search

Overview

This page describes the status of various branches and tags in the GitHub Mu2e Offline repository, as of January 12, 2020.

Active Branches

  • master
    • Development head in preparation for MDC2020
    • Cannot read most files written in MDC2018 format.
    • Some production .fcl files in JobConfig are out of date.
    • v08_04_00 is the latest stable tag in which JobConfig scripts are known to run correctly
  • MDC2018
    • Stable branch for reading files from MDC2018
    • Many algorithms are out of date compared to the head of master.
    • No further development is planned on this branch; we will accept bug fixes.
  • Mu2eII_SM21
    • Development work for the Mu2e II project to be presented at Snowmass 2021
    • See Sophie, Lisa and Yuri for additional details.

Tag conventions

Tags are used to capture the state of the repo, for published builds and documentation.

Tags use semantic versioning. A tag has the form: Lxx_yy_zz, where "L" represents one lower case letter, "xx", "yy" and "zz" are two digit numeric fields with leading zeros present.

The letter "L" has the meaning

  • v: offline use (simulation, analysis)
  • d: DAQ or online
  • s: snowmass or Mu2eII

The numbers have the meanings:

  • xx: major version number; incremented when there is a breaking change.
  • yy: minor version number; incremented when a new feature is added.
  • zz: patch number; incremented when a bug fix is made


Which Should I Use?

If you are starting a new development project, use the head of master and follow the instructions at GitHubWorkflow.

If you want to run a simulation campaign using the most recent stable release, start from the tag v08_04_00:

mu2einit
git clone git@github.com:Mu2e/Offline
cd Offline
git checkout -b <branch name> v08_04_00
source setup.sh
scons -j 8

If you want to develop code starting from v08_04_00 and plan to make pull request to put that code at the head of master, speak with Rob and Dave before you begin.

Inactive Branches

None at this time.

Older Stable Releases

As stable releases expire, we will move their information here.

Fixme

  1. How to embed a "last modified" time into the page? Maybe [1]