Getting Started With Offline Software

From Daya Bay
Jump to navigation Jump to search
Offline Documentation: [Offline Category] [FAQ] [Howto] [Reference] [Manual]

Offline Documentation
This article is part
of the Offline Documentation
Other pages...

Offline Category
How Tos
Getting Started
Software Installation

See also...

General Help on this Wiki

This describes how to get started with the offline software. More information is available from the navigation box on the right hand side of the pages.

Preinstalled sites

The easiest way to get started is to get an account on a cluster or other machine that already has the software installed. For a novice at BNL, the best place to start is on the PDSF cluster, where all of the data can be found, and the instructions are most complete.

Get a cluster account

Instructions on getting an account are here:

Setting up your environment

It is recommended that you set up your environment by hand and not include it in your .cshrc, .login, etc., file. CMT (Configuration Management) will set up most of your environment through the nuwaenv script. Site-specific details are in the site-specific pages.

Select a NuWa Release

The currently installed releases are (as of August 1, 2014):

3.8.4-opt   3.8.4-dbg   3.9.2-opt   3.9.2-dbg
3.10.1-opt  3.10.1-dbg  3.11.0-opt  3.11.0-opt
trunk-opt  trunk-dbg

Note#1: trunk-opt is soft-linked to the latest optimized daily build and trunk-dbg is soft-linked to the latest debugged verison of the daily build.

NuWa Setup

The path to the NuWa releases are site-dependent. The script nuwaenv renders this site-dependence transparent to the user, and is therefore the recommended method for setting up the nuwa environment. The nuwaenv script also insulates you against other issues, such as the current (January 2012) transition from SL4 to SL5.3. Unfortunately, nuwaenv is currently available only on PDSF and RACF.

% source ~dayabay/nuwaenv.(c)sh
% nuwaenv -r trunk    (for debugged version of daily build)


% nuwaenv -r trunk -O (for optimized version of daily build)

If you want to load official releases, replace 'trunk' with the release name (e.g. 3.11.0)

For sites other than PDSF and RACF, or to use an alternative method without nuwaenv, follow the Local Setup Methods links below.

Local Setup Methods

Your local installation may use some mechanism on top of this generic one. Here are some known methods:

  • General purpose setup convenience that hides site-specific details can be done with "nuwaenv". See the topic this topic for details.

Other methods

Running Jobs

See the section on our main program.

Getting hands dirty with code

Analysis Basics

The Analysis Basics section of the Offline User Manual is a good place to learn how to jump into working with the data.

Examining the Tutorial area of the dybgaudi project

In the main project dybgaudi there is the Tutorial/ area that contains many examples. Some Tutorial packages are particularly good to start with:


Has several Python job modules that show how to access the data.


This is under the Simulation/ sub-directory and shows examples in C++ of accessing the simulation data and making some histograms.

Making your own project

When you want to write your own packages or modify existing ones you make your own project and fill it with packages. This project will leverage the installed base projects so you do not need to install the entire software. See the topic on CMT Projects for more information on how to do this.

Installing the software yourself

If you are a new site or just want to install the software on your own machine(s) there is a script that does all the hard work. See the topic on Offline Software Installation for more information.

Offline Software Documentation: [Offline Categories] [FAQ] [Offline Documentation Category]