source: trunk/MagicSoft/CvsDoku/welcome.html@ 309

Last change on this file since 309 was 309, checked in by magiccvs, 26 years ago
some more directories in the dokumentation.
File size: 9.2 KB
Line 
1<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
2<html>
3<head>
4 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
5 <meta name="GENERATOR" content="Mozilla/4.5 [en] (X11; I; Linux 2.0.36 i686) [Netscape]">
6 <title> CVS for Magic Software Development </title>
7</head>
8<body>
9<! This is my first attempt at my personal WWW home page. ><! It has become necessary to create this mainly because my ><! hotlist has grown into something so extremely large that it ><! is impossible to find a way through it any longer... >
10<center>
11<h1>
12CVS for Magic Software Development</h1></center>
13
14<hr>
15<h3>
16<font color="#FF0000"><font size=+2>Introduction</font></font></h3>
17More than one software developer are involved in the progress of Software
18for the MAGIC telescope. Because the developers are distributed all over
19Europe, a version control system is needed. There exists more than one
20possibility of such version control systems, but for the beginning we take
21CVS ( Concurrent Versions System ).
22<p>CVS is a version control system, which allows you to keep old versions
23of files (usually source code), keep a log of who, when, and why changes
24occurred, etc., like RCS or SCCS. Unlike the simpler systems, CVS does
25not just operate on one file at a time or one directory at a time, but
26operates on hierarchical collections of directories consisting of version
27controlled files. CVS helps to manage releases and to control the concurrent
28editing of source files among multiple authors. CVS allows triggers to
29enable/log/control various operations and works well over a wide area network.
30<p>CVS keeps a single copy of the master sources. This copy is called the
31source ``repository''; it contains all the information to permit extracting
32previous software releases at any time based on either a symbolic revision
33tag, or a date in the past.
34<p>For CVS updates, more information on documentation,&nbsp; software related
35to CVS, development of CVS, and more, see:
36<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="http://www.cyclic.com">http://www.cyclic.com</a>
37<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <a href="http://www.loria.fr/~molli/cvs-index.html">http://www.loria.fr/~molli/cvs-index.html</a>
38<br>&nbsp;
39<p>
40<hr WIDTH="100%">
41<br><font color="#FF0000"><font size=+2>Repository</font></font>
42<p>The single copy of the master source for all MAGIC software is held
43in the repository on a single (security reasons) linux computer in Max-Planck-Institut
44f&uuml;r Physik in Munich. As a remote developer you must declare the environment
45variable.
46<p><b><font color="#33FF33">setenv&nbsp;&nbsp; CVSROOT&nbsp; :ext:pchegra4.mppmu.mpg.de:/CvsRepository&nbsp;</font></b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
47for tcsh (use the syntax of your shell)
48<p>The access from other computers is still under construction and tests.
49Wait for the green light, very soon.
50<p>All the Software is inside the directory. The structure of the sub directories
51is following one:
52<br>&nbsp;
53<br>&nbsp;
54<table BORDER CELLPADDING=10 COLS=7 WIDTH="100%" NOSAVE >
55<tr>
56<td><font size=+1><a href="#Anchor_MagicSoft">MagicSoft</a></font></td>
57
58<td><font size=+1><a href="#Anchor_CvsDoku">CvsDoku</a></font></td>
59
60<td></td>
61
62<td></td>
63
64<td></td>
65
66<td></td>
67
68<td></td>
69</tr>
70
71<tr>
72<td></td>
73
74<td><font size=+1><a href="#Anchor_Simulation">Simulation</a></font></td>
75
76<td><font size=+1><a href="#Anchor_Corsika">Corsika</a></font></td>
77
78<td><font size=+1>mmcs</font></td>
79
80<td></td>
81
82<td></td>
83
84<td></td>
85</tr>
86
87<tr>
88<td></td>
89
90<td></td>
91
92<td><font size=+1><a href="#Anchor_Detector">Detector</a></font></td>
93
94<td><font size=+1><a href="#Anchor_Reflector">Reflector</a></font></td>
95
96<td></td>
97
98<td></td>
99
100<td></td>
101</tr>
102
103<tr>
104<td></td>
105
106<td></td>
107
108<td></td>
109
110<td><font size=+1><a href="#anchor_Camera">Camera</a></font></td>
111
112<td></td>
113
114<td></td>
115
116<td></td>
117</tr>
118
119<tr>
120<td></td>
121
122<td></td>
123
124<td></td>
125
126<td><font size=+1><a href="#Anchor_include-GENERAL">include-GENERAL</a></font></td>
127
128<td></td>
129
130<td></td>
131
132<td></td>
133</tr>
134
135<tr>
136<td></td>
137
138<td></td>
139
140<td></td>
141
142<td><font size=+1><a href="#Anchor_include-CORSIKA">include-CORSIKA</a></font></td>
143
144<td></td>
145
146<td></td>
147
148<td></td>
149</tr>
150
151<tr>
152<td></td>
153
154<td></td>
155
156<td></td>
157
158<td><font size=+1><a href="#Anchor_include-MC">include-MC</a></font></td>
159
160<td></td>
161
162<td></td>
163
164<td></td>
165</tr>
166
167<tr>
168<td></td>
169
170<td></td>
171
172<td></td>
173
174<td><font size=+1><a href="#Anchor_include-MTrigger">include-MTrigger</a></font></td>
175
176<td></td>
177
178<td></td>
179
180<td></td>
181</tr>
182
183<tr>
184<td></td>
185
186<td><font size=+1><a href="#Anchor_include-Classes">include-Classes</a></font></td>
187
188<td></td>
189
190<td></td>
191
192<td></td>
193
194<td></td>
195
196<td></td>
197</tr>
198
199<tr>
200<td></td>
201
202<td></td>
203
204<td></td>
205
206<td></td>
207
208<td></td>
209
210<td></td>
211
212<td></td>
213</tr>
214
215<tr>
216<td></td>
217
218<td><font size=+1><a href="#Anchor_Analysis">Analysis</a></font></td>
219
220<td></td>
221
222<td></td>
223
224<td></td>
225
226<td></td>
227
228<td></td>
229</tr>
230
231<tr NOSAVE>
232<td NOSAVE></td>
233
234<td></td>
235
236<td></td>
237
238<td></td>
239
240<td></td>
241
242<td></td>
243
244<td></td>
245</tr>
246</table>
247
248<hr WIDTH="100%">
249<br>&nbsp;
250<h3>
251<font color="#FF0000"><font size=+2>Detail of subdirectories in the repository</font></font></h3>
252
253<p><br><a NAME="Anchor_MagicSoft"></a><font color="#CC33CC"><font size=+2>MagicSoft</font></font>
254<p>In this directory of the cvs-repository you find all software that is
255developed for MAGIC using CVS.
256<br>This directory contain four sub directories, CvsDoku, Simulation, Analysis
257and include-Classes.
258<br>&nbsp;
259<blockquote><a NAME="Anchor_CvsDoku"></a><font color="#CC33CC"><font size=+2>CvsDoku</font></font>
260<p>In this directory of the cvs-repository you find some html pages like
261the one you are looking at the moment. This documentation is written as
262a guideline for MAGIC developers using the CVS tool. Also the documentation
263for CVS usage is using CVS!!
264<p><a NAME="Anchor_Simulation"></a><font color="#CC66CC"><font size=+2>Simulation</font></font>
265<br>For MAGIC a lot of programs were developed to simulate the behavior
266of Air Showers, the Mirrors and the Camera. All this things you need for
267simulation is inside this directory.
268<br>&nbsp;
269<blockquote><a NAME="Anchor_Corsika"></a><font color="#CC33CC"><font size=+2>Corsika</font></font>
270<br>All things needed for the simulation of AirShowers. All this simulation
271are based on the CORSIKA program of the KASCADE group in Karlsruhe.
272<br>&nbsp;
273<p><a NAME="Anchor_Detector"></a><font color="#CC33CC"><font size=+2>Detector</font></font>
274<br>&nbsp;Every thing that is needed to transfer the simulated events to
275the common raw data forrmat. There are a lot of different tools inside
276this directory, mainly based on the work of Jose Carlos Gonzales.
277<br>&nbsp;
278<blockquote><a NAME="Anchor_Reflector"></a><font color="#CC33CC"><font size=+2>Reflector</font></font>
279<br>&nbsp;Here you find the source code of the reflector program. This
280is written to read the CORSIKA (mmcs) output. With this data you can simulate
281the behaviour of the MAGIC mirrors. But to compile and run the program
282some other subdirectories are needed.
283<p><a NAME="anchor_Camera"></a><font color="#CC66CC"><font size=+2>Camera</font></font>
284<p><font color="#330000">&nbsp;In this directory are all the files of the
285camera program. The camera program is calculating the response of each
286photomultiplier of the camera. At the end we get the number of ADC count
287for each time slice of each pixel. In the previous there were also some
288smaller calculations of the camera pixels in it.</font>
289<p><a NAME="Anchor_include-CORSIKA"></a><font color="#CC33CC"><font size=+2>include-CORSIKA</font></font>
290<br>Here you can find a implementation to read the CORSIKA output. This
291classes are needed by the reflector program.
292<p><a NAME="Anchor_include-MC"></a><font color="#CC33CC"><font size=+2>include-MC</font></font>
293<br>Here you can find a implementation to write and read the output of
294the reflector program. This classes are needed by the reflector and the
295camera program.
296<p><a NAME="Anchor_include-GENERAL"></a><font color="#CC33CC"><font size=+2>include-GENERAL</font></font>
297<br>Here you can find some header file that are needed by reflector and
298camera. For example the declaration of the runlib is found here.
299<br>&nbsp;
300<p><a NAME="Anchor_include-MTrigger"></a><font color="#CC66CC"><font size=+2>include-MTrigger</font></font>
301<br>Studies of the trigger behaviour are very fundamental things. The simulation
302of the trigger is a part of the camera program. All the methods are put
303in the Classes (called MTRigger ) in this directory.
304<br>&nbsp;</blockquote>
305</blockquote>
306<a NAME="Anchor_include-Classes"></a><font color="#CC66CC"><font size=+2>include-Classes</font></font>
307<p>In this directory you can find all Classes (C++ and hopefully OOP )
308that are used for simulation and for analysis. An example is the RawDataFormat
309used in the Analysis and the Camera programs. The Classes are MRawPixel,
310MRawEvt, MRawMc .....
311<p><a NAME="Anchor_Analysis"></a><font color="#CC66CC"><font size=+2>Analysis</font></font>
312<p>In this directory you can find all Programs to analyze data of MAGIC.
313Here you will find tools to look on single Events, to calculate the Hillas
314parameters and to find the periodicity of one special source. (But all
315this is still under construction!!!! Here the must development is needed
316in the future!!!)
317<br>&nbsp;</blockquote>
318
319<br>&nbsp;
320</body>
321</html>
Note: See TracBrowser for help on using the repository browser.