Versions Compared

Old Version 118

changes.mady.by.user Jeremy McCormick

Saved on

compared with

New Version Current

changes.mady.by.user Jeremy McCormick

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

It presumes nothing except a working Windows machine (2000, XP) with internet access. Therefore, you may only need to use parts of this installation guide if you have some of the external dependencies already installed.

Standalone Windows Distribution

If you do not want to build SLIC yourself, there is a Windows executable avaiable for download.

The current version is available as a static binary packaged with the Xerces dll.

Download the ZIP file using your browser and unzip the contents. You should see the directory slic_win32.

Test out the binary by running it in a console window.

  1. Start -> Run -> cmd.
  2. Press ENTER.
  3. Go to the SLIC directory.
    No Format
    
cd /my/download/dir/slic_win32
  4. Execute from the command line.
    No Format
    
slic

The Xerces and Cygwin dlls are also included so that the package is standalone.

Tip

In order for Windows to find the DLLs needed by SLIC, their directory needs to be in the PATH. Since the PATH usually includes the current directory, i.e. ., the program should work "out-of-the-box" provided that you leave the DLLs and the executable in the same directory and run SLIC from this directory.

Preliminary Setup for Installation

Cygwin

The Cygwin Linux emulation package is a prerequisite for building on Windows.

Info

Unfortunately, the support for native WIN32 using project files is lacking.

  1. Download www.cygwin.com/setup.exe from www.cygwin.com.
  2. Double-click on it and click Next.
  3. Select Install from Internet and click Next.
  4. Enter your preferred Root Directory and click Next.
  5. Enter your preferred Local Package Directory, which can be the same as the Root Directory, and then click Next.
  6. Select Direct Connection, if it is not already, click Next.
  7. Select a site from the Available Download Sites. Servers inside your country will probably be fastest. I use ftp://ftp.sunsite.utk.edu.
  8. Click Next.
  9. In the Cygwin Setup - Select Packages window, you need to make sure that the following tools are selected by clicking in the corresponding box under the New column until you see a version number.
    1. Required packages.
      • Devel -> cvs
      • Devel -> gcc-core
      • Devel -> gcc-g++
      • Devel -> make
      • Base -> gzip
      • Base -> tar
    2. Tool for downloading package tarballs and zip files.
      • Web -> wget
  10. Click Next after you have selected the packages.
  11. Cygwin will now automatically download and install all the selected packages. It might take awhile, so now is the time to go get some coffee.
  12. If desired, select Create icon on Desktop or Add icon to Start Menu, and click Finish.

Testing the Cygwin Command Line Tools

  1. Select Start Menu -> Cygwin -> Cygwin Bash Shell
  2. Check that the following commands do not result in a command not found message.
    No Format
    
cvs
gcc
g++
tar
wget
make
  3. If a command was not found, rerun the Cygwin setup to select the missing package, making sure to select Keep on the Cygwin Setup - Select Packages screen so that all the packages are not reinstalled.
Info

Cygwin needs to be installed to run SLIC.

Download the SLIC Windows binary from this location.

http://www.lcsim.org/dist/slic/slic-current-WIN32-g%2B%2B-bin.tar.gz

Open a Cygwin window and go to the directory where you saved the tarball.

Untar the file after it is saved to your computer.

No Format

tar -zxvf slic-current-WIN32-g++-bin.tar.gz

Now test the binary.

No Format

cd SimDist
./scripts/slic.sh

The slic usage screen should show.

Preliminary Setup for Installation

Cygwin

The Cygwin Linux emulation package is a prerequisite for building on Windows.

Info

Unfortunately, the support for native WIN32 using project files is lacking.

These are brief instructions for installing the necessary Cygwin packages.

  1. Download the Cygwin setup program.
  2. Double-click on it and click Next.
  3. Select Install from Internet and click Next.
  4. Enter your preferred Root Directory and click Next.
  5. Enter your preferred Local Package Directory, which can be the same as the Root Directory, and then click Next.
  6. Select Direct Connection and click Next.
  7. Select a site from the Available Download Sites. Servers inside your country will probably be fastest. I use ftp://ftp.sunsite.utk.edu.
  8. Click Next.
  9. In the Cygwin Setup - Select Packages window, you need to make sure that the following tools are selected by clicking in the corresponding box under the New column until you see a version number.
    1. Required packages.
      • Devel -> cvs
      • Devel -> gcc-core
      • Devel -> gcc-g++
      • Devel -> make
      • Base -> gzip
      • Base -> tar
    2. If OpenGL visualization is being used, these should also be installed.
      • X11 -> ALL
      • Graphics -> OpenGL
    3. Tool for downloading package tarballs and zip files.
      • Web -> wget
  10. Click Next after you have selected the packages.
  11. Cygwin will now automatically download and install all the selected packages. It might take awhile, so now is the time to go get some coffee.
  12. If desired, select Create icon on Desktop or Add icon to Start Menu, and click Finish.
Tip
titleCygwin Packages

It may be easier to simply install all Cygwin packages instead of selecting them individually.

If you need additional information on this installation process, Norman Graf has more detailed Cygwin installation instructions.

Testing the Cygwin Command Line Tools

  1. Select Start -> Programs -> Cygwin -> Cygwin Bash Shell
  2. Check that the following commands do not result in a command not found message.
    No Format
    
cvs
gcc
g++
tar
wget
make
  3. If a command was not found, rerun the Cygwin setup to select the missing package, making sure to select Keep on the Cygwin Setup - Select Packages screen so that all the packages are not reinstalled.
Warning

Throughout this guide, I assume you are using bash or at least another sh

Warning

Throughout this guide, I assume you are using bash or at least another sh-compatible shell. I take no responsibility if you decide to use csh, tcsh, et al.

Work Area

We will install all packages The SLIC package and its dependencies will be installed into a common work area.

  1. From the Cygwin shell, create a work directory for SLIC and its external dependenciesand go into it.
    No Format
    cd /cygdrive/c
mkdir sim
cd sim
  2. Create the file setup.sh with the following contents. (We will be adding to this file as the installation proceeds.)
    No Format
    #!/bin/sh
export sim_work=/cygdrive/c/sim
  3. Source the script to setup the work dir.
    No Format
    source setup.sh
Tip

The $sim_work/setup.sh script will henceforth be referred to as setup.sh. At the end, it will have all of the environment variables required by SLIC and its dependencies. Throughout the guide, any time a line is added to setup.sh, it is presumed that you should also set execute this up line in the your current environment bash shell. Probably the easiest way to do this is by adding to the script first and then (re)sourcing it.

Java

Java is required for installing LCIO installation.

  1. Install an appropriate JDK from http://java.sun.com/ with a minimum version of 1.4.2.
  2. In your setup.sh, set JAVA_HOME and JDK_HOME to the Java installation area.
    No Format
    export JAVA_HOME=/cygdrive/c/java/jdk1.4.2/
export JDK_HOME=${JAVA_HOME}
export PATH=$JDK_HOME$PATH:$JDK_HOME/bin
  3. To test the Java installation, try to run the Java compiler.
    No Format
    javac
Warning

The above JAVA_HOME directory is an example only. You need to replace it with the correct path to your JDK.

Info

Technically, installation of the LCIO C++ libraries only requires a Java JRE, but the JDK is useful for doing reconstruction and analysis where you may want to compile Java programs.

Proceed to Package Installation!

You are now ready to start install the installationsimulation packages.

Tip

Leave your The same Cygwin window open, as you will be using it should be used throughout the installation . This will also allow the environment to be built-up incrementally as the installation proceedsprocess in order to preserve the environment variables.

Package Installations

CLHEP

There are CLHEP has installation instructions for version 1.9 and up (http://wwwasd.web.cern.ch/wwwasd/lhc++\+\+/clhep/INSTALLATION/newCLHEP-install.html.
) for version 1.9 and up. But you should not need them to setup the package.

  1. Create a working directory for CLHEP and go into it.
    No Format
    mkdir clhep
cd clhep
  2. Download the CLHEP tarball.
    No Format
    wget http://cern.ch/clhep/clhep-1.9.2.0.tgz
  3. Unzip to your work directory.
    No Format
    tar -zxvf clhep-1.9.2.0.tgz
  4. Change to CLHEP directory.
    No Format
    cd 1.9.2.0/CLHEP
  5. Run configure. (Takes a long time!Configure the build. (This took 15-20 minutes on my machine.)
    No Format
    ./configure --prefix=`cd ../..; pwd` --disable-shared
  6. Build the library and install it. (Also takes a long time!)
    No Format
    make
make install
  7. Add the following to $sim_work/setup.sh
    No Format
    export CLHEP_BASE_DIR=$sim_work/clhep

Now that the CLHEP dependency is satisfied, you should be able to install Geant4.

Geant4

Geant4 is probably the most difficult application to install of SLIC's dependencies, because there are a lot of options, it takes a long time, and it requires several different make commands. I will describe a minimal installation procedure with support for built-in UI and visualization drivers. You can always update the libraries later if you decide to change these settings.

...

  1. Return to the work dir, create a Geant4 work subdir and go into it.
    No Format
    cd $sim_work
mkdir geant4
cd geant4
  2. Download the Geant4 tarball.
    No Format
    wget http://geant4.cern.ch/geant4/source/source/geant4.7.0.p011.tar.gz
  3. Unzip it.
    No Format
    tar -zxvf geant4.7.01.p01.tar.gz
  4. Setting Set the following variables in $sim_work/setup.sh should allow you to compile without running the ./. (You should not need to run Geant4's Configure script.)
    No Format
    export G4INSTALL=${sim_wrkwork}/geant4/geant4.7.0.p011
export G4SYSTEM=WIN32-g++
    Go into the Geant4 install dir
     If you would like to enable OpenGL visualization, add the following variable definitions.
     This assumes you installed the X11 libraries when you set up cygwin. 
     No Format
    cd geant4.7.0.p01

  5. Build the libraries. These will be placed at $G4INSTALL/lib/WIN32-g++. (Maybe you should let this run overnight!) 
     No Format
    
make

  6. Build the physics list libraries. These will go into $G4INSTALL/lib/plists/WIN32-g++. 
     No Format
    
cd ../physics_lists/hadronic
make

  7. Install the headers. 
     No Format
    
make includes

Hopefully, Geant4 has been installed successfully, and you don't have too many more gray hairs.
LCPhys
  1. Go back to the work dir. 
     No Format
    
cd $sim_wrk

  2. Checkout the physics list from CVS. 
     No Format
    
cvs -d :pserver:anonymous@cvs.freehep.org:/cvs/lcd checkout LCPhys

  3. Assuming that the environment from the Geant4 installation is still in place, you can build this like any other physics list. 
     No Format
    
cd LCPhys
make

  4. Set the LCPhys variable in setup.sh. 
     No Format
    
LCPHYS_BASE=$sim_wrk/LCPhys

LCIO
 Warning
LCIO installation requires a working Java SDK.
LCIO has a very nice manual with a whole section on installation. Thanks, Frank!
I will still walk you through the basic procedure.
  1. export OGLHOME=/usr/X11R6
export G4VIS_BUILD_OPENGLX_DRIVER=1
export G4VIS_USE_OPENGLX=1

  2. Go into the Geant4 base dir. 
     No Format
    
cd geant4.7.1

  3. LCPhys requires that a special flag is set in order to use the latest Kaon model. At the end of config/architecture.gmk, insert the following line exactly as it appears below: 
     No Format
    
CPPFLAGS += -DG4BERTINI_KAON

     Hopefully, this hack will be remedied soon!
  4. Now for another lovely Geant4 hack. In order to successfully compile the HepRep driver, the following line in the file config/sys/WIN32-g++.gmk 
     No Format
    
CXXFLAGS  := -Wall -ansi -pedantic -pipe

     should be replaced with 
     No Format
    
CXXFLAGS  := -W -Wall -ansi -pedantic -Wno-non-virtual-dtor -Wno-long-long
CXXFLAGS  += -Wwrite-strings -Wpointer-arith -Woverloaded-virtual -pipe 

  5. Build the libraries, which will be placed at $G4INSTALL/lib/WIN32-g++. (This could take up to a few hours depending on your machine.) 
     No Format
    
cd source
make

  6. Install the headers into $G4INSTALL/include. 
     No Format
    
make includes

  7. Build the physics list libraries. These will go into $G4INSTALL/lib/plists/WIN32-g++. 
     No Format
    
cd ../physics_lists/hadronic
make

Hopefully, Geant4 has been installed successfully, and you don't have too many more gray hairs.
LCPhys
SLIC requires a special physics list written by Dennis Wright for Linear Collider physics.
  1. Go back to the work dir. 
     No Format
    
cd $sim_work

  2. Checkout the physics list from CVS. 
     No Format
    
cvs -d
  3. Go back to the work dir. 
     No Format
    
cd $sim_wrk

  4. Checkout LCIO from CVS. 
     No Format
    
cvs -d :pserver:anonymous@cvs.freehep.org:/cvs/lciolcd checkout lcio

  5. Add these lines to your setup.sh. 
     No Format
    
export LCIO=${sim_wrk}/lcio 
export PATH=$LCIO/tools:$LCIO/bin:$PATH

  6. LCPhys

  7. Assuming that the environment from the Geant4 installation is still in place, you can build this like any other physics list, and the library should be installed into $G4INSTALL/lib/plists/WIN32-g++Build the libraries using the bundled aid and ant tools. 
     No Format
    ant aid cpp

Xerces-C++
  1. cd LCPhys
make

  2. Set the LCPhys variable in setup.shGo back to the work dir, create a subdir for Xerces-C++, and go into it. 
     No Format
    cdexport $sim_wrk
mkdir xercesc
cd xercesc

  3. Download the Xerces tarball. 
     No Format
    
wget http://www.apache.org/dist/xml/xerces-c/xerces-c-src_2_6_0.tar.gz

  4. Unzip the tarball. 
     No Format
    
tar -zxvf xerces-c-src_2_6_0.tar.gz

  5. Set XERCESCROOT for the build in your environment, only. 
     No Format
    
export XERCESCROOT=${sim_work}/xerces-c-src_2_6_0

  6. Go into the Xerces-C++ build area. 
     No Format
    
cd xerces-c-src_2_6_0/src/xercesc

  7. Configure the build. 
     No Format
    
./runConfigure -pcygwin -cgcc -xg++ \
-minmem -nsocket -tnative -rpthread \
-P `cd ../../..; pwd`

  8. Build and install it. 
     No Format
    
make
make install

  9. In setup.sh, set XERCESCROOT to the installation area and add the library path. 
     No Format
    
export XERCESCROOT=${sim_work}/xercesc
export PATH=$XERCESCROOT/lib:$PATH

GDML
GDML's CVS is not directly accessible from the command line, but a tarball is available through a WWW interface.
  1. LCPHYS_BASE=$sim_work/LCPhys

LCIO
LCIO provides binary output capabilities.
 Warning
Installation requires a working Java runtime for ant support.
LCIO has a very nice manual with a whole section on installation. Thanks, Frank!
I will still walk you through the basic procedure.
  1. Go back to the work dir. 
     No Format
    
cd $sim_work

  2. Checkout LCIO from CVS. 
     No Format
    
cvs -d :pserver:anonymous@cvs.freehep.org:/cvs/lcio checkout lcio

  3. Add these lines to your setup.sh. 
     No Format
    
export LCIO=${sim_work}/lcio 
export PATH=$LCIO/tools:$LCIO/bin:$PATH

  4. Build the libraries using the bundled aid and ant tools. 
     No Format
    
cd lcio
ant aid.generate cpp

Xerces-C++
  1. Go back to the work dir, create a subdir for Xerces-C++, and go into it. 
     No Format
    
cd $sim_work
mkdir xercesc
cd xercesc

  2. Download the Xerces tarball. 
     No Format
    
wget http://www.apache.org/dist/xml/xerces-c/xerces-c-src_2_6_0.tar.gz

    Download a snapshot of the current CVS head using this link in your browser. http://simu.cvs.cern.ch/cgi-bin/simu.cgi/simu/GDML2/GDML2.tar.gz?tarball=1 Save the tarball to sim_wrk, which should be C:\sim.
  3. Unzip the tarball. 
     No Format
    tar -zxvf GDML2xerces-c-src_2_6_0.tar.gz

    Change into the CPPGDML directory
  4. Set XERCESCROOT for the build in your environment, only. 
     No Format
    cd GDML2/CPPGDML

    Set GDML_BASE in setup.sh
    export XERCESCROOT=${sim_work}/xercesc/xerces-c-src_2_6_0

  5. Go into the Xerces-C++ build area. 
     No Format
    export GDML_BASE=${sim_work}/GDML2/CPPGDML
export PLATFORM=cygwin_g++
cd xerces-c-src_2_6_0/src/xercesc

  6. Configure the Configure the build. 
     No Format
    ./configurerunConfigure -pcygwin -enable-geant4-vis --enable-geant4-ui --with-geant4-libtype=granular \
--with-platform=cygwin_g++

  7. Build it. 
     No Format
    
make

LCDD
  1. cgcc -xg++ \
-minmem -nsocket -tnative -rpthread \
-P `cd ../../..; pwd`

  2. Build and install it. 
     No Format
    
make
make install

  3. In setup.sh, set XERCESCROOT to the installation area and add the DLL location to the PATHGo to the work dir and checkout LCDD. 
     No Format
    cdexport XERCESCROOT=${sim_work}/xercesc
cvs -d CVSROOT=:pserver:anonymous@cvs.freehep.org:/cvs/lcd checkout lcdd

  4. Go into the LCDD dir. 
     No Format
    
cd lcdd

  5. Configure the build. 
     No Format
    
./configure --with-xerces-libname=xerces-c.dll

  6. Build the library. 
     No Format
    
make

  7. Set the LCDD_BASE variable in setup.sh. 
     No Format
    
export LCDD_BASE=${sim_work}/lcdd

SLIC
  1. export PATH=$XERCESCROOT/bin:$PATH

 Tip
When rebuilding Xerces-C++, which you will probably not need to do once you get it working, XERCESCROOT needs to be set back to the Xerces-C++ source area rather than the installation base.
GDML
GDML's CVS is not directly accessible from the command line, but a tarball is available through a WWW interface.
  1. Download a snapshot of the current CVS head using this link in your browser: http://simu.cvs.cern.ch/cgi-bin/simu.cgi/simu/GDML2/GDML2.tar.gz?tarball=1. 
    • Save the tarball to sim_wrk, which should be C:\sim.
  2. Unzip the tarball. 
     No Format
    
tar -zxvf GDML2.tar.gz

  3. Change into the CPPGDML directory
  4. Go to the work dir and checkout SLIC. 
     No Format
    
cd ${sim_work}
cvs -d CVSROOT=:pserver:anonymous@cvs.freehep.org:/cvs/lcd checkout slic

  5. Go into the SLIC dir. 
     No Format
    cd slicGDML2/CPPGDML

  6. Set the SLICGDML_BASE variable in setup.sh. 
     No Format
    export SLICGDML_BASE=${sim_work}/GDML2/slicCPPGDML

  7. Configure the build with the Windows name for the Xerces-C++ lib. 
     No Format
    ./configure --withenable-xercesshared-libname=xerces-c.dll
libs=no

  8. Build the binaryit. 
     No Format
    make all

LCDD
If the test completes successful, you should see SLIC's usage statement as it runs and then exits.
Final Setup Script
...
  1. Go to the work dir and checkout LCDD. 
     No Format
    
cd ${sim_work}
cvs -d :pserver:anonymous@cvs.freehep.org:/cvs/lcd checkout lcdd

  2. Go into the LCDD dir. 
     No Format
    
cd lcdd

  3. Configure the build. 
     No Format
    
./configure

  4. Build the library. 
     No Format
    
make

  5. Set the LCDD_BASE variable in setup.sh. 
     No Format
    
export LCDD_BASE=${sim_work}/lcdd

SLIC
Finally, you are ready to install the simulation "hub" package. After this, you will have a fully-featured Geant4 simulator on your Windows machine.
  1. Go to the work dir and checkout SLIC. 
     No Format
    
cd ${sim_work}
cvs -d :pserver:anonymous@cvs.freehep.org:/cvs/lcd checkout slic

  2. Go into the SLIC dir. 
     No Format
    
cd slic

  3. Set the SLIC_BASE variable in setup.sh. 
     No Format
    
export SLIC_BASE=${sim_work}/slic

  4. Configure the build. 
     No Format
    
./configure

  5. Build the binary (note that we currently do not support visualization). 
     No Format
    
export G4VIS_NONE=1
make all

If the build completes successfully, you should see SLIC's usage statement from the test run. 
Running SLIC after Installation
When you want to run later in a Cygwin shell, $XERCESCROOT/bin should be in the PATH, so that Windows can find the DLL at runtime. Since the other applications were linked-in statically, this should be the only setup requirement.
This is the procedure for running SLIC from the Cygwin commandline.
  1. Select Start -> Programs -> Cygwin -> Cygwin Bash Shell.
  2. Add Xerces-C++ bin to the path. 
     No Format
    
export PATH=/cygdrive/c/sim/xerces/bin:$PATH

  3. Go to the SLIC directory. 
     No Format
    
cd /cygdrive/c/sim/slic

  4. Run the executable. 
     No Format
    
bin/WIN32-g++/slic [options]

If you receive an error message about a missing DLL cygxerces-c26.dll, then make sure that the PATH is setup correctly and Xerces-C++ was properly installed.
 Warning
If you encounter difficulties running macros, it may be due to the different DOS and Unix end-of-line definitions. You can convert files using:
 No Format

dos2unix mymacro.mac

In order to run with OpenGL visualization, an X-server needs to be running on your machine.
This command will start the Cygwin X-server.
 No Format

startxwin.sh

Then you need to run SLIC from the xterm that pops-up. At least on my setup, it does not work to run the binary from the plain Cygwin window.
Final Setup Script
The final version of setup.sh (without OpenGL visualization) should be similar to this.
 No Format

#!/bin/sh

# 1. work area
export sim_work=/cygdrive/c/work/nsim

# 2. java
export JAVA_HOME=/cygdrive/c/Java/jdk1.4.2
export JDK_HOME=${JAVA_HOME}
export PATH=${JAVA_HOME}/bin:${PATH}

# 3.#!/bin/sh

# 1 work area
export sim_work=/cygdrive/c/work/nsim

# 2 java
export JAVA_HOME=/cygdrive/c/Java/jdk1.4.2
export JDK_HOME=${JAVA_HOME}

# 3 clhep installation area
export CLHEP_BASE_DIR=${sim_work}/clhep

# 4. geant4
export G4INSTALL=${sim_work}/geant4/geant4.7.0.p01
export G4SYSTEM=WIN32-g++
#export OGLHOME=/usr/X11R6
#export OGLHOME=/usr
#export G4VIS_BUILD_OPENGLX_DRIVER=1
#export G4VIS_USE_OPENGLX=1=WIN32-g++

# 5. LCPhys
export LCPHYS_BASE=${sim_work}/LCPhys

# 6. LCIO
export LCIO=${sim_work}/lcio
export PATH=$LCIO/tools:$LCIO/bin:$PATH

# 7. Xerces-C++ installation area
export XERCESCROOT=${sim_work}/xercesc
export PATH=$XERCESCROOT/bin:$PATH

# 8. GDML
export GDML_BASE=${sim_work}/GDML2/CPPGDML
export PLATFORM=cygwin_g++

# 9. LCDD
export LCDD_BASE=${sim_work}/lcdd

# 10. SLIC
export SLIC_BASE=${sim_work}/slic

The above should be sufficient to "bootstrap" any future (re)builds with the following caveats.
 Tip
The G4WORKDIR directory should be set to LCDD_BASE when building LCDD and SLIC_BASE for SLIC, or your libs and binaries will end up in strange places.
 Tip
When rebuilding Xerces-C++, which you will probably not need to do once you get it working, XERCESCROOT needs to be set back to the Xerces-C++ source area rather than the installation base.
Additional Resources
...
should be sufficient to "bootstrap" any future (re)builds.
Done!
That's it. 
Happy simulating!
See links in the next section for more information.
If you think this guide could be improved in any way, then please contact the author
Links