[Halld-offline] Setting up the GlueX environment

[Mark Ito]

Folks,

As promised at one of the offline meetings, I wrote some brief 
instruction on how to set up the GlueX environment. Find it below and at

https://halldweb.jlab.org/wiki/index.php/Setting_Up_the_GlueX_Environment

It is also linked from the Offline Software page at

https://halldweb.jlab.org/wiki/index.php/GlueX_Offline_Software#GlueX_Software

Let me know if you find errors or mis-statements (or go ahead and 
correct them yourselves).

   -- Mark
__________________________________________________

Setting Up the GlueX Environment

We have two methods for setting up the environment for GlueX software. 
They are complementary; depending on what you want to do one will be 
more appropriate than the other. Let's call them "setenv" and 
"build_scripts".

setenv

For every complete build of sim-recon, a setenv.csh and a setenv.sh file 
is produced. Sourcing the appropriate file will reproduce the 
GlueX-related environment that was used to build that version of 
sim-recon exactly. Find the files under the BMS_OSNAME directory 
(directory that looks like Linux_RHEL7-x86_64-gcc4.8.3 for example, pick 
the one appropriate for your platform) of HALLD_HOME.
If you need custom settings of the environment, make a copy of the 
appropriate file and edit it. The file is nicely formatted and the 
changes you need are not hard to figure out.

  * *Advantages*: nothing to change, guaranteed consistency
  * *Disadvantages*: customization by direct editing of script, need
    pre-existing successful build to start


build_scripts

There is a set of scripts to help you set-up your environment from 
scratch. Even if one is not starting from scratch, they can be used to 
set-up pre-existing sets of software. At JLab they are in 
/group/halld/Software/scripts/build_scripts . They can be checked out at 
https://halldsvn.jlab.org/repos/trunk/scripts/build_scripts.

  * *Advantages*: do not need a pre-existing build, can customize
    configuration without re-writing scripts.
  * *Disadvantages*: more complicated, consistency of packages not
    guaranteed


Default build at JLab

Sourcing the script gluex_env_jlab.(c)sh will set-up the default 
environment at JLab.

Nightly build at JLab

Source the file gluex_env_nightly.(c)sh with a date argument in 
YYYY-MM-DD format, e. g.
|source $BUILD_SCRIPTS/gluex_env_nightly.csh 2015-07-15|

   Using a version.xml

If you are using the standard GlueX Version Managment System (GVMS) 
directory structure, you can use a version-specifying xml file to set up 
your environment. Version xml files are kept in 
/group/halld/www/halldweb/html/dist.

 1. Define GLUEX_TOP and BUILD_SCRIPTS
 2. Identify a version.xml, e. g., /path/to/version.xml
 3. |source $BUILD_SCRIPTS/gluex_env_version.(c)sh /path/to/version.xml|


At JLab, there is a GLUEX_TOP for each supported platform in 
/group/halld/Software/builds.

Using version.xml and a custom build of sim-recon

 1. Define GLUEX_TOP, BUILD_SCRIPTS
 2. Identify a version.xml, /path/to/version.xml
 3. |eval `$BUILD_SCRIPTS/version.pl $version_file`|
 4. |setenv HALLD_HOME /path/to/custom/sim-recon| (or |export
    HALLD_HOME=/path/to/custom/sim-recon|)
 5. |source $BUILD_SCRIPTS/gluex_env.(c)sh|

Retrieved from 
"https://halldweb.jlab.org/wiki/index.php?title=Setting_Up_the_GlueX_Environment 
<https://halldweb.jlab.org/wiki/index.php?title=Setting_Up_the_GlueX_Environment&oldid=68688>"

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mailman.jlab.org/pipermail/halld-offline/attachments/20150715/43b5e0f9/attachment.html>