Difference: AMC13CppSoftwareBuildNotes (1 vs. 26)

• • NOTE that the uHTR code is in the hcalUHTR package (e.g. if you wanted both the hcalUpgrade, hcalUHTR, and hcalBase packages the option would look like: --packages=hcalUpgrade,hcalUHTR,hcalBase)

1. Build the code in exactly the following order (NOTE: version 11.12.0 and on, the ipbus dependency is remove and you should skip this step):

1. Continue building the code in exactly the following order:

1. Lastly, it is a good idea to contact the release managers (currently Jeremy Mans <Jeremy.Mans@cern.ch> and Chris West <christopher.alan.west@cern.ch>) to inform them that a new version should be used in the next software release

1. After the code is done building, link the amc13 library path

      export LD_LIBRARY_PATH=${HOME}/src/11_8_1/hcal/hcalUpgrade/amc13/lib/linux/x86_64_slc5/:${LD_LIBRARY_PATH} 
      

2. You have finished! You are now ready to run the AMC13Tool executable and edit your private development area!

   $ ./prepReleases.sh ~/src/11_8_1/hcal/hcalUpgrade/amc13/amc13Standalone/
   

1. If you are maintaining the AMC13Tool Standalone, now is the time to sync the standalone to the current version. (If not, skip to next step)

      $cd ~/src/11_8_1/hcal/hcalUpgrade/amc13/amc13Standalone/
      ./syncAMC13Standalone.sh
      

1. If you are maintaining the AMC13Tool Standalone, now you can prep the release and post the compressed files. (If not, skip to the last step).
   • NOTE: You should have a directory for your AMC13 Standalone Releases which contains prepReleases.sh . If you do not, please make one now.
   • Navigate to you AMC13 Standalone Releases directory and run prepReleases.sh
   • Host both the RPM and MAN versions of the release in a publicly accessible location and post links appropriately to AMC13CppSoftware

1. NOTE: This is wrong. It appears that if you simply omit the "--svnuser" argument that it will check out anonymously, but I have no way to check this right how.

• • NOTE that the uHTR code is in the hcalUHTR package (e.g. if you wanted both the hcalUpgrade and hcalUHTR packages the option would look like: --packages=hcalUpgrade,hcalUHTR)

• • NOTE that you can put the code into any directory you like; it doesn't have to be ${HOME}/src/11_8_1.

1. Run the script "hcostag" to tag your code in the hcalUpgrade package directory. This script will determine the appropriate tag name and take the necessary SVN actions.

• • NOTE that the uHTR code is in the hcalUHTR package

1. Log in as daqowner:

1. ) 11.8.1

NOTE!!! These examples show how to install release 11_8_1, but the process can be generalized to any xDAQ release xx_x_x.

1. If you are going to be a regular developer, it is a good idea to establish a Kebros SSH ticket (at Jeremy's strong recommendation) as discussed here. If I may quite Jeremy: "This will make your life much_better."

1. Copy the installation script to your login directory (or whatever directory you want to keep your installation scripts):

1. If you want to check the xDAQ code out of SVN anonymously (i.e. if you do not have an afs ID or don't care to have access to the repository), edit the script, search for "anonymous", and remove the # comment mark. Otherwise, if you have an afs ID and want access to the repository, skip this step.

• • NOTE that you can put the code into any directory you like; it doesn't have to be ${HOME}/src/11_7_7.
  • NOTE that you can also install additional packages, if you wish; you're not limited to the hcalUpgrade. However, ALL of the AMC13 code lies within the hcalUpgrade package!! If packages is not specified, then all packages are installed by default.
  • NOTE that if you removed the "anonymous" comment mark in the previous step, you do not need the svnuser argument.

1. If you provided your "svnuser" afs ID (and therefore have access to the repository), update the software to the latest code in SVN (in case changes have been checked in by other parties since this release):

1. After the code is done building, you have finished! You are now ready to run the AMC13Tool executable and edit your private development area!

Check edited code back into SVN

Subversion Manual

this site

IMPORTANT!!! It is imperative that you make sure your edited code compiles and runs without breaking before checking changes into SVN. the HCAL Upgrade does not want to release busted software!

1. Go to the hcal/hcalUpgrade level of the release directory and svn update:

      $ cd ~/src/11_8_1/hcal/hcalUpgrade
      $svn update
      

   This makes sure that your code is up to date with all "outside" changes since the release and that your edits do not conflict with others'.
2. In the hcal/hcalUpgrade directory, run an svn status command to make to see what you've changed and to make sure everything is ready for a commit.

      $ cd ~/src/11_8_1/hcal/hcalUpgrade
      $ svn status
      

3. Be sure that your code compiles and runs properly. Only after you are confident of your changes being effective and accurate should you proceed.
4. Update the package's hcal/hcalUpgrade/include/hcal/upgrade/version.h file to give the code a new version number. Generally, very small bug fixes would result in the PATCH digit changing, while larger changes would be MINOR. MAJOR version changes should mostly be for backward-incompatible changes. When you increment MINOR, you should set PATCH back to zero, and when you increment MAJOR, MINOR and PATCH should go to zero.
5. In the same way as the previous step, update the version number in the file hcal/hcalUpgrade/amc13/include/hcal/amc13/version.h.
6. Commit your code into the SVN repository, giving a useful commit message which states your changes to the AMC13 code.

      $cd ~/src/11_8_1/hcal/hcalUpgrade/
      $ svn commit -m <commit_message>
      

7. Run the script "hcostag" to tag your code. This script will determine the appropriate tag name and take the necessary SVN actions.

      $ cd ~/src/11_8_1/hcal/config/build/
      $ ./hcostag
      

8. Lastly, it is a good idea to contact the release managers (currently Jeremy Mans <Jeremy.Mans@cern.ch> and Shih-Chuan Kao <Shih-Chuan.Kao@cern.ch>) to inform them that a new version should be used in the next software release

Subscribe to HCAL Online Software HyperNews

1. Go the HyperNews webpage and log in with your afs credentials
2. Click on the Subscribe to Forums link at the top of the screen
3. Under the Category: Detector Subsystems section, select HCAL Online Software Development
4. While you're here, other useful forums to check include HCAL Electronics, HCAL Discussions, and SLHC HCAL Upgrade

Install a Release as daqowner

1. Log in as daqowner:

      ssh daqowner@cms2.bu.edu
      

2. Get the installation script from the cmshcalweb database:

      wget http://cmshcalweb01.cern.ch/hcalsw/release/installDAQ_11_7_7.perl
      

3. Run the installation script:

      perl installDAQ_11_7_7.perl --mode=teststand
      

4. Once the installation script has finished, pick the correct release:

   ~daqowner/common/bin/pickRelease.sh
   Available installed releases
      1 )   11.0.7
      2 )   11.2.3
      3 )   11.3.1
      4 )   11.4.0
      5 )   11.4.2
      6 )   11.4.3
      7 )   11.5.0
      8 )   11.5.1
      9 )   11.5.2
      10 )   11.5.3
      11 )   11.5.5
      12 )   11.5.6
      13 )   11.6.0
      14 )   11.6.2
      15 )   11.6.3
      16 )   11.6.4
      17 )   11.6.5
      18 )   11.7.0
      19 )   11.7.1
      20 )   11.7.2
      21 )   11.7.3
      22 )   11.7.7
   Pick release to use:   22
      

1. Set the environment for this release:

   ~daqowner/dist/etc/env/env.sh
      

   or, if you are using the tc-shell:

   ~daqowner/dist/etc/env/env.csh
      

Install a release in your own source tree

1. First, ensure that the release you want to work with is the current one, as such:

      ls -l /home/daqowner/dist
      lrwxrwxrwx 1 daqowner daq 25 Jan  5 09:56 /home/daqowner/dist -> /home/daqowner/daq.11.7.7
      

   If the release is not the one you want, use pickRelease.sh (instructions shown above) or install the desired release.
2. Copy the installation script to your login directory:

      cp ~daqowner/installDAQ_11_7_7.perl ${HOME}/
      

3. If you want to check the xDAQ code out of CVS anonymously (ie if you do not have an afs ID or don't care to have access to the repository), edit the script, search for "anonymous", and remove the # comment mark. Otherwise, if you have an afs ID and want access to the repository, skip this step.
4. Run the installation script, ownsourcing the code to your ${HOME}/src directory:

      perl ~/installDAQ_11_7_7.perl --mode-teststand --ownsource=${HOME}/src/11_7_7 --packages=hcalUpgrade cvsuser=[afsID]
      

   NOTE that you can put the code into any directory you like; it doesn't have to be ${HOME}/src/11_7_7. NOTE that you can also install additional packages, if you wish; you're not limited to the hcalUpgrade. However, ALL of the AMC13 code lies within the hcalUpgrade package!! If packages is not specified, then all packages are installed by default. NOTE that if you removed the "anonymous" comment mark in the previous step, you do not need the cvsuser argument.
5. Set the environment for your new ownsource code development area:

      source /home/daqowner/dist/etc/env.sh
      export LD_LIBRARY_PATH=${HOME}/src/11_7_7/hcal/hcalUpgrade/amc13/lib/linux/x86_64_slc5/:${LD_LIBRARY_PATH} 
      

6. If you provided your "cvsuser" afs ID (and therefore have access to the repository), update the software to the latest code in CVS (in case changes have been checked in by other parties since this release):

      cd ~/src/11_7_7/hcal/hcalUpgrade/
      cvs update
      

7. Build the code in exactly the following order:

      cd ~/src/11_7_7/hcal/hcalUpgrade/ipbus/

1. After the code is done building, you have finished! You are now ready to run the AMC13Tool executable!

  ls -l /home/daqowner/dist
  lrwxrwxrwx 1 daqowner daq 25 Sep  5 09:56 /home/daqowner/dist -> /home/daqowner/daq.11.5.2

If the release is not correct, install as necessary per instructions below, or just run pickRelease.sh to set it.

Follow instructions from Jeremy (substitute current release number)

To install on a teststand (as daqowner) :
       wget http://cmshcalweb01.cern.ch/hcalsw/release/installDAQ_11_5_2.perl
       perl installDAQ_11_5_2.perl --mode=teststand
       ~daqowner/common/bin/pickRelease.sh (choose 11.5.2)

You can make a code-development area on a teststand or USC using:
       perl installDAQ_11_5_2.perl --mode=[teststand|usc] \
      --ownsource=${HOME}/src/11_5_2 --packages=hcalUpgrade --cvsuser=[your afs id]

If you want to use anonymous CVS (not password prompts), edit the script, search for "anonymous" and remove the comment mark.

After the correct release is installed and made current (/home/daqowner/dist symlink) and you have the correct source tree installed using --ownsource, proceed:

Find the current release script, usually in ~daqowner, named installDAQ_xx_xx_x.perl. Copy to your home directory.

If you want to use anonymous CVS (not password prompts), edit the script, search for "anonymous" and remove the comment mark

source source ~daqowner/dist/etc/env.sh = or =source source ~daqowner/dist/etc/env.csh

perl ~/installDAQ_11_3_1.perl --mode=teststand --ownsource=${HOME}/src/11_3_1 --packages=hcalUpgrade

cd src/xx_xx_xx/hcal/hcalUpgrade/
cvs update -A -d       (optional, if you want CVS code updated since the release)
cd ipbus
make
cd ..
cd amc13
make
source environ.sh     (maybe only needed for python)

To run the command-line tool:

bin/linux/x86_64_slc5/AMC13Tool.exe

To make changes in the code (your private copy):

cd src/common

edit files as desired. Go back up to .../amc13 and Make to re-compile.

-- EricHazen - 13 Apr 2012