Changeset 988 in Sophya
- Timestamp:
- May 2, 2000, 3:43:27 PM (25 years ago)
- Location:
- trunk/SophyaLib/Manual
- Files:
-
- 2 added
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SophyaLib/Manual/sophya.tex
r978 r988 1 1 \documentclass[twoside,11pt]{article} 2 2 % Package standard : Utilisation de caracteres accentues, mode francais et graphique 3 \usepackage{url} 3 4 \usepackage[latin1]{inputenc} 4 5 \usepackage[T1]{fontenc} … … 11 12 \usepackage{amssymb} 12 13 14 % Definition pour Docs Sophya 13 15 \usepackage{defsophya} 14 16 … … 18 20 19 21 \begin{titlepage} 22 % The title page - top of the page with the title of the paper 20 23 \titrehp{Sophya \\ An overview } 24 % Authors list 21 25 \auteurs{ 22 R. Ansari & ansari@lal.in2p3.fr \\23 G. Le Meur & lemeur@lal.in2p3.fr \\24 C. Magneville & cmv@hep.saclay.cea.fr \\25 S. Versille & versille@lal.in2p3.fr26 R. Ansari & ansari@lal.in2p3.fr \\ 27 G. Le Meur & lemeur@lal.in2p3.fr \\ 28 C. Magneville & cmv@hep.saclay.cea.fr \\ 29 S. Henrot-Versille & versille@in2p3.fr 26 30 } 27 31 % \auteursall 28 \titrebp{2} 32 % The title page - bottom of the page with the paper number 33 \titrebp{1} 29 34 \end{titlepage} 30 35 … … 59 64 ({\tt DataCard, DVList} \ldots). 60 65 \item[] {\bf TArray/} template numerical arrays, vectors and matrices 61 ({\tt PixelMap<T> SphericalMap<T>} \ldots) and few geometry 62 handling utility classes. 66 ({\tt PixelMap<T> SphericalMap<T>} \ldots) 63 67 \item[] {\bf NTools/} Some standard numerical analysis tools 64 68 (linear, and non linear parameter fitting, FFT, \ldots) … … 70 74 CMB (Cosmic Microwave Background) data analysis problem: 71 75 \begin{itemize} 72 \item[] {\bf SkyMap/} Local and full sky maps 76 \item[] {\bf SkyMap/} Local and full sky maps, and few geometry 77 handling utility classes. \\ 78 ({\tt PixelMap<T>, LocalMap<T>, SphericalMap<T>, \ldots}) 73 79 \item[] {\bf SkyT/} 74 80 classes for spectral emission and detector frequency response modelling \\ … … 81 87 external libraries: 82 88 \begin{itemize} 83 \item[] {\bf FitsIOS rever/} Classes for handling file input-output89 \item[] {\bf FitsIOServer/} Classes for handling file input-output 84 90 in FITS format using the cfitsio library. 85 91 \item[] {\bf LinAlg/} Interface with Lapack linear algebra package … … 96 102 analysis program framework and the interfaces with the objects 97 103 in SOPHYA. The {\bf PI/} \footnote{the PI package documentation 98 is available from {\ tthttp://www.lal.in2p3.fr/recherche/eros/PeidaDoc/} }104 is available from {\bf http://www.lal.in2p3.fr/recherche/eros/PeidaDoc/} } 99 105 and {\bf PIext/} modules are not currently part 100 106 of the SOPHYA CVS structure. 101 107 \end{itemize} 108 109 \newpage 102 110 103 111 \section{Using Sophya} … … 140 148 csh> make trivial 141 149 \end{verbatim} 142 This command should compile the {\tt trivial.cc} file, producing 143 {\tt \$HOME/`uname`-\$EROSCXX/Objs/trivial.o} and link it against the sophya 144 libraries to produce {\tt \$HOME/`uname`-\$EROSCXX/Exec/trivial}. 150 This command should compile the {\tt trivial.cc} file, 151 and link it against the sophya libraries. The object and executable 152 file names are: \\ 153 {\tt \$HOME/`uname`-\$EROSCXX/Objs/trivial.o} \\ 154 {\tt \$HOME/`uname`-\$EROSCXX/Exec/trivial}. 145 155 \par 146 156 The file {\tt \$DPCBASEREP/Include/makefile\_example} provides another 147 157 example makefile. 148 158 159 160 \newpage 149 161 150 162 \section{Building and installing Sophya} … … 183 195 the external libraries directory tree has been set up in 184 196 {\tt /usr/local/ExtLibs/}. \\[3mm] 185 \centerline{\bf \large the use of GNU make is mandatory.} 197 \centerline{ 198 \rule{20mm}{0.5mm} 199 {\bf \large the use of GNU make is mandatory} 200 \rule{20mm}{0.5mm} } 201 186 202 \vspace*{3mm} 187 203 \begin{verbatim} … … 237 253 \end{verbatim} 238 254 239 \section{Mgr/ module} 240 This module contains scripts which can be used for ge 241 blabla ... 242 243 \section{SysTools module} 244 This is a dclsa{AAAA} \\[2mm] 245 \dclsa{AAA} 246 This is a dclsb{BBBB}{BBBB} \\[2mm] 247 \dclsbb{BBBB}{BBBB} 248 This is a dclsc{CCCCC}{CCCCC}{CCCCC} \\[2mm] 249 \dclsccc{\tcls{CCCCC}}{CCCCC}{CCCCC} 250 251 252 \begin{figure} 253 \dclsa{DataCard} 254 \dclsbb{AnyDataObj}{NDataBlock$<$T$>$} 255 \dclsccc{BaseArray}{TArray}{TMatrix} 256 \dclsb{NDataBlock$<$T$>$} 257 \dclscc{TArray}{TMatrix} 258 \dclsc{\tcls{Tvector}} 259 \caption{ Partial class diagram} 255 \subsection{Mgr module} 256 This module contains scripts which can be used for generating the 257 makefiles for each module. 258 \begin{itemize} 259 \item {\bf Makefile} Top level Makefile for builiding the libraries. 260 \item {\bf Makefile.h} contains the defintion of compilation flags for the 261 different compilers and systems. This file is used for building the 262 library and generating {\bf MakefileUser.h} (to be included in makefiles). 263 \item {\bf Makefile.slb} contains the rules for building shared libraries 264 for the different compilers and systems. (to be included in makefiles) 265 \item {\bf crerep\_sophya} c-shell script for creating the directory tree 266 under {\tt \$DPCBASEREP} and {\tt \$DPCDEVREP} 267 \item {\bf install\_sophya} c-shell script for installing the Sophya package. 268 Usually from {\tt \$DPCDEVREP} to {\tt \$DPCBASEREP} 269 \item {\bf mkmflien} c-shell script for making symbolic links or copying 270 include files to {\tt \$DPCDEVREP/Include} or {\tt \$DPCBASEREP/Include} 271 \item {\bf mkmf} c-shell script for generating module makefiles and the 272 top level makefile (named GNUmakefile) 273 \item {\bf mkmflib} c-shell script for generating each library module 274 makefile (named GNUmakefile) 275 \item {\bf mkmfprog} c-shell script for generating makefile for a module 276 containing the source for executable programs (named GNUmakefile). 277 \item {\bf mkmfPI} c-shell script for generating makefile for PI and PIext 278 modules (named GNUmakefile) 279 \item {\bf libdirs} List of Sophya modules without reference to external 280 libraries. 281 \item {\bf extlibdirs} List of Sophya modules with reference to external 282 libraries. 283 284 \end{itemize} 285 286 \newpage 287 288 \section{Learning Sophya through examples} 289 The examples here illustrates the basic 290 usage of Sophya classes. Sophya documentation can be found at our web site: \\ 291 {\bf http://hfi-l2.in2p3.fr}. 292 293 \subsection{Using classes in SysTools} 294 295 {\bf SysTools} contains utility classes such as {\tt DataCards} or 296 {\tt DVlist}, an hierarchy of exception classes for Sophya, a template 297 class {\tcls{NDataBlock}} for handling reference counting on numerical 298 arrays, as well as classes providing the services for implementing simple 299 serialization. For simple programs, it is a good practice to handle 300 the exceptions at least at high level, in the {\tt main()} function. 301 The example below shows the exception handling and the usage 302 of Sophya persistence. 303 \vspace*{5mm} 304 305 \begin{figure}[hbt] 306 \dclsa{PPersist} 307 \dclsbb{PIOPersist}{PInPersist} 308 \dclsb{POutPersist} 309 \caption{partial class diagram for classes handling persistencein Sophya} 260 310 \end{figure} 261 311 262 263 PixelMap<T> --- LocalMap<T> 264 SphericalMap<T> --- SphereThetaPhi<T> 265 SphereHEALPix<T> 266 312 \input{ex1.inc} 267 313 268 314 \end{document}
Note:
See TracChangeset
for help on using the changeset viewer.