Other introduction/main

Table Of Contents

Previous topic

Daya Bay Offline User Manual

Next topic

Quick Start

This Page

Daya Bay Links

Content Skeleton

Introduction

Intended Audience

This manual describes how Daya Bay collaborators can run offine software jobs, extend existing functionality and write novel software components. Despite also being programmers, such individuals are considered “users” of the software. What is not described are internal details of how the offline software works which are not directly pertinent to users.

This document covers the software written to work with the Gaudi framework [1]. Some earlier software was used during the Daya Bay design stage and is documented elsewhere [g4dyb].

Document Organization

The following chapter contains a one to two page summary or “quick start” for each major element of the offline. You can try to use this chapter to quickly understand the most important aspects of a major offline element or refer back to them later to remind you how to do something.

Each subsequent chapter gives advanced details, describes less used aspects or expand on items for which there is not room in the “quick start” section.

Contributing

Experts and users are welcome to contribute corrections or additions to this documentation by commiting .tex or .rst sources. However:

Ensure latex compiles before committing into dybsvn

Building Documentation

To build the plain latex documentation:

cd $SITEROOT/dybgaudi/Documentation/OfflineUserManual/tex
make plain     ## alternatively: pdflatex main

To build the Sphinx derived latex and html renderings of the documentation some non-standard python packages must first be installed, as described oum:docs. After this the Sphinx documentation can be build with:

. ~/v/docs/bin/activate    # ~/v/docs path points to where the "docs" virtualpython is created
cd $SITEROOT/dybgaudi/Documentation/OfflineUserManual/tex
make

Typographical Conventions

This is bold text.

Footnotes

[1]See chapter Offline Framework.