Inventory of Existing Documentation

GridPP document list

GGUS document list

Scientific Linux


Documentation on LCG API’s

This document represents a list of all documentation tracked down so far concerning the LCG-2 API. There is probably other documentation out there which did not appear in any of the searches made of the EGEE SA1/JRA1 web sites (including corresponding EDMS), the LCG web site and a search of the web made using Google. To be able to understand the use of the LCG-2 API requires knowledge of the LCG-2 command line interface (CLI) and the Job Description Language (JDL). As a result of this several documents are included below that are connected to the CLI and JDL files. Many more documents on these topics exist than do for the API, and hence the list presented should only be considered as a representative selection, hopefully including the most useful documents.


Documentation with Installation

Within the installation directory of LCG-2 (typically /opt/edg) can be found a collection of documentation including documentation on the API. The documentation on the API is auto-generated using the doxygen tool and details the data types, namespaces, functions, etc. of the API. This appears to be the main source of documentation on the API. User guides and documentation on the CLI can also be found in here. Many of the documents referred to in other documents on LCG-2 can be found here.


The LCG-2 User Manual

This document gives an overview of the main services of LCG-2. It allows the reader to understand the building blocks and the available interfaces to the GRID tools in order to run jobs and manage data. It should not be considered as either an administration or a developer guide. This manual is addressed to both users and site administrators of LCG-2. Topics covered include the LCG-2 architecture, Security, Workload Management (Job Submission), Data Management and the Information System plus an appendix on the GLUE Schema.

The LCG-2 User Scenario

This document is fundamentally a walk through of the steps to be followed in order to submit, run and execute a job on the LCG-2 Grid (now the EGEE Grid). The focus of this document is on how the user should proceed in order to make his job run and what happens to the job once it has happened. The assumption is made that the user already has a grid certificate and membership of a Virtual Organization.

Guide to LCG Application, Middleware & Network Security

A document by the LCG Security Group identifying areas of security practice that must be addressed in application and middleware design, planning and deployment processes for software used on LCG. This document does not include examples or details of how to implement these practices.


An attempt to answer many of the questions a novice user of LCG-2 would ask. This document is probably not as much use to the more experienced user. Questions include things like “How can I know the JobId at runtime?” and “How can I know from within a job the name of the CE?”

Datagrid: WP1 – WMS Software Administrator and User Guide

A comprehensive guide to the Workload Management System (Job Submission) dating back to the EDG Project. Given that the CLI has not changed in LCG-2 this document is still relevant. A guide to each command and all its options is provided. This document is more of a reference source than a tutorial. The document describes the complete process by which the WMS software can be installed and configured. Guidelines on accesses the WMS functionalities are provided.

Grid Experience using EDG2 and LCG-1

This document provides an introduction to LCG-1. It is aimed at users with previous grid experience and knowledge of grid basics. The document focuses on the topics of job submission and data management and includes details on potential error messages the user might encounter and their likely causes.


Datagrid: JDL Attributes

A list of the attributes for the Job Description Language, it may be used as a reference source. This document is aimed at the user who is already familiar with grid concepts as the document does not address in detail why you would wish to use the various attributes.

The GLUE Schema

A web site detailing the GLUE Schema used to match a job’s requirements with a suitable Computing Element/Storage Element. Descriptions of the tags detailing the configuration of the CE/SE are provided plus UML diagrams of the structure. This site is not suitable for the novice user, instead acting as a reference source for the advanced user needed to specify their jobs requirements to a high degree.

EGEE Specific Support

GILDA tutorials

NA4 Application support wiki

NA3 Training Materials Repository

NA3 Training Schedule web page

NA3/SA1 (EIS) Tutorials (1, 2): NA3 in conjunction with SA1 (EIS) have so far run two tutorials on the LCG API. These cover the topics of security, querying the information system, workload management (job submission), data management and application software installation. The tutorials cover how to use the CLI as well as how to do the same task’s using the API. Future tutorials can be found on the NA3 website.

NA3 Induction Events (1, 2): From the start of EGEE, NA3 have been providing induction to grid computing courses. A core component of these courses has been the LCG-2 CLI with many practicals and presentations. The majority of these practicals use grid-tutor (, a grid running the latest EGEE middleware provided and supported by NA4. These practicals/presentations focus on Security, Job Submission and Data Management. Some non-English resources (for example Russian) are available.

Local Grid Guides

User Guide for CCIN2P3


TIFR (India)

-- Main.loomis - 01 Dec 2006

Edit | Attach | Watch | Print version | History: r2 < r1 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r2 - 2006-12-07 - StephenBurke
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    EGEE All webs login

This site is powered by the TWiki collaboration platform Powered by Perl This site is powered by the TWiki collaboration platformCopyright & by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Ask a support question or Send feedback