Difference: AMC13CppSoftwareBuildNotes (1 vs. 26)

Revision 2601 Aug 2014 - DavidZou

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated. Here is a link to the HCAL online SVN: cmshcos.
Line: 112 to 112
 
  1. Continue building the code in exactly the following order:

Changed:
<
<
cd ../amc13
>
>
cd ~/src/11_8_1/hcal/hcalUpgrade/amc13
  make
Changed:
<
<
cd ../
>
>
cd ~/src/11_8_1/hcal/hcalUpgrade/
  make
  1. After the code is done building, link the amc13 library path

Revision 2516 Jun 2014 - DavidZou

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated. Here is a link to the HCAL online SVN: cmshcos.
Line: 94 to 94
 
    • NOTE that you can put the code into any directory you like; it doesn't have to be ${HOME}/src/11_8_1.
    • 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.
Changed:
<
<
    • 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 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)
 
    • NOTE that if you removed the "anonymous" comment mark in the previous step, you do not need the svnuser argument.
  1. Set the environment for your new ownsource code development area:

Revision 2421 May 2014 - DavidZou

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated. Here is a link to the HCAL online SVN: cmshcos.
Line: 105 to 105
  cd ~/src/11_8_1/hcal/hcalUpgrade/ svn update
Changed:
<
<
  1. Build the code in exactly the following order:
>
>
  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):
 
   cd ~/src/11_8_1/hcal/hcalUpgrade/ipbus/
   make
Added:
>
>
  1. Continue building the code in exactly the following order:

  cd ../amc13 make cd ../

Revision 2307 Apr 2014 - DavidZou

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated. Here is a link to the HCAL online SVN: cmshcos.
Line: 165 to 165
  $ ./prepReleases.sh ~/src/11_8_1/hcal/hcalUpgrade/amc13/amc13Standalone/
    • Host both the RPM and MAN versions of the release in a publicly accessible location and post links appropriately to AMC13CppSoftware
Changed:
<
<
  1. 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
>
>
  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
 

Subscribe to HCAL Online Software HyperNews

Revision 2206 Nov 2013 - DavidZou

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated. Here is a link to the HCAL online SVN: cmshcos.
Line: 99 to 99
 
  1. Set the environment for your new ownsource code development area:
       source /home/daqowner/dist/etc/env.sh
Deleted:
<
<
export LD_LIBRARY_PATH=${HOME}/src/11_8_1/hcal/hcalUpgrade/amc13/lib/linux/x86_64_slc5/:${LD_LIBRARY_PATH}
 
  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):

Line: 115 to 114
  cd ../ make
Changed:
<
<
  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!
>
>
  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!

  If you wish to edit the AMC13 code, you can make changes to the source code in ${HOME}/src/11_8_1/hcal/hcalUpgrade/amc13/src/common/ and then go back up to the /amc13 level to recompile using make.

Revision 2129 Oct 2013 - EricHazen

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
Changed:
<
<
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated.
>
>
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated. Here is a link to the HCAL online SVN: cmshcos.
  Though these processes are presented as specific to BU's machine, the steps can easily be generalized to any other SLC5 machine with a daqowner account and a xDAQ installation.

Revision 2009 Sep 2013 - DavidZou

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated.

Revision 1913 Aug 2013 - DavidZou

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated.
Line: 157 to 157
 
  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
Added:
>
>
   $ ./prepReleases.sh ~/src/11_8_1/hcal/hcalUpgrade/amc13/amc13Standalone/
   
 
    • Host both the RPM and MAN versions of the release in a publicly accessible location and post links appropriately to AMC13CppSoftware
  1. 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

Revision 1827 Jun 2013 - BenjaminBDickens

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated.
Line: 90 to 90
 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.
  1. Run the installation script, ownsourcing the code to your ${HOME}/src directory:

Changed:
<
<
perl ~/installDAQ_11_8_1.perl --mode=teststand --ownsource=${HOME}/src/11_8_1 --packages=hcalUpgrade svnuser=[afsID]
>
>
perl ~/installDAQ_11_8_1.perl --mode=teststand --ownsource=${HOME}/src/11_8_1 --packages=hcalUpgrade --svnuser=[afsID]
 
    • NOTE that you can put the code into any directory you like; it doesn't have to be ${HOME}/src/11_8_1.
    • 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.

Revision 1719 Jun 2013 - DavidZou

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated.
Line: 139 to 139
 
  1. Be sure that your code compiles and runs properly. Only after you are confident of your changes being effective and accurate should you proceed.
  2. 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.
  3. In the same way as the previous step, update the version number in the file hcal/hcalUpgrade/amc13/include/hcal/amc13/version.h.
Added:
>
>
  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. 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/
Line: 149 to 154
  $ cd ~/src/11_8_1/hcal/hcalUpgrade $ ../config/build/hcostag
Added:
>
>
  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. 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

Revision 1605 Jun 2013 - EricHazen

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated.
Line: 86 to 86
 
   cp ~daqowner/installDAQ_11_8_1.perl ${HOME}/
   
Changed:
<
<
  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.
>
>
  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.
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.
 
  1. Run the installation script, ownsourcing the code to your ${HOME}/src directory:
       perl ~/installDAQ_11_8_1.perl --mode=teststand --ownsource=${HOME}/src/11_8_1 --packages=hcalUpgrade svnuser=[afsID]

Revision 1505 Jun 2013 - DavidZou

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated.
Line: 93 to 93
 
    • NOTE that you can put the code into any directory you like; it doesn't have to be ${HOME}/src/11_8_1.
    • 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.
Changed:
<
<
    • NOTE that the uHTR code is in the hcalUHTR package
>
>
    • 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 if you removed the "anonymous" comment mark in the previous step, you do not need the svnuser argument.
  1. Set the environment for your new ownsource code development area:

Revision 1403 Jun 2013 - DavidZou

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated.
Line: 146 to 146
 
  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.
       $ cd ~/src/11_8_1/hcal/hcalUpgrade
Changed:
<
<
$ ../conf/build/hcostag
>
>
$ ../config/build/hcostag
 
  1. 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

Revision 1331 May 2013 - CharlieHill

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated.
Line: 91 to 91
 
   perl ~/installDAQ_11_8_1.perl --mode=teststand --ownsource=${HOME}/src/11_8_1 --packages=hcalUpgrade svnuser=[afsID]
   
Changed:
<
<
    • 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 put the code into any directory you like; it doesn't have to be ${HOME}/src/11_8_1.
 
    • 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 the uHTR code is in the hcalUHTR package
    • NOTE that if you removed the "anonymous" comment mark in the previous step, you do not need the svnuser argument.

Revision 1230 May 2013 - CharlieHill

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated.
Line: 143 to 143
  $cd ~/src/11_8_1/hcal/hcalUpgrade/ $ svn commit -m
Changed:
<
<
  1. Run the script "hcostag" to tag your code. This script will determine the appropriate tag name and take the necessary SVN actions.
>
>
  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.
 
Changed:
<
<
$ cd ~/src/11_8_1/hcal/config/build/ $ ./hcostag
>
>
$ cd ~/src/11_8_1/hcal/hcalUpgrade $ ../conf/build/hcostag
 
  1. 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

Revision 1114 May 2013 - CharlieHill

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated.
Line: 7 to 7
 NOTE!!! These examples show how to install release 11_8_1, but the process can be generalized to any xDAQ release xx_x_x.

Contents
Changed:
<
<
Install a Releast as daqowner
>
>
Install a Release as daqowner
 
Install a release in your own source tree
Check edited code back into SVN
Subscribe to HCAL Online Software HyperNews
Line: 89 to 89
 
  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.
  2. Run the installation script, ownsourcing the code to your ${HOME}/src directory:

Changed:
<
<
perl ~/installDAQ_11_8_1.perl --mode-teststand --ownsource=${HOME}/src/11_8_1 --packages=hcalUpgrade svnuser=[afsID]
>
>
perl ~/installDAQ_11_8_1.perl --mode=teststand --ownsource=${HOME}/src/11_8_1 --packages=hcalUpgrade svnuser=[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.
Added:
>
>
    • NOTE that the uHTR code is in the hcalUHTR package
 
    • NOTE that if you removed the "anonymous" comment mark in the previous step, you do not need the svnuser argument.
  1. Set the environment for your new ownsource code development area:
       source /home/daqowner/dist/etc/env.sh
Changed:
<
<
export LD_LIBRARY_PATH=${HOME}/src/11_7_7/hcal/hcalUpgrade/amc13/lib/linux/x86_64_slc5/:${LD_LIBRARY_PATH}
>
>
export LD_LIBRARY_PATH=${HOME}/src/11_8_1/hcal/hcalUpgrade/amc13/lib/linux/x86_64_slc5/:${LD_LIBRARY_PATH}
 
  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):

Changed:
<
<
cd ~/src/11_7_7/hcal/hcalUpgrade/
>
>
cd ~/src/11_8_1/hcal/hcalUpgrade/
  svn update
  1. Build the code in exactly the following order:

Changed:
<
<
cd ~/src/11_7_7/hcal/hcalUpgrade/ipbus/
>
>
cd ~/src/11_8_1/hcal/hcalUpgrade/ipbus/
  make cd ../amc13 make
Line: 115 to 116
 
  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!
Changed:
<
<
If you wish to edit the AMC13 code, you can make changes to the source code in ${HOME}/src/11_7_7/hcal/hcalUpgrade/amc13/src/common/ and then go back up to the /amc13 level to recompile using make.
>
>
If you wish to edit the AMC13 code, you can make changes to the source code in ${HOME}/src/11_8_1/hcal/hcalUpgrade/amc13/src/common/ and then go back up to the /amc13 level to recompile using make.
 

Check edited code back into SVN

If you have edited the AMC13 code and want to make the edits available to other developers (important for bug fixes!), you will need to check your changes back into SVN. If you are unfamiliar with SVN, it is a good idea to take a quick gander at the Subversion Manual before proceeding. For a more succinct look at the basic SVN commands, check out this site.
Changed:
<
<
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!
>
>
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:

Revision 1027 Mar 2013 - CharlieHill

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
Changed:
<
<
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project.
>
>
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project. NOTE that the code has been migrated to SVN (instead of CVS) as of 02/07/2013, hence these instructions have since then been updated.
 
Changed:
<
<
Though these processes are presented as specific to BU's machine, the steps can easily be generalized to any other SLC5 machine which has xDAQ installed.
>
>
Though these processes are presented as specific to BU's machine, the steps can easily be generalized to any other SLC5 machine with a daqowner account and a xDAQ installation.
 
Changed:
<
<
NOTE!!! These examples show how to install release 11_7_7, but the process can be generalized to any xDAQ release xx_x_x.
>
>
NOTE!!! These examples show how to install release 11_8_1, but the process can be generalized to any xDAQ release xx_x_x.

Contents
Install a Releast as daqowner
Install a release in your own source tree
Check edited code back into SVN
Subscribe to HCAL Online Software HyperNews
 

Install a Release as daqowner

Changed:
<
<
Before any other cms2 users can run the release software, it must be installed by daqowner@cms2.bu.edu:
>
>
Before any other cms2 users can run the release software, it must be installed by daqowner@cms2.bu.edu. Check to make sure the release isn't already installed before following this procedure!
 
Changed:
<
<
  1. Log in as daqowner:
>
>
  1. Log in as daqowner:
 
   ssh daqowner@cms2.bu.edu
   
  1. Get the installation script from the cmshcalweb database:

Changed:
<
<
wget http://cmshcalweb01.cern.ch/hcalsw/release/installDAQ_11_7_7.perl
>
>
wget http://cmshcalweb01.cern.ch/hcalsw/release/installDAQ_11_8_1.perl
 
  1. Run the installation script:

Changed:
<
<
perl installDAQ_11_7_7.perl --mode=teststand
>
>
perl installDAQ_11_8_1.perl --mode=teststand
 
  1. Once the installation script has finished, pick the correct release:

Line: 48 to 54
 
  1. ) 11.7.2
  2. ) 11.7.3
  3. ) 11.7.7
Changed:
<
<
Pick release to use: 22
>
>
  1. ) 11.8.1
Pick release to use: 23
 

  1. Set the environment for this release:
Line: 62 to 69
  You are now ready to run the executables! See the AMC13 Tool: Getting Started section to learn about the primary AMC13 executable.
Added:
>
>
 

Install a release in your own source tree

Changed:
<
<
If you want to edit the xDAQ code without interfering with others, then you will need to check out a copy of the release into your own source tree. From there you can check any changes back into CVS.
>
>
If you want to edit the xDAQ code without interfering with others, then you will need to check out a copy of the release into your own source tree. From there you can check any changes back into CVS.

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

 
Added:
>
>
  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. First, ensure that the release you want to work with is the current one, as such:
       ls -l /home/daqowner/dist
Changed:
<
<
lrwxrwxrwx 1 daqowner daq 25 Jan 5 09:56 /home/daqowner/dist -> /home/daqowner/daq.11.7.7
>
>
lrwxrwxrwx 1 daqowner daq 25 Jan 5 09:56 /home/daqowner/dist -> /home/daqowner/daq.11.8.1
  If the release is not the one you want, use pickRelease.sh (instructions shown above) or install the desired release.
Changed:
<
<
  1. Copy the installation script to your login directory:
>
>
  1. Copy the installation script to your login directory (or whatever directory you want to keep your installation scripts):
 
Changed:
<
<
cp ~daqowner/installDAQ_11_7_7.perl ${HOME}/
>
>
cp ~daqowner/installDAQ_11_8_1.perl ${HOME}/
 
Changed:
<
<
  1. 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.
>
>
  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.
 
  1. Run the installation script, ownsourcing the code to your ${HOME}/src directory:

Changed:
<
<
perl ~/installDAQ_11_7_7.perl --mode-teststand --ownsource=${HOME}/src/11_7_7 --packages=hcalUpgrade cvsuser=[afsID]
>
>
perl ~/installDAQ_11_8_1.perl --mode-teststand --ownsource=${HOME}/src/11_8_1 --packages=hcalUpgrade svnuser=[afsID]
 
Changed:
<
<
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.
>
>
    • 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. 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} 
       
Changed:
<
<
  1. 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):
>
>
  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):
 
   cd ~/src/11_7_7/hcal/hcalUpgrade/
Changed:
<
<
cvs update
>
>
svn update
 
  1. Build the code in exactly the following order:

Line: 102 to 113
  cd ../ make
Changed:
<
<
  1. After the code is done building, you have finished! You are now ready to run the AMC13Tool executable!
>
>
  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!
  If you wish to edit the AMC13 code, you can make changes to the source code in ${HOME}/src/11_7_7/hcal/hcalUpgrade/amc13/src/common/ and then go back up to the /amc13 level to recompile using make.
Added:
>
>

Check edited code back into SVN

If you have edited the AMC13 code and want to make the edits available to other developers (important for bug fixes!), you will need to check your changes back into SVN. If you are unfamiliar with SVN, it is a good idea to take a quick gander at the Subversion Manual before proceeding. For a more succinct look at the basic SVN commands, check out 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

In order to be informed of HCAL Upgrade software releases, you must be registered with the correct CMS HyperNews subscriptions. Below is the process for getting on the list.

  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
You will now receive emails whenever a new software package is built with installation instructions and and release notes
 -- EricHazen - 13 Apr 2012

Revision 931 Jan 2013 - CharlieHill

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
Changed:
<
<
HOWTO build AMC13 C++ software on cms2.bu.edu using a private source tree, so that your work will not affect that of others. This is IMHO the preferred way to work (ESH).
>
>
The following procedures describe the installation process for xDAQ releases for the HCAL Upgrade project.
 
Changed:
<
<
First, ensure that the release you want to work with is the current one, as such:
>
>
Though these processes are presented as specific to BU's machine, the steps can easily be generalized to any other SLC5 machine which has xDAQ installed.
 
Changed:
<
<
  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)

>
>
NOTE!!! These examples show how to install release 11_7_7, but the process can be generalized to any xDAQ release xx_x_x.
 
Changed:
<
<
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]
>
>

Install a Release as daqowner

Before any other cms2 users can run the release software, it must be installed by daqowner@cms2.bu.edu:

  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
       
 
Changed:
<
<
If you want to use anonymous CVS (not password prompts), edit the script, search for "anonymous" and remove the comment mark.
>
>
You are now ready to run the executables! See the AMC13 Tool: Getting Started section to learn about the primary AMC13 executable.
 
Changed:
<
<
After the correct release is installed and made current (/home/daqowner/dist symlink) and you have the correct source tree installed using --ownsource, proceed:
>
>

Install a release in your own source tree

If you want to edit the xDAQ code without interfering with others, then you will need to check out a copy of the release into your own source tree. From there you can check any changes back into CVS.
 
Changed:
<
<
source ~daqowner/dist/etc/env.sh  _or_ source ~daqowner/dist/etc/env.csh
setenv PYTHONPATH $ROOTSYS/lib:$PYTHONPATH _or_ export PYTHONPATH=$ROOTSYS/lib:$PYTHONPATH
setenv LD_LIBRARY_PATH ${LD_LIBRARY_PATH}:${PWD}/lib/linux/x86_64_slc5/ _or_ export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${PWD}/lib/linux/x86_64_slc5/

perl ~/installDAQ_xx_x_x.perl --mode=teststand --ownsource=${HOME}/src/xx_x_x --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

>
>
  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/
 make
Changed:
<
<
cd .. cd amc13
>
>
cd ../amc13
 make
Changed:
<
<
cd ..
>
>
cd ../
 make
Changed:
<
<
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.

>
>
  1. After the code is done building, you have finished! You are now ready to run the AMC13Tool executable!
 
Added:
>
>
If you wish to edit the AMC13 code, you can make changes to the source code in ${HOME}/src/11_7_7/hcal/hcalUpgrade/amc13/src/common/ and then go back up to the /amc13 level to recompile using make.
  -- EricHazen - 13 Apr 2012 \ No newline at end of file

Revision 806 Dec 2012 - CharlieHill

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
HOWTO build AMC13 C++ software on cms2.bu.edu using a private source tree, so that your work will not affect that of others. This is IMHO the preferred way to work (ESH).

Revision 725 Sep 2012 - CharlieHill

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
HOWTO build AMC13 C++ software on cms2.bu.edu using a private source tree, so that your work will not affect that of others. This is IMHO the preferred way to work (ESH).
Line: 44 to 44
 cd ipbus make cd ..
Deleted:
<
<
make
 cd amc13 make
Added:
>
>
cd .. make
 source environ.sh (maybe only needed for python)

Revision 624 Sep 2012 - CharlieHill

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
HOWTO build AMC13 C++ software on cms2.bu.edu using a private source tree, so that your work will not affect that of others. This is IMHO the preferred way to work (ESH).
Line: 22 to 22
  ~daqowner/common/bin/pickRelease.sh (choose 11.5.2)

You can make a code-development area on a teststand or USC using:

Changed:
<
<
perl installDAQ_11_5_2.perl --mode=[teststand|usc] --ownsource=${HOME}/src/11_5_2 --packages=hcalUpgrade --cvsuser=[your afs id]
>
>
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.

Line: 32 to 31
 the correct source tree installed using --ownsource, proceed:


Changed:
<
<
source source ~daqowner/dist/etc/env.sh or source source ~daqowner/dist/etc/env.csh setenv PYTHONPATH $ROOTSYS/lib:$PYTHONPATH setenv LD_LIBRARY_PATH ${LD_LIBRARY_PATH}:${PWD}/lib/linux/x86_64_slc5/
>
>
source ~daqowner/dist/etc/env.sh or source ~daqowner/dist/etc/env.csh setenv PYTHONPATH $ROOTSYS/lib:$PYTHONPATH or export PYTHONPATH=$ROOTSYS/lib:$PYTHONPATH setenv LD_LIBRARY_PATH ${LD_LIBRARY_PATH}:${PWD}/lib/linux/x86_64_slc5/ or export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${PWD}/lib/linux/x86_64_slc5/
 

perl ~/installDAQ_xx_x_x.perl --mode=teststand --ownsource=${HOME}/src/xx_x_x --packages=hcalUpgrade

Revision 505 Sep 2012 - EricHazen

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
HOWTO build AMC13 C++ software on cms2.bu.edu using a private source tree, so that your work will not affect that of others. This is IMHO the preferred way to work (ESH).
Changed:
<
<
Find the current release script, usually in ~daqowner, named installDAQ_xx_xx_x.perl. Copy to your home directory.
>
>
First, ensure that the release you want to work with is the current one, as such:
 
Changed:
<
<
If you want to use anonymous CVS (not password prompts), edit the script, search for "anonymous" and remove the comment mark
>
>
  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:

 

Changed:
<
<
source source ~daqowner/dist/etc/env.sh = or =source source ~daqowner/dist/etc/env.csh
>
>
source source ~daqowner/dist/etc/env.sh or source source ~daqowner/dist/etc/env.csh
 setenv PYTHONPATH $ROOTSYS/lib:$PYTHONPATH setenv LD_LIBRARY_PATH ${LD_LIBRARY_PATH}:${PWD}/lib/linux/x86_64_slc5/
Line: 21 to 45
 cd ipbus make cd ..
Added:
>
>
make
 cd amc13 make source environ.sh (maybe only needed for python)

Revision 422 May 2012 - CharlieHill

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
HOWTO build AMC13 C++ software on cms2.bu.edu using a private source tree, so that your work will not affect that of others. This is IMHO the preferred way to work (ESH).

Revision 314 May 2012 - CharlieHill

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
HOWTO build AMC13 C++ software on cms2.bu.edu using a private source tree, so that your work will not affect that of others. This is IMHO the preferred way to work (ESH).
Line: 13 to 13
 setenv LD_LIBRARY_PATH ${LD_LIBRARY_PATH}:${PWD}/lib/linux/x86_64_slc5/
Changed:
<
<
perl ~/installDAQ_11_3_1.perl --mode=teststand --ownsource=${HOME}/src/11_3_1 --packages=hcalUpgrade
>
>
perl ~/installDAQ_xx_x_x.perl --mode=teststand --ownsource=${HOME}/src/xx_x_x --packages=hcalUpgrade
 
cd src/xx_xx_xx/hcal/hcalUpgrade/

Line: 28 to 28
  To run the command-line tool:
Changed:
<
<
bin/linux/x86_64_slc5/AMC13Tool.exe
>
>
./bin/linux/x86_64_slc5/AMC13Tool.exe
  To make changes in the code (your private copy):

Revision 227 Apr 2012 - CharlieHill

Line: 1 to 1
 
META TOPICPARENT name="HcalDTC"
HOWTO build AMC13 C++ software on cms2.bu.edu using a private source tree, so that your work will not affect that of others. This is IMHO the preferred way to work (ESH).
Line: 7 to 7
  If you want to use anonymous CVS (not password prompts), edit the script, search for "anonymous" and remove the comment mark
Added:
>
>

 source source ~daqowner/dist/etc/env.sh = or =source source ~daqowner/dist/etc/env.csh
Added:
>
>
setenv PYTHONPATH $ROOTSYS/lib:$PYTHONPATH setenv LD_LIBRARY_PATH ${LD_LIBRARY_PATH}:${PWD}/lib/linux/x86_64_slc5/
  perl ~/installDAQ_11_3_1.perl --mode=teststand --ownsource=${HOME}/src/11_3_1 --packages=hcalUpgrade

Revision 113 Apr 2012 - EricHazen

Line: 1 to 1
Added:
>
>
META TOPICPARENT name="HcalDTC"
HOWTO build AMC13 C++ software on cms2.bu.edu using a private source tree, so that your work will not affect that of others. This is IMHO the preferred way to work (ESH).

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

 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2019 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback