TUDAS installation and configuration
Installing TUDAS libraries
To install TUDAS libraries for Java, C++ and Python, you need to checkout latest project release from svn tag:
svn co svn+ssh://svn.cern.ch/reps/totem/trunk/tudas/release
Here you can find c++, java and python client-side libraries and examples, grouped in language specific directories.
There is also setup directory with all needed configuration files. In order to use Tudas library, you must create special workspace directory in your filesystem. It can be done automatically, by running our installation script. The script will create workspace and copy configuration files to workspace location. By default, workspace location is set to
$HOME/.tudas. If you'd like to install Tudas workspace in another location, set
TUDAS_HOME environment variable before installation. Remember, that once you install Tudas in non-default location, you'll have to keep
TUDAS_HOME set while running applications using Tudas library.
To run installation script, just invoke command:
Unix:
cd release
bash install.sh
Windows:
cd release
install.bat
Important Note: Despite we provide support for Windows operating system, it's only partial. As for now, you can easily use Java libraries on Windows, but Python and c++ aren't compiled for this platform.
Configuring TUDAS
According to workspace concept, we store all configuration files in one place. It doesn't matter if you use only one programming language or all of them, the configuration is always the same. Of course, you can use multiple different workspaces and manipulate TUDAS_HOME environment variable, if you really want it.
The workspace directory may have any name (by default it is
.tudas), but the content is fixed and should not be changed. Properly installed workspace contains:
- tudas.config file - main configuration properties file. Its values can be modified by user, if there's such a need. The file is formatted as classic property name=value list, divided into lines. The lines starting with '#' are ignored. All allowed properties are described below:
Property name |
Description |
communication.configuration.url |
Server URL address, pointing to communication configuration file. This location should be fixed - when there are any changes in communication protocol, there's no need of updating client-side libraries or configuration. New configuration is loaded each time you run your application using Tudas library. |
- log directory - a place, where you can find detailed logging messages stored in log files. It's very useful especially when you have experienced strange errors. It is recommended to send us these log files when there are difficult to solve problems.
- log4cpp.config file - configuration file for c++ logger. It can be modified by user (in order to i. e. change logs format), but it's not recommended.
Now, after configuring TUDAS, you are ready to run
examples.
Compiling TUDAS in CMSSW
Apart from installing TUDAS on your own host, you can also compile TUDAS module and use it in CMSSW. To do that, you should do following steps:
- Create new CMSSW project workspace:
export RFIO_USE_CASTOR_V2=YES
export STAGE_HOST=castorpublic
export STAGE_SVCCLASS=default
export SCRAM_ARCH=slc5_amd64_gcc434
source /afs/cern.ch/cms/cmsset_default.sh
scram project CMSSW CMSSW_4_2_4
- Check out version of CMSSW with Tudas from SVN branch:
svn co svn+ssh://svn.cern.ch/reps/totem/branches/CMS_4_2_4_with_tudas CMSSW_4_2_4/src/
- Install tool for database library:
cd CMSSW_4_2_4/src/
eval `scram runtime -sh`
/afs/cern.ch/exp/totem/soft/database/tudas/install_tudas.sh
- Compile CMSSW framework.
scram b -j 4
If an error occurs, run following command until everything is OK (to exit, press Ctrl-C).
edmPluginRefresh
Finally:
scram b