source: trunk/FACT++/MAINPAGE @ 10539

Last change on this file since 10539 was 10539, checked in by tbretz, 9 years ago
Added references to Qt
File size: 8.7 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
38Hint: Sometimes installing root from packages doesn't work as
39expected (at least on my Ubuntu). It might be necessary to
40find some of the root packages with the libraries giving trouble
41and reinstall them after the root package was already installed.
42
43Remark: root 5.24 und root 5.26 seem to have issues. Although there
44are some X errors when starting, it seems to work quite nice with
455.18/00b and 5.26/00e
46
47Running \b ./configure will take some time. It tries to really check
48carefully that everything needed is available on your system, so that you
49get errors before you start compilation.
50
51If \b ./configure fails please and you send a bug report please attach
52the file config.log.
53
54If \b make fails please and you send a bug report please attach
55the complete output of <B>make V=1</B>.
56
57In principle configure also supports
58
59\verbatim
60   make install
61\endverbatim
62
63which would install the package and the libraries in your system,
64although at the moment this is not recommended
65
66@subsection packages Required packages
67
68If you find a new package needed for installation please don't
69hesitate to report it, so that it can be added to the list below.
70
71Packages known to be needed to configure and compile FACT++
72
73<B>Dim:</B>
74- lesstif2, lesstif2-dev (Xm.h, needed to compile did)
75
76<B>Libraries:</B>
77- libreadline, libreadline-dev
78- boost, boost-dev (>=V1.40, all)
79- mysql++, mysql++-dev
80- libcfits, libcfitsio-dev
81- libccfits, libccfits-dev                                       
82
83<B>For GUI support:</B>
84- libqt4-core
85- libqt4-dev
86- root
87
88<B>Documentation:</B>
89- doxygen
90- graphviz
91- help2man
92- groff
93- ps2pdf
94
95<B>Only for maintainers:</B>
96- autoconf (automake, autotools-dev, m4)
97- autoconf-archive
98- libtool (contains libtoolize
99- colorsvn (recommended)
100- colorgcc (recommended)
101- qt4-designer
102
103@section Demo Current demonstration programs
104
105- \b dserver2: A virtual board (A TCP/IP server). It is sending a
106  "hello" message after accepting a communication and then in 3s
107  intervals the current UTC time. The board can be set to state 1 or back
108  to state 0 (just as a demonstration)
109- \b dclient5: A control program. It accesses two viratual boards (start them
110  with 'dserver2 5000' and 'dserver2 4001') If both boards are connected the START
111  command can be issued to get them to state 'Running'. In this state
112  an asynchronous time stamp can be requested sending the TIME command.
113  to get back from Running to Connected use STOP.
114- \b test3: a dim console which allows to control all dim servers
115  by sending commands via the dim network.
116- Both, \b dclient5 and \b test3 accept the command line options -c0, -c1, -c2
117  to switch between different console types (or no console in the case of
118  \b dclient5). In the console you get help with 'h' and the available
119  command with 'c' You get the avilable command-line options with --help
120
121First start the two dserver2s. Then start a dclient5 (if you want it
122with console use one of the -c options) and a test3 console (with one
123of the console options if you like) you can now control the hardware
124boards with the START, STOP and TIME commands or stop (Ctrl-C) and
125start one of the programs to see what's happening. In the test3 case
126you first have to \e cd to the server to which you want to talk by \b
127DATA_LOGGER. Don't forget to start \b dns if you want to control dclient5
128from test3 via Dim.
129
130@section dimremarks Remarks about Dim usage
131
132To be able to write all received data directly to the FITS files,
133padding has been disabled calling dic_diable_padding() and
134dis_disable_padding(). This is done in our own error handler
135DimErrorRedirecter. Since this should be one of the first
136objects created in any environment it is quite save. However, every
137Dim client or server in our network which does not use the
138DimErrorRedirecter \b must call these two functions as early as
139possible.
140
141@section exitcodes Exit Code
142@section newcommand How to add a new command?
143@section description How to add help textes to services and commands?
144
145@section addtab How to add a new tab in the gui?
146
147Do the following steps in exactly this order:
148- Insert the new page from the context menu of the QTabWidget
149- Copy the QDockWidget from one of the other tabs to the clipboard
150- Paste the copied QDockWidget and add it to the new tab (only the tab should be highlited)
151- Now click on the context menu of the region in the tab (QWidget) and change the layout to grid layout
152
153
154@section Documentation
155
156Each program has an extensive help text (except the examples). This help text can
157be displayed with the \b --help option. For each program a man-page is automatically
158created (from the help-output), which (at the moment) can be accessed with <B>man
159FILE</B>.
160
161@section References
162
163@subsection generalref General references
164- <A HREF="http://www.cplusplus.com/reference">The C++ reference</A>
165- <A HREF="http://www.boost.org">boost.org: The boost C++ libraries</A>
166- <A HREF="http://www.highscore.de/cpp/boost/titelseite.html">Boris Sch&auml;ling: Die Boost C++ Bibliotheken</A>
167- <A HREF="http://cnswww.cns.cwru.edu/php/chet/readline/rltop.html">GNU Readline</A>
168- <A HREF="http://www.gnu.org/software/ncurses">GNU Ncurses</A>
169- <A HREF="http://dim.web.cern.ch/">Distributed Information Management (DIM)</A>
170- <A HREF="http://dim.web.cern.ch/dim/cpp_doc/DimCpp.html">Distributed Information Management (DIM) - C++ reference</A>
171- <A HREF="http://qt.nokia.com/">Qt homepage</A>
172- <A HREF="http://qt.nokia.com/downloads/">Qt downloads</A>
173
174@subsection boostref Boost references
175- <A HREF="http://www.boost.org/doc/libs/1_45_0/libs/bind/bind.html">boost::bind (V1.45.0)</A>
176- <A HREF="http://www.boost.org/doc/libs/1_45_0/doc/html/boost_asio.html">boost asio (V1.45.0)</A>
177- <A HREF="http://www.boost.org/doc/libs/1_45_0/doc/html/date_time.html">boost date_time (V1.45.0)</A>
178- <A HREF="http://www.boost.org/doc/libs/1_45_0/doc/html/program_options.html">boost program_options (V1.45.0)</A>
179- <A HREF="http://www.boost.org/doc/libs/1_45_0/libs/filesystem/v3/doc/index.htm">boost filesystem (V1.45.0)</A>
180- <A HREF="http://www.boost.org/doc/libs/1_45_0/libs/regex/doc/html/index.html">boost regex (V1.45.0)</A>
181- <A HREF="http://www.boost.org/doc/libs/1_45_0/libs/system/doc/index.html">boost system (error codes) (V1.45.0)</A>
182- <A HREF="http://www.boost.org/doc/libs/1_45_0/doc/html/thread.html">boost thread (V1.45.0)</A>
183- <A HREF="http://www.boost.org/doc/libs/1_45_0/libs/conversion/lexical_cast.htm">boost lexical_cast (V1.45.0)</A>
184
185@subsection fitsref FITS references
186- <A HREF="http://heasarc.gsfc.nasa.gov/docs/heasarc/fits.html">The FITS data format</A>
187- <A HREF="http://heasarc.gsfc.nasa.gov/fitsio/">FITS homepage</A>
188- <A HREF="http://heasarc.gsfc.nasa.gov/fitsio/CCfits/">CCfits - A C++ wrapper to cfitsio</A>
189- <A HREF="http://heasarc.gsfc.nasa.gov/docs/software/ftools/fv/">fv - A very simple viewer to FITS file contents</A>
190
191@subsection qtroot How to integrate root in QT?
192
193- <A HREF="http://doc.trolltech.com/4.3/designer-creating-custom-widgets.html">QT4: Creating custom widgets</A>
194- <A HREF="http://root.cern.ch/download/doc/26ROOTandQt.pdf">root: QT integration (pdf)</A>
195
196
197@section Available programs
198
199- dns: Dim's domain-name-server (needed for any communication between Dim servers and clients)
200- did: A simple graphical interface to analyse everything in a Dim network
201
202@section Examples
203
204There are a few example programs
205- \b ./argv: Example for usage of the class Configure (command line options, configuration file)
206- \b ./time: Example for the usage of the class Time (time input/output, conversion)
207- \b ./log, \b ./logtime: A simple Dim-Service/-Client combination using MessageDimRX/MessageDimTX
208
209**/
210// **************************************************************************
Note: See TracBrowser for help on using the repository browser.