cipriangal / halla-osp Goto Github PK

 Hall A Operation Manual & ESAD Information
===========================================

18 September 2014

The ESAD Introduction (Chapter1) and General Hazards (Chapter2) are located at:

src/esad

The rest of the ESAD materials are pulled directly from the operations manual
either as level zero, safety, or uncommented information.

-

Moved the Hall A OSP document from cvs to github.   

The 2011 version of the document is being updated in preparation
for first beam in Hall A in early 2014.

This document is intended to provide guidelines for Scientists (both staff and visitors) how to
safety operate the standard equipment in Hall A.

This document is NOT intended to provide guidelines for technical equipment (such as manlifts or the crane) 
that require special training to operate NOR does the document provide guidelines on how do electrical work
(such as repairing an HRS power supplies).   An example of what should be covered is how to safely reset the 
HRS power supply. (i.e. something that a scientist has
done in the past)

-
Our 2011 version of this document can be found at:
http://hallaweb.jlab.org/news/minutes/OSP/osp-27feb2011.pdf


For the high level outline, the name next to the section is just the led person for that part and is not 
expected to be the sole person working on that section.   In general, you should be working on the same 
sections you worked on in 2011.

High Level OUTLINE

I. Hall A Safety Document Overview [T.K.]

II. Beamline Equipment [D.H.]

III. Target Control (target details that are beyond the scope of a user should be covered elsewhere) [J.P.]

IV. High Resolution Spectrometers [J.S.]

V. HRS Detectors [B.W.]

VI. Slow Controls [J.G.]

VII. DAQ [A.C., B.M.]


VIII. Offline Software [O.H.]

IX. BigBite Spectrometer [D.H.]

-

The simplest way to update the document do, is grab your tex file, edit it and e-mail it back to me.
(if you know what section you editted last time, likely you just need to do it again adding a checklist)

http://hallaweb.jlab.org/github/halla-osp/src/

IF you have materials in word, please just send them to me and I will reformat into LaTeX.  I only ask that you send me any images or figures as separate, high quality files (e.g. one word doc along with the jpegs, eps, etc.)

-

Over the coming weeks, I will be updating the materials in that directory and keeping in sync with our github repository:

https://github.com/JeffersonLab/halla-osp.git

and anyone with a Jefferson Lab github account can access the materials there.

For unix/linux users; you can quickly pull a copy of the current materials by typing into a comment line:

git clone https://github.com/JeffersonLab/halla-osp.git

I would encourage anyone who knows git or who is want to learn git to setup a github account.   I just need to know your github your name so you can be added to the offical Jefferson Lab 

LaTeX Information
-----------------

The purpose of this package is to produce the Hall A OSP manual
in PDF and HTML formats. It contains the source of the text, 
the pictures and tools to make the documents. 

Top directory, static:
src/ - the source (LaTeX) and pictures
scripts/ - auxiliary scripts and the makefile
misc/ - miscellaneous documents - not used regularly

Top directory, dynamic:
run/ - work directory to create the documents

One can create the OSP document with different levels of
detail (noted as "infolevel"), the lower the value, 
the more slim is the document. All the levels contain the 
basic safety information for every system. Additional 
information depends on the level:
infolevel=0 - a short (1 page) description per system including 
              a picture for the layout if needed;
infolevel=1 - plus a description of the system's components;
infolevel=2 - plus a description of the procedures and pictures, 
              like MEDM windows in PNG format;  
infolevel=3 - plus the main principles of the devices' operation;
infolevel=4 - plus photographs and other large pictures
 
Producing the Documents:
-----------------------
In order to produce the OSP document with, say, infolevel=4 one 
has to:
1) ./scripts/config osp 4   (in the top directory)
   This creates a work directory run/ to produce the document 
2) cd run/
3) make pdf  - to create the document (osp.pdf) in PDF format 
4) make html - to create the document (in osp_html/) in HTML format

Browsing the PDF document: 
-------------------------
The PDF can be viewed with Acrobat Reader or xpdf (on Linux).
Both browsers can search for a given word. Also, the 
document contains hyper-references both inside the document
(so, one can jump forth and back to, say, the literature 
references), and also outside, using the standard URL.
In order to use the external references one may need 
to configure the browsers. Use the "Edit/Preference" button
on acroread. For xpdf you may need to copy /etc/xpdfrc
to ~/.xpdfrc and edit it, uncommenting the line
#urlCommand     "netscape -remote 'openURL(%s)'"
and commenting out the previous line.
Typically, xpdf/acroread tries to use an existing WWW browser
window and does not open a new window.

Instructions for Contributors (Obsolete)
----------------------------
A more detailed instruction can be found in
https://userweb.jlab.org/~gen/osp/