We're happy to announce the release of two new BRAHMS software packages: BRAG and BREG.
This outlines the building and installation procedure of these two pacakges. Please read carefully. See also individual README files in the source trees.
This is our GEANT3.21 detector simulation, the software previsouly known as GBRAHMS. The somewhat ad hoc build system of the old GBRAHMS has been replaced by Autotools, since the upcoming BRAT2 will use those tools. This allows for a homogenious build system, easier installation - in short software management - as well as development.
This is a set of programs and libraries for various event generators, as well as a common shared library. This package was formerly split in 6 packages: EG, EGREAD, FRIT702, HIJING, NEXUS, URQMD, and VENUS. This has now been collected in one package with the subpackages base, brfritiof, brhijing, brnexus, brrqmd, brurqmd, and brvenus. Please note, that brrqmd does not compile under Linux yet. The package uses Autotools as the build system.
cvs -d /afs/rhic/brahms/BRAHMS_CVS checkout <package>
cvs -d /afs/rhic/brahms/BRAHMS_CVS export -r <tag> <package>See more on CVS tags below.
cd <package>
make dist
This will give you the tar-ball
<package>-<version>.tar.gz, which
you may transfer where ever you like, and then unpack
gzip -dc <package>-<version>.tar.gz | tar xf -
which gives you the sources in the directory
<package>-<version>. Now go to
that directory:
cd <package>-<version>
aclocal -I config
automake -a
autoconf
This step is normally only needed the first time you get the
sources into you working area.
./configure
You may want to pass options to the configure script.
Try ./configure --help for a full list of
avaliable options. In particular note the
--prefix option (see also below).
make
make install
On most systems, you can lumb this into one, by simply saying
make install
If make isn't GNU Make, you may need to say gmake or install GNU Make on your system (see more below).
Skip this step if you are meerly obtaing the sources from RCF to build on your home system.
make dist
This will give you the tar-ball
<package>-<version>.tar.gz
make
make check
If everyting worked fine, install the package
make install
Some BRAG and BREG packages depend on CERNLIB being installed. The build system need to know where the libaries are installed. per default it will look in
/usr
/usr/local
/usr/local/cern
/usr/local/cern/pro
/usr/local/cern/new
/usr/local/cern/old
/cern
/cern/pro
/cern/new
/cern/old
/opt/cern
/opt/cern/pro
/opt/cern/new
/opt/cern/old
/afs/cern.ch/asis/cern/pro
/afs/cern.ch/asis/cern/new
/afs/cern.ch/asis/cern/old
This may be overridden by passing the --with-cern-libraries -->
option to the configure script.
The BREG sub-packages
/usr/[lib|include]
/usr/local/[lib|include]
/usr/local/brahms/[lib|include]
/opt/brahms/[lib|include]
/opt/brahms/new/[lib|include]
/opt/brahms/pro/[lib|include]
/opt/brahms/old/[lib|include]
/afs/rhic/opt/brahms/[lib|include]
/afs/rhic/opt/brahms/new/[lib|include]
/afs/rhic/opt/brahms/pro/[lib|include]
/afs/rhic/opt/brahms/old/[lib|include]
${HOME}/[lib|include]
${HOME}/brahms/[lib|include]
This can be overridden by passing the --with-breg-libdir
and --with-breg-incdir options to ./configure.
Autotools is a common name for GNU Automake, GNU Autoconf, and GNU Libtool. These tools are extensively used in the OpenSource community and elsewhere for building software packages.
Autotools is commonly installed on GNU/Linux machines, and very often on Un*x machines. If your particular system have got these three packages, don't dispear, you have a number of options (ordered by our recomendation):
gzip -dc <package>-<version>.tar.gz | tar xf -
cd <package>-<version>
./configure --prefix=/usr/local
Start with autoconf, then automake, and
end with libtool
make install
cd <package>-<version> ./configure --prefix=<my directory>Please see below on choosing the prefix.
/afs/rhic/opt/brahms/pro
Just put /afs/rhic/opt/brahms/pro/bin in your
PATH
The Autotools installed on the AFS area will track the ones distributed with Redhat Linux version installed on the RCAS machines.
Some Make implmentations are fairly buggy (Digital Unix for one), so if you don't have GNU Make installed on your system, We strongly sugggest you do that before installing Autotools. The procdure is the same as above. You can find GNU Make in gnu/make at a GNU FTP mirror site.
When installing packages, either the BRAHMS or third-party ones, you need to give a little thought to where you want to install it.
The packages will be installed in a tree like
<prefix> -+- bin +- include/<package> +- lib +- man +- libexec +- share/<package> +- varwhere <prefix> is the chosen prefix via the --prefix=<prefix> option. To use the pacakge, just make sure that <prefix>/bin is in your PATH. No other environment variable should be set.
<topprefix>-+- new --prefix=<topprefix>/new
|
+- pro --prefix=<topprefix>/pro
|
+- old --prefix=<topprefix>/old
Then when you configure you source tree, you'll pass it the
options listed on the right. This is the way the AFS
diretories are organised.
This allows user to easily choose which version to use, by simple putting <topprefix>/<version>/bin in her PATH before all other BRAHMS paths.
/usr <= Need SysOp privileges
/usr/local <= Need SysOp privileges
/usr/local/brahms
/opt/brahms
${HOME} <= Default
${HOME}/brahms
BRAG Tags will always be of the form
BRAG-<major>-<minor>-<revision>
and BREG tags will be of the form
BREG-<major>-<minor>-<revision>
Sub-packages of BREG will usually not have individual tags. But if
they do, they'll be of the form
<subpackage in capitals>-<major>-<minor>-<revision>
In all of the above,
AM_INIT_AUTOMAKE(<package>, <major>.<minor>.<revision>)
Not that this is the only place that a version bump
may occure, and it sould always be followed by a tagging of the CVS
repository with the appropaite tag as outline above.
| Flemming Videbæk | <mailto:videbaek@bnl.gov> |
| Kris Hagel | <hagel@comp.tamu.edu> |
| Christian Holm Christensen | <cholm@nbi.dk> |