source: branches/start/MagicSoft/CvsDoku/welcome.html@ 13369

Last change on this file since 13369 was 285, checked in by harald, 25 years ago
Start point for the CVS control of the documentation for CVS usage in the MAGIC software development. There is at the moment only one html file (welcome.html) to control. This file contains all information at this time. All the best....
File size: 7.9 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.51 [en] (X11; I; Linux 2.2.5 i586) [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;&nbsp;&nbsp;
37<a href="http://www.cyclic.com">http://www.cyclic.com</a>
38<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
39<a href="http://www.loria.fr/~molli/cvs-index.html">http://www.loria.fr/~molli/cvs-index.html</a>
40<br>&nbsp;
41<p>
42<hr WIDTH="100%">
43<br><font color="#FF0000"><font size=+2>Repository</font></font>
44<p>The single copy of the master source for all MAGIC software is held
45in the repository on the alpha cluster in Max-Planck-Institut f&uuml;r
46Physik in Munich. As a developer you must declare the
47<br>environment variable
48<p>setenv&nbsp;&nbsp; CVSROOT&nbsp; /hd60/CvsRepository/&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
49for tcsh (use the syntax of your shell)
50<br>&nbsp;
51<p>All the Software is inside the directory. The structure of the sub directories
52is following one:
53<br>&nbsp;
54<br>&nbsp;
55<table BORDER=0 CELLPADDING=10 COLS=7 WIDTH="100%" NOSAVE >
56<tr>
57<td><font size=+3><a href="#Anchor_MagicSoft">MagicSoft</a></font></td>
58
59<td><font size=+3><a href="#Anchor_CvsDoku">CvsDoku</a></font></td>
60
61<td></td>
62
63<td></td>
64
65<td></td>
66
67<td></td>
68
69<td></td>
70</tr>
71
72<tr>
73<td></td>
74
75<td><font size=+3><a href="#Anchor_Simulation">Simulation</a></font></td>
76
77<td><font size=+3><a href="#Anchor_Corsika">Corsika</a></font></td>
78
79<td><font size=+3>mmcs</font></td>
80
81<td></td>
82
83<td></td>
84
85<td></td>
86</tr>
87
88<tr>
89<td></td>
90
91<td></td>
92
93<td><font size=+3><a href="#Anchor_Detector">Detector</a></font></td>
94
95<td><font size=+3><a href="#Anchor_Reflector">Reflector</a></font></td>
96
97<td></td>
98
99<td></td>
100
101<td></td>
102</tr>
103
104<tr>
105<td></td>
106
107<td></td>
108
109<td></td>
110
111<td><font size=+3><a href="#Anchor_include-GENERAL">include-GENERAL</a></font></td>
112
113<td></td>
114
115<td></td>
116
117<td></td>
118</tr>
119
120<tr>
121<td></td>
122
123<td></td>
124
125<td></td>
126
127<td><font size=+3><a href="#Anchor_include-CORSIKA">include-CORSIKA</a></font></td>
128
129<td></td>
130
131<td></td>
132
133<td></td>
134</tr>
135
136<tr>
137<td></td>
138
139<td></td>
140
141<td></td>
142
143<td><font size=+3><a href="#Anchor_include-MC">include-MC</a></font></td>
144
145<td></td>
146
147<td></td>
148
149<td></td>
150</tr>
151
152<tr>
153<td></td>
154
155<td><font size=+3><a href="#Anchor_include-Classes">include-Classes</a></font></td>
156
157<td></td>
158
159<td></td>
160
161<td></td>
162
163<td></td>
164
165<td></td>
166</tr>
167
168<tr>
169<td></td>
170
171<td></td>
172
173<td></td>
174
175<td></td>
176
177<td></td>
178
179<td></td>
180
181<td></td>
182</tr>
183
184<tr>
185<td></td>
186
187<td><font size=+3><a href="#Anchor_Analysis">Analysis</a></font></td>
188
189<td></td>
190
191<td></td>
192
193<td></td>
194
195<td></td>
196
197<td></td>
198</tr>
199
200<tr>
201<td></td>
202
203<td></td>
204
205<td></td>
206
207<td></td>
208
209<td></td>
210
211<td></td>
212
213<td></td>
214</tr>
215</table>
216
217<hr WIDTH="100%">
218<br>&nbsp;
219<h3>
220<font color="#FF0000"><font size=+2>Detail of subdirectories in the repository</font></font></h3>
221
222<p><br><a NAME="Anchor_MagicSoft"></a><font color="#CC33CC"><font size=+2>MagicSoft</font></font>
223<p>In this directory of the cvs-repository you find all software that is
224developed for MAGIC using CVS.
225<br>This directory contain four sub directories, CvsDoku, Simulation, Analysis
226and include-Classes.
227<br>&nbsp;
228<blockquote><a NAME="Anchor_CvsDoku"></a><font color="#CC33CC"><font size=+2>CvsDoku</font></font>
229<p>In this directory of the cvs-repository you find some html pages like
230the one you are looking at the moment. This documentation is written as
231a guideline for MAGIC developers using the CVS tool. Also the documentation
232for CVS usage is using CVS!!
233<p><a NAME="Anchor_Simulation"></a><font color="#CC66CC"><font size=+2>Simulation</font></font>
234<br>For MAGIC a lot of programs were developed to simulate the behavior
235of Air Showers, the Mirrors and the Camera. All this things you need for
236simulation is inside this directory.
237<br>&nbsp;
238<blockquote><a NAME="Anchor_Corsika"></a><font color="#CC33CC"><font size=+2>Corsika</font></font>
239<br>All things needed for the simulation of AirShowers. All this simulation
240are based on the CORSIKA program of the KASCADE group in Karlsruhe.
241<br>&nbsp;
242<p><a NAME="Anchor_Detector"></a><font color="#CC33CC"><font size=+2>Detector</font></font>
243<br>&nbsp;Every thing that is needed to transfer the simulated events to
244the common raw data forrmat. There are a lot of different tools inside
245this directory, mainly based on the work of Jose Carlos Gonzales.
246<br>&nbsp;
247<blockquote><a NAME="Anchor_Reflector"></a><font color="#CC33CC"><font size=+2>Reflector</font></font>
248<br>&nbsp;Here you find the source code of the reflector program. This
249is written to read the CORSIKA (mmcs) output. With this data you can simulate
250the behaviour of the MAGIC mirrors. But to compile and run the program
251some other subdirectories are needed.
252<p><a NAME="Anchor_include-CORSIKA"></a><font color="#CC33CC"><font size=+2>include-CORSIKA</font></font>
253<br>Here you can find a implementation to read the CORSIKA output. This
254classes are needed by the reflector program.
255<p><a NAME="Anchor_include-MC"></a><font color="#CC33CC"><font size=+2>include-MC</font></font>
256<br>Here you can find a implementation to write and read the output of
257the reflector program. This classes are needed by the reflector and the
258camera program.
259<p><a NAME="Anchor_include-GENERAL"></a><font color="#CC33CC"><font size=+2>include-GENERAL</font></font>
260<br>Here you can find some header file that are needed by reflector and
261camera. For example the declaration of the runlib is found here.
262<br>&nbsp;</blockquote>
263</blockquote>
264<a NAME="Anchor_include-Classes"></a><font color="#CC66CC"><font size=+2>include-Classes</font></font>
265<p>In this directory you can find all Classes (C++ and hopefully OOP )
266that are used for simulation and for analysis. An example is the RawDataFormat
267used in the Analysis and the Camera programs.
268<p><a NAME="Anchor_Analysis"></a><font color="#CC66CC"><font size=+2>Analysis</font></font>
269<p>In this directory you can find all Programs to analyze data of MAGIC.
270Here you will find tools to look on single Events, to calculate the Hillas
271parameters and to find the periodicity of one special source. (But all
272this is still under construction!!!! Here the must development is needed
273in the future!!!)
274<br>&nbsp;</blockquote>
275
276<br>&nbsp;
277</body>
278</html>
Note: See TracBrowser for help on using the repository browser.