source: trunk/FACT++/MAINPAGE @ 10638

Last change on this file since 10638 was 10638, checked in by tbretz, 9 years ago
Updated with latest experiences installing FACT++ on Ubuntu 11.04 (natty)
File size: 9.1 KB
Line 
1// **************************************************************************
2/** @mainpage
3
4@brief FACT++ - The FACT slow control software
5
6@author thomas.bretz@epfl.ch et al.
7@version 1.0
8 
9@section install_sec Installation
10
11FACT++ can be downloaded from the svn by
12
13\verbatim
14   svn checkout https://fact.isdc.unige.ch/svn/trunk/FACT++ [localdir]
15\endverbatim
16
17it includes a dim version which is automatically compiled.
18
19For compilation use
20
21\verbatim
22   ./configure
23   make
24\endverbatim
25
26Check the \b ./configure options with \b --help. It might look
27confusing, but some features like FITS or QT4 can be switched off,
28if the necessary library is not at hand and the feature is not needed.
29For example, if the GUI is not needed its compilation can be switched
30off by disabling QT4 support with \b --without-qt4.
31
32If you use a custom built root version on your system without QT
33support, but have a distribution packe (e.g. debian package) with
34QT support available, you can give the path to root executables,
35for example, with <B>--with-rootsys=/usr/bin</B>. All other paths
36are extracted from subsequent calls to \b root-config.
37
38Running \b ./configure will take some time. It tries to really check
39carefully that everything needed is available on your system, so that you
40get errors before you start compilation.
41
42If \b ./configure fails please and you send a bug report please attach
43the file config.log.
44
45If \b make fails please and you send a bug report please attach
46the complete output of <B>make V=1</B>.
47
48\b Reminder: These programs use shared libraries, i.e. whenever you re-compile
49part of the project some of them might be re-compiled as well. As a result
50already running programs might crash unexpectedly! This is \b not a bug.
51
52In principle configure also supports
53
54\verbatim
55   make install
56\endverbatim
57
58which would install the package and the libraries in your system,
59although at the moment this is not recommended
60
61@subsection packages Required packages
62
63The following section gives a list of packages which were necessary after
64a fresh Ubuntu 11.04 installation. In addition to all the development
65packages the corresponding package with the library is needed.
66
67<i>Required</i>
68- subversion
69- gcc
70- g++
71- make
72- libreadline6-dev
73- libcfitsio3-dev
74- libccfits-dev
75- libmysqlclient-dev
76- libmysql++-dev
77- libboost-all-dev
78- libx11-dev
79
80<i>If you want 'did'</i>
81- lesstif2-dev
82
83<i>To compile the gui</i>
84- libqt4-dev
85- root (see section about root, currently recommended versions 5.18/00b-5.26/00e)
86
87<i>To create your own documentation</i>
88- graphviz
89- doxygen
90- help2man
91
92<i>For developers</i>
93- autoconf
94- autoconf-archive
95- libtool
96- qt4-designer
97
98<i>Some nice to have (FACT++)</i>
99- colorsvn
100- colorgcc
101- colordiff
102
103<i>Some nice to have (system)</i>
104- fte
105- efte
106- htop
107
108@section How to install root 5.26/00 on Ubuntu 11.04 (natty)
109
110- install gpp4.4, gcc4.4, g++4.4 (root does not compile with gcc4.5)
111- make links to hidden X11 libraries:
112<B><pre>
113cd /usr/local
114sudo ln -s x86_64-linux-gnu/libX* .
115</pre></B>
116- in the root source directory
117<B><pre>
118./configure --enable-qt --with-cc=gcc-4.4 --with-cxx=g++-4.4 --with-xrootd-opts=--syslibs=/usr/lib/x86_64-linux-gnu --prefix=/usr/local
119</pre></B>
120- \b make
121- <b>sudo make install</b>
122- pray
123- don't forget to set LD_LIBRARY_PATH correctly before you try to start the fact gui
124
125
126@section Demo Current demonstration programs
127
128- \b dserver2: A virtual board (A TCP/IP server). It is sending a
129  "hello" message after accepting a communication and then in 3s
130  intervals the current UTC time. The board can be set to state 1 or back
131  to state 0 (just as a demonstration)
132- \b dclient5: A control program. It accesses two viratual boards (start them
133  with 'dserver2 5000' and 'dserver2 4001') If both boards are connected the START
134  command can be issued to get them to state 'Running'. In this state
135  an asynchronous time stamp can be requested sending the TIME command.
136  to get back from Running to Connected use STOP.
137- \b test3: a dim console which allows to control all dim servers
138  by sending commands via the dim network.
139- Both, \b dclient5 and \b test3 accept the command line options -c0, -c1, -c2
140  to switch between different console types (or no console in the case of
141  \b dclient5). In the console you get help with 'h' and the available
142  command with 'c' You get the avilable command-line options with --help
143
144First start the two dserver2s. Then start a dclient5 (if you want it
145with console use one of the -c options) and a test3 console (with one
146of the console options if you like) you can now control the hardware
147boards with the START, STOP and TIME commands or stop (Ctrl-C) and
148start one of the programs to see what's happening. In the test3 case
149you first have to \e cd to the server to which you want to talk by \b
150DATA_LOGGER. Don't forget to start \b dns if you want to control dclient5
151from test3 via Dim.
152
153@section dimremarks Remarks about Dim usage
154
155To be able to write all received data directly to the FITS files,
156padding has been disabled calling dic_diable_padding() and
157dis_disable_padding(). This is done in our own error handler
158DimErrorRedirecter. Since this should be one of the first
159objects created in any environment it is quite save. However, every
160Dim client or server in our network which does not use the
161DimErrorRedirecter \b must call these two functions as early as
162possible.
163
164@section exitcodes Exit Code
165@section newcommand How to add a new command?
166@section description How to add help textes to services and commands?
167
168@section addtab How to add a new tab in the gui?
169
170Do the following steps in exactly this order:
171- Insert the new page from the context menu of the QTabWidget
172- Copy the QDockWidget from one of the other tabs to the clipboard
173- Paste the copied QDockWidget and add it to the new tab (only the tab should be highlited)
174- Now click on the context menu of the region in the tab (QWidget) and change the layout to grid layout
175
176
177@section Documentation
178
179Each program has an extensive help text (except the examples). This help text can
180be displayed with the \b --help option. For each program a man-page is automatically
181created (from the help-output), which (at the moment) can be accessed with <B>man
182FILE</B>.
183
184@section References
185
186@subsection generalref General references
187- <A HREF="http://www.cplusplus.com/reference">The C++ reference</A>
188- <A HREF="http://www.boost.org">boost.org: The boost C++ libraries</A>
189- <A HREF="http://www.highscore.de/cpp/boost/titelseite.html">Boris Sch&auml;ling: Die Boost C++ Bibliotheken</A>
190- <A HREF="http://cnswww.cns.cwru.edu/php/chet/readline/rltop.html">GNU Readline</A>
191- <A HREF="http://www.gnu.org/software/ncurses">GNU Ncurses</A>
192- <A HREF="http://dim.web.cern.ch/">Distributed Information Management (DIM)</A>
193- <A HREF="http://dim.web.cern.ch/dim/cpp_doc/DimCpp.html">Distributed Information Management (DIM) - C++ reference</A>
194- <A HREF="http://qt.nokia.com/">Qt homepage</A>
195- <A HREF="http://qt.nokia.com/downloads/">Qt downloads</A>
196
197@subsection boostref Boost references
198- <A HREF="http://www.boost.org/doc/libs/1_45_0/libs/bind/bind.html">boost::bind (V1.45.0)</A>
199- <A HREF="http://www.boost.org/doc/libs/1_45_0/doc/html/boost_asio.html">boost asio (V1.45.0)</A>
200- <A HREF="http://www.boost.org/doc/libs/1_45_0/doc/html/date_time.html">boost date_time (V1.45.0)</A>
201- <A HREF="http://www.boost.org/doc/libs/1_45_0/doc/html/program_options.html">boost program_options (V1.45.0)</A>
202- <A HREF="http://www.boost.org/doc/libs/1_45_0/libs/filesystem/v3/doc/index.htm">boost filesystem (V1.45.0)</A>
203- <A HREF="http://www.boost.org/doc/libs/1_45_0/libs/regex/doc/html/index.html">boost regex (V1.45.0)</A>
204- <A HREF="http://www.boost.org/doc/libs/1_45_0/libs/system/doc/index.html">boost system (error codes) (V1.45.0)</A>
205- <A HREF="http://www.boost.org/doc/libs/1_45_0/doc/html/thread.html">boost thread (V1.45.0)</A>
206- <A HREF="http://www.boost.org/doc/libs/1_45_0/libs/conversion/lexical_cast.htm">boost lexical_cast (V1.45.0)</A>
207
208@subsection fitsref FITS references
209- <A HREF="http://heasarc.gsfc.nasa.gov/docs/heasarc/fits.html">The FITS data format</A>
210- <A HREF="http://heasarc.gsfc.nasa.gov/fitsio/">FITS homepage</A>
211- <A HREF="http://heasarc.gsfc.nasa.gov/fitsio/CCfits/">CCfits - A C++ wrapper to cfitsio</A>
212- <A HREF="http://heasarc.gsfc.nasa.gov/docs/software/ftools/fv/">fv - A very simple viewer to FITS file contents</A>
213
214@subsection qtroot How to integrate root in QT?
215
216- <A HREF="http://doc.trolltech.com/4.3/designer-creating-custom-widgets.html">QT4: Creating custom widgets</A>
217- <A HREF="http://root.cern.ch/download/doc/26ROOTandQt.pdf">root: QT integration (pdf)</A>
218
219
220@section Available programs
221
222- dns: Dim's domain-name-server (needed for any communication between Dim servers and clients)
223- did: A simple graphical interface to analyse everything in a Dim network
224
225@section Examples
226
227There are a few example programs
228- \b ./argv: Example for usage of the class Configure (command line options, configuration file)
229- \b ./time: Example for the usage of the class Time (time input/output, conversion)
230- \b ./log, \b ./logtime: A simple Dim-Service/-Client combination using MessageDimRX/MessageDimTX
231
232**/
233// **************************************************************************
Note: See TracBrowser for help on using the repository browser.