Project

General

Profile

Analysis How-To » History » Version 7

Richard Trotta, 04/30/2019 01:43 PM

1 1 Richard Trotta
h1. Analysis How-To
2
3
{{>toc}}
4 2 Richard Trotta
5
h2. How should I analyze data?
6
7
* Doing things locally will always be your best option for actual analysis. 
8
** Fork a repo of hallc_replay_kaonlt %{color:red}and% UTIL_KAONLT for your own custom version that you can play with
9
** !!
10
11
* Once you have forked the repo, clone hallc_replay_kaonlt to a local directory
12 5 Richard Trotta
<pre><code class="bash">
13
$USER> git clone https://github.com/USER/hallc_replay_kaonlt.git
14
</code></pre>
15 1 Richard Trotta
16
* Now the tricky part, UTIL_KAONLT is a submodule of hallc_replay_kaonlt so some intermediate steps will need to be made
17 5 Richard Trotta
<pre><code class="bash">
18
$USER> git submodule --init --recursive
19
</code></pre>
20 1 Richard Trotta
** Check .gitmodules to make sure submod is listed
21 5 Richard Trotta
<pre><code class="bash">
22
[submodule "UTIL_KAONLT"]
23
     path = UTIL_KAONLT
24
     url = https://github.com/USER/UTIL_KAONLT
25
     branch = <branchname>
26
</code></pre>
27
<pre><code class="bash">
28
$USER> git submodule update --recursive --remote
29
</code></pre>
30 2 Richard Trotta
31
* If HEAD is detached (check with git branch -a)
32 6 Richard Trotta
<pre><code class="bash">
33
$USER> git branch -a
34
* (HEAD detached at ###)
35
</code></pre>
36 1 Richard Trotta
37
* Check if head is really detached
38 6 Richard Trotta
<pre><code class="bash">
39
$USER> git symbolic-ref HEAD
40
fatal: ref HEAD is not a symbolic ref
41
</code></pre>
42
<pre><code class="bash">
43
$USER> git remote update
44
Fetching origin
45
</code></pre>
46 1 Richard Trotta
47
* Change to master branch
48 6 Richard Trotta
<pre><code class="bash">
49
$USER> git checkout master
50
Switched to branch 'master'
51
Your branch is up-to-date with 'origin/master'
52
</code></pre>
53 1 Richard Trotta
54
* Pull and check branch again, everything should be set!
55 6 Richard Trotta
<pre><code class="bash">
56
$USER> git pull
57
Already up-to-date
58
$USER> git branch -a
59
* master
60
</code></pre>
61 1 Richard Trotta
62
* Now that we have our repo locally we should set it up to pull from the “main” JeffersonLab version
63
64
* First check your remote “origin” repo (this is where you will push to)
65 6 Richard Trotta
<pre><code class="bash">
66
$USER> git remote -v
67
origin https://github.com/USER/hallc_replay_kaonlt.git (fetch)
68
origin https://github.com/USER/hallc_replay_kaonlt.git (push)
69
</code></pre>
70 2 Richard Trotta
71
* Next lets set up the “upstream” which is the JeffersonLab repo (DO NOT push HERE)
72 6 Richard Trotta
<pre><code class="bash">
73
$USER> git remote add upstream https://github.com/JeffersonLab/hallc_replay_kaonlt.git
74
75
$USER> git remote -v
76
origin https://github.com/USER/hallc_replay_kaonlt.git (fetch)
77
origin https://github.com/USER/hallc_replay_kaonlt.git (push)
78
upstream https://github.com/JeffersonLab/hallc_replay_kaonlt.git (fetch)
79
upstream https://github.com/JeffersonLab/hallc_replay_kaonlt.git (push)
80
</code></pre>
81 2 Richard Trotta
82
* You will not be able to push to upstream unless you’re Stephen or me so don’t worry too much. Just be cautious.
83
84
* A similar procedure can be performed with UTIL_KAONLT
85
86
* Finally, let's talk about branches. Let’s add the develop branch to our local system…
87
** First create a branch locally called develop and change to it
88 7 Richard Trotta
<pre><code class="bash">
89
$USER> git branch develop
90 1 Richard Trotta
91 7 Richard Trotta
$USER> git checkout develop
92
M  UTIL_KAONLT
93
M  UTIL_OL
94
Switched to branch 'develop'
95
</code></pre>
96
97 1 Richard Trotta
* Now simply pull develop
98 7 Richard Trotta
<pre><code class="bash">
99
$USER> git pull origin develop
100
</code></pre>
101 2 Richard Trotta
102
* To create a new branch you must first create it in github
103
** !!
104
105
* Then simply repeat the steps for setting up a branch from the previous slide
106
107
h2. Replaying
108
109
* Before we can analyze we must replay. This should be done in the farm to save yourself time and local cpu effort.  The easiest way is to do a batch job submission, but this comes with some prep work.
110
111
* Before a batch submission, I highly encourage two preliminary steps
112
## Do all debugging of replays locally, once this works move to the farm
113 3 Richard Trotta
## Once on the farm you have two options; your ifarm version or our group (discussed soon).  This is for final debugging purposes to assure everything works in the farm, then you can submit a batch job. Save the root files in /volatile/hallc/c-kaonlt/<USER> (note: volatile is NOT backed up)
114
115
* There is a batch script I have created and Stephen as changed with the help of Brad to assure it will not mess things up.  Again, I highly recommend the two above steps before moving onto this script or you will be wasting time and resources.
116
117
* Your final batch job submissions can be saved directly to tape.
118
119
h2. Group environment
120
121
* You can do replays under your farm directory or you can use our group environment.
122
123
* We have set up a group environment with a version of our repo that currently mimics the cdaq as close as possible (although an updated hcana is used).
124
** This group environment is under /u/group/c-kaonlt
125
** I have made a directory USERS which you can use for person replay scripts and environments. DO NOT change any replays that are not under USERS without contacting Stephen or me first.
126
** There is an hcana already set up here, use this for any group replays. If you would like to use a different version of hcana please use your farm directory. If I find a hcana in USERS I will destroy it.
127
128
* You may have issues with hcana, make sure you are in the JLab software environment version 2.1
129
** source /site/12gev_phys/softenv.csh 2.1 (or .sh if using bash)
130
131
* The group environment has a 100 gb quota and is backed up. This means two important things…
132
## DO NOT save root files here! Ever!
133
## It’s backed up so its good for important calibration work (*wink *wink)
134
135
* Upon the request of Stephen, any improper use of this environment will incur a penalty of one beer/bottle of single malt or an owl shift (depending upon severity).
136
137
h2. Writing to tape
138
139
* Writing to tape info, read - https://scicomp.jlab.org/docs/write-through-cache.
140
141
* In your batch script, specify OUTPUT_FILE:/cache/hallc/kaonlt/USER/ROOTfiles/FILE.
142
** Material in /cache is automatically copied to tape after some time if it is static
143
** Small files (~1 MB) will not be backed up on tape
144 4 Richard Trotta
** Once copied to tape, you can view the tape stub (NOT the file itself) under /mss/hallc/kaonlt/…
145
** The tape does not handle overwriting well so if submit a job you must create a new "pass" directory…
146
*** -->jput ... file.root /mss/hallc/kaonlt/USER/ROOTfiles/pass1/
147
** The tape has FAR more space than we could get through so do not worry about "filling" it
148
** Write to tape once you're happy with your code... just do it correctly
149
150
h2. Few more words of warning
151
152
* Do not write analysis to tape unless you are 100% certain it works correctly (and you don't want to repeat it very soon).
153
154
* For farm jobs some info is included below -
155
** See https://scicomp.jlab.org/docs/text_command_file for info on commands	
156
** Do not set CPU above 1 (it will slow your job down in the queue and hcana is single threaded anyway so you gain nothing)
157
** Farm/Auger project: c-kaonlt
158 1 Richard Trotta
** For TEMPORARY output, write to volatile - /volatile/hallc/c-kaonlt/USER, this space is NOT backed up!
159
** Specify the FULL path to this in your symbolic link
160
** Make sure relvant directories are created
161
162
* You can use our work environment (/work/hallc/kaon), but this is not backed up and I will no be setting up an environment similar to group there. It’s a good place to put personal scripts if you don’t want to take up space in your farm directory.