Commit a510ba454293f52735989c77cd03e72e50a6ecfe
1 parent
04cdab01
initial versions
Showing
4 changed files
with
544 additions
and
0 deletions
doc/dev/sdd/gammalib_sdd.tex
0 → 100644
| 1 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 2 | +% GammaLib Software Design Description | ||
| 3 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 4 | + | ||
| 5 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 6 | +% Definitions for manual package | ||
| 7 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 8 | +\newcommand{\task}{\mbox{GammaLib}} | ||
| 9 | +\newcommand{\this}{\mbox{\tt \task}} | ||
| 10 | +\newcommand{\shorttype}{\mbox{SDD}} | ||
| 11 | +\newcommand{\doctype}{\mbox{Software Design Description}} | ||
| 12 | +\newcommand{\version}{\mbox{draft}} | ||
| 13 | +\newcommand{\calendar}{\mbox{7 October 2009}} | ||
| 14 | +\newcommand{\auth}{\mbox{J\"urgen Kn\"odlseder}} | ||
| 15 | +\newcommand{\approv}{\mbox{J\"urgen Kn\"odlseder}} | ||
| 16 | + | ||
| 17 | + | ||
| 18 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 19 | +% Document definition | ||
| 20 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 21 | +\documentclass{article}[12pt,a4] | ||
| 22 | +\usepackage{epsfig} | ||
| 23 | +\usepackage{manual} | ||
| 24 | + | ||
| 25 | + | ||
| 26 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 27 | +% Begin of document body | ||
| 28 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 29 | +\begin{document} | ||
| 30 | +\frontpage | ||
| 31 | + | ||
| 32 | + | ||
| 33 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 34 | +% Introduction | ||
| 35 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 36 | +\section{Introduction} | ||
| 37 | + | ||
| 38 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 39 | +\subsection{Design Overview} | ||
| 40 | + | ||
| 41 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 42 | +\subsection{Requirements Traceability Matrix} | ||
| 43 | + | ||
| 44 | + | ||
| 45 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 46 | +% System architectural design | ||
| 47 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 48 | +\section{System Architectural Design} | ||
| 49 | + | ||
| 50 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 51 | +\subsection{Chosen System Architecture} | ||
| 52 | + | ||
| 53 | +The \this\ is designed for Linux, Unix and MacOS~X systems and compiles under | ||
| 54 | +32 Bit and 64 Bit. | ||
| 55 | + | ||
| 56 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 57 | +\subsection{Discussion of Alternative Designs} | ||
| 58 | + | ||
| 59 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 60 | +\subsection{System Interface Description} | ||
| 61 | + | ||
| 62 | +The \this\ is designed as C++ API library of which all modules are designed as classes. | ||
| 63 | +A Python interface allows scripting of library components. | ||
| 64 | + | ||
| 65 | + | ||
| 66 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 67 | +% Detailed Description of Components | ||
| 68 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 69 | +\section{Detailed Description of Components} | ||
| 70 | + | ||
| 71 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 72 | +\subsection{Component 1} | ||
| 73 | + | ||
| 74 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 75 | +\subsection{Component 2} | ||
| 76 | + | ||
| 77 | + | ||
| 78 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 79 | +% User Interface Design | ||
| 80 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 81 | +\section{User Interface Design} | ||
| 82 | + | ||
| 83 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 84 | +\subsection{Description of the User Interface} | ||
| 85 | + | ||
| 86 | + | ||
| 87 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 88 | +% Additional Material | ||
| 89 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 90 | +\section{Additional Material} | ||
| 91 | + | ||
| 92 | +\end{document} |
doc/dev/sdd/manual.sty
0 → 100644
| 1 | +%% | ||
| 2 | +%% "manual.sty" provides definitions for the gammalib documentation | ||
| 3 | +%% | ||
| 4 | +%% Copyright (C) 2009 Jurgen Knodlseder | ||
| 5 | +%% | ||
| 6 | +\NeedsTeXFormat{LaTeX2e} | ||
| 7 | +\ProvidesPackage{manual}[2009/10/07 gammalib ducomentation] | ||
| 8 | + | ||
| 9 | +% | ||
| 10 | +% The page dimensions | ||
| 11 | +% | ||
| 12 | +%\setlength\paperheight{9.25in} | ||
| 13 | +%\setlength\paperwidth{7.375in} | ||
| 14 | +\setlength\parindent{0cm} | ||
| 15 | +\setlength\parskip{0.2cm} | ||
| 16 | +\setlength\linewidth{13.2cm} | ||
| 17 | +\setlength\headheight{1.5cm} | ||
| 18 | +\setlength\textwidth{16.3cm} | ||
| 19 | +\setlength\textheight{22.5cm} | ||
| 20 | +\setlength\oddsidemargin{0cm} | ||
| 21 | +\setlength\topmargin{-1.7cm} | ||
| 22 | +%\setlength\parindent{2em} | ||
| 23 | +%\setlength\headheight{8pt} | ||
| 24 | +\setlength\headsep{19pt} | ||
| 25 | +\setlength\footskip{24pt} | ||
| 26 | +%\setlength\textwidth{345pt} | ||
| 27 | +%\setlength\textheight{46pc} | ||
| 28 | +\setlength\evensidemargin{1.6804in} | ||
| 29 | +%\setlength\oddsidemargin{1.5139in} | ||
| 30 | +%\setlength\topmargin{.625in} | ||
| 31 | + | ||
| 32 | +% | ||
| 33 | +% Page style | ||
| 34 | +% | ||
| 35 | +\pagestyle{myheadings} | ||
| 36 | +\markboth{\task\ \doctype} | ||
| 37 | + {\task\ \doctype} | ||
| 38 | + | ||
| 39 | +%\renewcommand{\subsection}{\@startsection{subsection}{3}{-4pc}{-16pt}{6pt}{% | ||
| 40 | +% \rightmark{Introduction}}} | ||
| 41 | + | ||
| 42 | +% | ||
| 43 | +% Define front-page command | ||
| 44 | +% | ||
| 45 | +\newcommand{\frontpage}{% | ||
| 46 | +\begin{center} | ||
| 47 | +\framebox[16cm]{ | ||
| 48 | +\begin{minipage}[c]{16cm} | ||
| 49 | +\vspace*{6.5cm} | ||
| 50 | +\begin{center} | ||
| 51 | + | ||
| 52 | +% Software component | ||
| 53 | +\framebox{ | ||
| 54 | + \framebox{ | ||
| 55 | + \parbox{10cm}{ | ||
| 56 | + \vspace{5mm} \centerline{ | ||
| 57 | + \vspace{5mm} \Huge \bf | ||
| 58 | + \task\ \shorttype | ||
| 59 | + } | ||
| 60 | + } | ||
| 61 | + } | ||
| 62 | +} | ||
| 63 | + | ||
| 64 | +% Document type | ||
| 65 | +\vspace{10mm} | ||
| 66 | +{\Huge \bf \doctype} | ||
| 67 | +\\[10mm] | ||
| 68 | + | ||
| 69 | +% Version, Date | ||
| 70 | +{\normalsize \bf Version \version\\ \calendar} | ||
| 71 | +\\[10mm] | ||
| 72 | + | ||
| 73 | +% Author | ||
| 74 | +\rm | ||
| 75 | +Author: \auth\ \\ | ||
| 76 | +Approved by: \approv\ \\ | ||
| 77 | + | ||
| 78 | +% Affiliation | ||
| 79 | +\vspace*{1cm} | ||
| 80 | +Centre d'Etude Spatiale des Rayonnements\\ | ||
| 81 | +9, avenue du Colonel-Roche\\ | ||
| 82 | +31028 Toulouse Cedex 4\\ | ||
| 83 | +FRANCE | ||
| 84 | + | ||
| 85 | +\vfill | ||
| 86 | +\end{center} | ||
| 87 | +\vspace*{4.5cm} | ||
| 88 | +\end{minipage} | ||
| 89 | +} | ||
| 90 | +\end{center} | ||
| 91 | + | ||
| 92 | +\thispagestyle{empty} | ||
| 93 | +\pagenumbering{roman} | ||
| 94 | +\newpage | ||
| 95 | +\begin{center} | ||
| 96 | +\parbox{15cm}{ | ||
| 97 | +\vspace{200mm} | ||
| 98 | +\centerline{This page intentionally left blank} | ||
| 99 | +\vspace{3mm} | ||
| 100 | +%This software has been written to analyse data of the SPI | ||
| 101 | +%telescope onboard INTEGRAL. | ||
| 102 | +%Particular care has been taken in making the software user friendly | ||
| 103 | +%and well documented. | ||
| 104 | +%If you appreciated this effort, and if this software and User Manual | ||
| 105 | +%were useful for your scientific work, the author would appreciate a | ||
| 106 | +%corresponding acknowledgment in your published work. | ||
| 107 | +} | ||
| 108 | +\end{center} | ||
| 109 | + | ||
| 110 | +\newpage | ||
| 111 | +\tableofcontents | ||
| 112 | +\newpage | ||
| 113 | +\pagenumbering{arabic} | ||
| 114 | +} | ||
| 115 | + | ||
| 116 | + | ||
| 117 | +% | ||
| 118 | +% Further commands | ||
| 119 | +% | ||
| 120 | +%\newcommand{\icd}[1]{\item[{\tt #1}] } | ||
| 121 | +\newcommand{\icd}[1]{\item{\tt #1} } | ||
| 122 | +\newcommand{\cur}[1]{% | ||
| 123 | +\icd{#1} specifies the current ISDC status when the function is entered. | ||
| 124 | + If {\tt status != ISDC\_OK} the function does nothing and | ||
| 125 | + returns the input status as return code. | ||
| 126 | +} | ||
| 127 | +\endinput | ||
| 128 | +%% | ||
| 129 | +%% End of file `manual.sty'. |
doc/dev/srs/gammalib_srs.tex
0 → 100644
| 1 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 2 | +% GammaLib Software Requirement Specification | ||
| 3 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 4 | + | ||
| 5 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 6 | +% Definitions for manual package | ||
| 7 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 8 | +\newcommand{\task}{\mbox{GammaLib}} | ||
| 9 | +\newcommand{\this}{\mbox{\tt \task}} | ||
| 10 | +\newcommand{\shorttype}{\mbox{SRS}} | ||
| 11 | +\newcommand{\doctype}{\mbox{Software Requirement Specification}} | ||
| 12 | +\newcommand{\version}{\mbox{draft}} | ||
| 13 | +\newcommand{\calendar}{\mbox{7 October 2009}} | ||
| 14 | +\newcommand{\auth}{\mbox{J\"urgen Kn\"odlseder}} | ||
| 15 | +\newcommand{\approv}{\mbox{J\"urgen Kn\"odlseder}} | ||
| 16 | + | ||
| 17 | + | ||
| 18 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 19 | +% Document definition | ||
| 20 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 21 | +\documentclass{article}[12pt,a4] | ||
| 22 | +\usepackage{epsfig} | ||
| 23 | +\usepackage{manual} | ||
| 24 | + | ||
| 25 | + | ||
| 26 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 27 | +% Begin of document body | ||
| 28 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 29 | +\begin{document} | ||
| 30 | +\frontpage | ||
| 31 | + | ||
| 32 | + | ||
| 33 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 34 | +% Introduction | ||
| 35 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 36 | +\section{Introduction} | ||
| 37 | + | ||
| 38 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 39 | +\subsection{Product Overview} | ||
| 40 | + | ||
| 41 | +The \this\ is a vesatile toolbox for the high-level analysis of astronomical gamma-ray data. | ||
| 42 | +It is implemented as a C++ library that is fully scriptable in the Python scripting language. | ||
| 43 | +The library provides core functionalities such as | ||
| 44 | +data input and output, | ||
| 45 | +interfaces for parameter specifications, and | ||
| 46 | +a reporting and logging interface. | ||
| 47 | +It implements instruments specific functionalities such as | ||
| 48 | +instrument response functions and | ||
| 49 | +data formats. | ||
| 50 | +Instrument specific functionalities share a common interface to allow for extension of the \this\ | ||
| 51 | +to include new gamma-ray instruments. | ||
| 52 | +The \this\ provides an abstract data analysis framework that enables simultaneous multi-mission | ||
| 53 | +analysis. | ||
| 54 | + | ||
| 55 | +The \this\ is designed as an open source library that is made availably at\break | ||
| 56 | +{\tt http://gammalib.sourceforge.net/}. | ||
| 57 | + | ||
| 58 | + | ||
| 59 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 60 | +\subsection{Purpose} | ||
| 61 | + | ||
| 62 | +The \this\ provides all functionalities required to perform a high-level analysis of astronomical | ||
| 63 | +gamma-ray data. | ||
| 64 | +High-level analysis means that the data are expected to be calibrated (energy, arrival direction or | ||
| 65 | +detector position) and time tagged. | ||
| 66 | +The \this\ is not designed for preprocessing of data or data calibration purposes. | ||
| 67 | + | ||
| 68 | + | ||
| 69 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 70 | +\subsection{Scope} | ||
| 71 | + | ||
| 72 | +The \this\ is designed for the high-level analysis of astronomical gamma-ray data. | ||
| 73 | +For the purpose of the \this, gamma rays are defined as photons with energies above | ||
| 74 | +few $\sim100$~keV. | ||
| 75 | +The \this\ both applies to data collected by space-based and ground-based instruments. | ||
| 76 | +So far it allows for the analysis of data collected by the following instruments: | ||
| 77 | +CTA. | ||
| 78 | + | ||
| 79 | + | ||
| 80 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 81 | +\subsection{Reference} | ||
| 82 | + | ||
| 83 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 84 | +\subsection{Definition and Abbreviations} | ||
| 85 | + | ||
| 86 | +The following abbreviations have been employed in this document: | ||
| 87 | +\begin{itemize} | ||
| 88 | +\item[]{\bf COMPTEL} Compton Telescope (flown aboard CGRO 1991-2000) | ||
| 89 | +\item[]{\bf CTA} Cherenkov Telescope Array | ||
| 90 | +\item[]{\bf Fermi} Fermi Gamma-Ray Space Telescope (launched in 2007) | ||
| 91 | +\item[]{\bf INTEGRAL} International Gamma Ray Laboratory (launched in 2002) | ||
| 92 | +\item[]{\bf IRAF} | ||
| 93 | +\item[]{\bf SPI} Spectrometer on INTEGRAL | ||
| 94 | +\end{itemize} | ||
| 95 | + | ||
| 96 | + | ||
| 97 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 98 | +% Specific Requirements | ||
| 99 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 100 | +\section{Specific Requirements} | ||
| 101 | + | ||
| 102 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 103 | +\subsection{External Interface Requirements} | ||
| 104 | + | ||
| 105 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 106 | +\subsubsection{User Interfaces} | ||
| 107 | + | ||
| 108 | +The \this\ is to designed as C++ API library of which all modules are designed as classes. | ||
| 109 | +A Python interface allows for scripting of library components. | ||
| 110 | + | ||
| 111 | +The \this\ supports 2 user interface formats for parameter input: | ||
| 112 | +the IRAF parameter interface (which is also employed for the {\tt ftools} and the | ||
| 113 | +INTEGRAL and Fermi data analysis frameworks) | ||
| 114 | +and a XML interface (which is also used within the Fermi data analysis framework). | ||
| 115 | + | ||
| 116 | +The \this\ provides also a reporting and logging interface that provides the user with | ||
| 117 | +human-readable information about code execution | ||
| 118 | + | ||
| 119 | + | ||
| 120 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 121 | +\subsubsection{Hardware Interfaces} | ||
| 122 | + | ||
| 123 | +No hardware interfaces are foreseen. | ||
| 124 | + | ||
| 125 | + | ||
| 126 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 127 | +\subsubsection{Software Interfaces} | ||
| 128 | + | ||
| 129 | + | ||
| 130 | + | ||
| 131 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 132 | +\subsubsection{Communication Protocols} | ||
| 133 | + | ||
| 134 | + | ||
| 135 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 136 | +\subsubsection{Memory Constraints} | ||
| 137 | + | ||
| 138 | + | ||
| 139 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 140 | +\subsubsection{Operation} | ||
| 141 | + | ||
| 142 | + | ||
| 143 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 144 | +\subsubsection{Product function} | ||
| 145 | + | ||
| 146 | + | ||
| 147 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 148 | +\subsubsection{Assumption and Dependency} | ||
| 149 | + | ||
| 150 | +The \this\ should be designed as a standalone package except for a link to the HEASARC | ||
| 151 | +{\tt cfitsio} library. | ||
| 152 | + | ||
| 153 | + | ||
| 154 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 155 | +\subsection{Software Product Features} | ||
| 156 | + | ||
| 157 | + | ||
| 158 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 159 | +\subsection{Software System Attributes} | ||
| 160 | + | ||
| 161 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 162 | +\subsubsection{Reliability} | ||
| 163 | + | ||
| 164 | + | ||
| 165 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 166 | +\subsubsection{Availability} | ||
| 167 | + | ||
| 168 | + | ||
| 169 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 170 | +\subsubsection{Security} | ||
| 171 | + | ||
| 172 | + | ||
| 173 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 174 | +\subsubsection{Maintainability} | ||
| 175 | + | ||
| 176 | + | ||
| 177 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 178 | +\subsubsection{Portability} | ||
| 179 | + | ||
| 180 | + | ||
| 181 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 182 | +\subsubsection{Performance} | ||
| 183 | + | ||
| 184 | + | ||
| 185 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 186 | +\subsection{Database requirements} | ||
| 187 | + | ||
| 188 | + | ||
| 189 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 190 | +% Additional Material | ||
| 191 | +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
| 192 | +\section{Additional Material} | ||
| 193 | + | ||
| 194 | +\end{document} |
doc/dev/srs/manual.sty
0 → 100644
| 1 | +%% | ||
| 2 | +%% "manual.sty" provides definitions for the gammalib documentation | ||
| 3 | +%% | ||
| 4 | +%% Copyright (C) 2009 Jurgen Knodlseder | ||
| 5 | +%% | ||
| 6 | +\NeedsTeXFormat{LaTeX2e} | ||
| 7 | +\ProvidesPackage{manual}[2009/10/07 gammalib ducomentation] | ||
| 8 | + | ||
| 9 | +% | ||
| 10 | +% The page dimensions | ||
| 11 | +% | ||
| 12 | +%\setlength\paperheight{9.25in} | ||
| 13 | +%\setlength\paperwidth{7.375in} | ||
| 14 | +\setlength\parindent{0cm} | ||
| 15 | +\setlength\parskip{0.2cm} | ||
| 16 | +\setlength\linewidth{13.2cm} | ||
| 17 | +\setlength\headheight{1.5cm} | ||
| 18 | +\setlength\textwidth{16.3cm} | ||
| 19 | +\setlength\textheight{22.5cm} | ||
| 20 | +\setlength\oddsidemargin{0cm} | ||
| 21 | +\setlength\topmargin{-1.7cm} | ||
| 22 | +%\setlength\parindent{2em} | ||
| 23 | +%\setlength\headheight{8pt} | ||
| 24 | +\setlength\headsep{19pt} | ||
| 25 | +\setlength\footskip{24pt} | ||
| 26 | +%\setlength\textwidth{345pt} | ||
| 27 | +%\setlength\textheight{46pc} | ||
| 28 | +\setlength\evensidemargin{1.6804in} | ||
| 29 | +%\setlength\oddsidemargin{1.5139in} | ||
| 30 | +%\setlength\topmargin{.625in} | ||
| 31 | + | ||
| 32 | +% | ||
| 33 | +% Page style | ||
| 34 | +% | ||
| 35 | +\pagestyle{myheadings} | ||
| 36 | +\markboth{\task\ \doctype} | ||
| 37 | + {\task\ \doctype} | ||
| 38 | + | ||
| 39 | +%\renewcommand{\subsection}{\@startsection{subsection}{3}{-4pc}{-16pt}{6pt}{% | ||
| 40 | +% \rightmark{Introduction}}} | ||
| 41 | + | ||
| 42 | +% | ||
| 43 | +% Define front-page command | ||
| 44 | +% | ||
| 45 | +\newcommand{\frontpage}{% | ||
| 46 | +\begin{center} | ||
| 47 | +\framebox[16cm]{ | ||
| 48 | +\begin{minipage}[c]{16cm} | ||
| 49 | +\vspace*{6.5cm} | ||
| 50 | +\begin{center} | ||
| 51 | + | ||
| 52 | +% Software component | ||
| 53 | +\framebox{ | ||
| 54 | + \framebox{ | ||
| 55 | + \parbox{10cm}{ | ||
| 56 | + \vspace{5mm} \centerline{ | ||
| 57 | + \vspace{5mm} \Huge \bf | ||
| 58 | + \task\ \shorttype | ||
| 59 | + } | ||
| 60 | + } | ||
| 61 | + } | ||
| 62 | +} | ||
| 63 | + | ||
| 64 | +% Document type | ||
| 65 | +\vspace{10mm} | ||
| 66 | +{\Huge \bf \doctype} | ||
| 67 | +\\[10mm] | ||
| 68 | + | ||
| 69 | +% Version, Date | ||
| 70 | +{\normalsize \bf Version \version\\ \calendar} | ||
| 71 | +\\[10mm] | ||
| 72 | + | ||
| 73 | +% Author | ||
| 74 | +\rm | ||
| 75 | +Author: \auth\ \\ | ||
| 76 | +Approved by: \approv\ \\ | ||
| 77 | + | ||
| 78 | +% Affiliation | ||
| 79 | +\vspace*{1cm} | ||
| 80 | +Centre d'Etude Spatiale des Rayonnements\\ | ||
| 81 | +9, avenue du Colonel-Roche\\ | ||
| 82 | +31028 Toulouse Cedex 4\\ | ||
| 83 | +FRANCE | ||
| 84 | + | ||
| 85 | +\vfill | ||
| 86 | +\end{center} | ||
| 87 | +\vspace*{4.5cm} | ||
| 88 | +\end{minipage} | ||
| 89 | +} | ||
| 90 | +\end{center} | ||
| 91 | + | ||
| 92 | +\thispagestyle{empty} | ||
| 93 | +\pagenumbering{roman} | ||
| 94 | +\newpage | ||
| 95 | +\begin{center} | ||
| 96 | +\parbox{15cm}{ | ||
| 97 | +\vspace{200mm} | ||
| 98 | +\centerline{This page intentionally left blank} | ||
| 99 | +\vspace{3mm} | ||
| 100 | +%This software has been written to analyse data of the SPI | ||
| 101 | +%telescope onboard INTEGRAL. | ||
| 102 | +%Particular care has been taken in making the software user friendly | ||
| 103 | +%and well documented. | ||
| 104 | +%If you appreciated this effort, and if this software and User Manual | ||
| 105 | +%were useful for your scientific work, the author would appreciate a | ||
| 106 | +%corresponding acknowledgment in your published work. | ||
| 107 | +} | ||
| 108 | +\end{center} | ||
| 109 | + | ||
| 110 | +\newpage | ||
| 111 | +\tableofcontents | ||
| 112 | +\newpage | ||
| 113 | +\pagenumbering{arabic} | ||
| 114 | +} | ||
| 115 | + | ||
| 116 | + | ||
| 117 | +% | ||
| 118 | +% Further commands | ||
| 119 | +% | ||
| 120 | +%\newcommand{\icd}[1]{\item[{\tt #1}] } | ||
| 121 | +\newcommand{\icd}[1]{\item{\tt #1} } | ||
| 122 | +\newcommand{\cur}[1]{% | ||
| 123 | +\icd{#1} specifies the current ISDC status when the function is entered. | ||
| 124 | + If {\tt status != ISDC\_OK} the function does nothing and | ||
| 125 | + returns the input status as return code. | ||
| 126 | +} | ||
| 127 | +\endinput | ||
| 128 | +%% | ||
| 129 | +%% End of file `manual.sty'. |