Deprecated: Setting Up the GlueX Environment

From GlueXWiki
Revision as of 16:15, 15 July 2015 by Marki (Talk | contribs) (draft)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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. For lack of a better name I'll 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 Disadvantage: 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.

Default build at JLab

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

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.

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/sim-recon (or export HALLD_HOME=/path/to/sim-recon) 5) source $BUILD_SCRIPTS/gluex_env.(c)sh