Index: doc/trunk/DAM - Architecture Overall/pictures/DamSVNLayout.png =================================================================== diff -u -r59 -r94 Binary files differ Index: doc/trunk/DAM - Architecture Overall/DAM - Architecture Overall.pdf =================================================================== diff -u -r85 -r94 Binary files differ Index: doc/trunk/DAM_references/dam_references.bib =================================================================== diff -u -r89 -r94 --- doc/trunk/DAM_references/dam_references.bib (.../dam_references.bib) (revision 89) +++ doc/trunk/DAM_references/dam_references.bib (.../dam_references.bib) (revision 94) @@ -140,7 +140,7 @@ } @TechReport{DAMKernel_FunctionalDesign, - author = {E. Zwan, I vd}, + author = {E. VAstenburg and Zwan, I vd}, title = {DAM Kernel - Functional Design}, institution = {Deltares}, year = {2013}, Index: doc/trunk/DAM - Architecture Overall/pictures/DamSVNClientLibraryLayout.png =================================================================== diff -u Binary files differ Index: doc/trunk/DAM - Architecture Overall/pictures/DamSVNMainLayout.png =================================================================== diff -u -r57 -r94 Binary files differ Index: doc/trunk/DAM - Architecture Overall/pictures/DamLiveSensor.jpg =================================================================== diff -u Binary files differ Index: doc/trunk/DAM - Architecture Overall/pictures/DamLiveShowcase.jpg =================================================================== diff -u Binary files differ Index: doc/trunk/DAM - Architecture Overall/pictures/dam_cover_architecture_overall.pdf =================================================================== diff -u -r55 -r94 Binary files differ Index: doc/trunk/DAM - Architecture Overall/pictures/algemeen-strookje20mm.jpg =================================================================== diff -u -r55 -r94 Binary files differ Index: doc/trunk/DAM - Architecture Overall/DAM - Architecture Overall.tex =================================================================== diff -u -r59 -r94 --- doc/trunk/DAM - Architecture Overall/DAM - Architecture Overall.tex (.../DAM - Architecture Overall.tex) (revision 59) +++ doc/trunk/DAM - Architecture Overall/DAM - Architecture Overall.tex (.../DAM - Architecture Overall.tex) (revision 94) @@ -1,51 +1,18 @@ -\documentclass[signature]{deltares_manual} +\documentclass[signature]{deltares_report} \usepackage[titletoc]{appendix} -\renewcommand\BackgroundPicChapter{ - \put(0,0){ - \parbox[b][\paperheight]{\paperwidth}{% - \vspace{4\baselineskip} - \hspace{220mm} - \includegraphics[width=15mm]{pictures/algemeen-strookje20mm.jpg} - \vfill - } - } -} -\renewcommand{\contactsalesandsupport}{ - \textbf{Contact:}\\ - \begin{tabular}[t]{@{}p{0.50\textwidth}p{0.50\textwidth}} - \vspace*{-1.5\baselineskip} - \begin{tabbing} -Deltares \\ -Boussinesqweg 1 \\ -2629 HV Delft \\ -P.O. 177 \\ -2600 MH Delft \\ -The Netherlands \\ - \end{tabbing} - & - \vspace*{-1.5\baselineskip} - \begin{tabbing} - telephone: \= +31\,88\,335\,8273 \\ - www: \> https://www.deltares.nl \\ - \end{tabbing} - \end{tabular} -} - %----------------------------------------------- \begin{document} \pagestyle{empty} -\includepdf[pages=1, offset=72 -70]{pictures/dam_cover_architecture_overall.pdf} % links-rechts past precies \cleardoublepage % \newcommand{\ProgramName}{DAM} \newcommand{\ProgramNamePlusSpace}{DAM } \title{\ProgramName} -\manualtype{Architecture Overall} -\subtitle{} +\subtitle{Architecture Overall} \projectnumber{1210702-000} \client{Deltares - Geo engineering DKS} \reference{1210702-000-GEO-0005} @@ -70,8 +37,8 @@ \approvali{Maya Sule} \status{draft} +\disclaimer{This is a draft report, intended for discussion purposes only. No part of this report may be relied upon by either principals or third parties.} - \deltarestitle @@ -125,8 +92,10 @@ \label{fig-DamComponents} \end{figure} +The arrows illustrate the dependencies of the components. In the following sections the components are described. + \section{\ProgramNamePlusSpace clients} \label{sec:2.1} -\ProgramNamePlusSpace clients are the modules that mostly interact with the user or sometimes with another system. These can be full graphical user interfaces (like DAM UI as shown in \autoref{fig-DamUIMainForm} and DamLive Showcase ), commandline parameter tools (like KernelCompariosnRunner.exe) or a module that can be used by other systems (like DAMLive, that is to be used as a module in a FEWS system). +\ProgramNamePlusSpace clients are the modules that mostly interact with the user or sometimes with another system. These can be full graphical user interfaces (like DAM UI as shown in \autoref{fig-DamUIMainForm} and DamLive Showcase as shown in \autoref{fig-DamLiveShowcase} and \autoref{fig-DamLiveSensor}), commandline parameter tools (like KernelComparisonRunner.exe) or a module that can be used by other systems (like DAMLive, that is to be used as a module in a FEWS system). \begin{figure}[H] \begin{center} @@ -137,6 +106,25 @@ \label{fig-DamUIMainForm} \end{figure} +\begin{figure}[H] + \begin{center} + \includegraphics[width=15cm]{pictures/DamLiveShowcase.jpg} + \end{center} + + \caption{\small \ProgramName Live Showcase User Interface.} + \label{fig-DamLiveShowcase} +\end{figure} + +\begin{figure}[H] + \begin{center} + \includegraphics[width=4cm]{pictures/DamLiveSensor.jpg} + \end{center} + + \caption{\small \ProgramName Live sensor.} + \label{fig-DamLiveSensor} +\end{figure} + + These clients interact directly with the \ProgramNamePlusSpace kernel (see next section). @@ -153,16 +141,16 @@ The \ProgramNamePlusSpace kernel has no knowledge of the clients that use the kernel and there will be no code dependencies from the kernel to the clients. \section{Failure mechanisms} \label{sec:2.3} -The failure mechanisms are completely independent and have no knowledge of the \ProgramNamePlusSpace kernel. So there will be no code dependencies from the failure mechanisms to the \ProgramNamePlusSpace kernel. +The \ProgramNamePlusSpace kernel uses the failure mechanisms. These are completely independent and have no knowledge of the \ProgramNamePlusSpace kernel. So there will be no code dependencies from the failure mechanisms to the \ProgramNamePlusSpace kernel. %------------------------------------------------------------------------------ \chapter{Architectural Choices} \label{chapter3} \section{Module dependencies} \label{sec:3.1} -As can be seen in \autoref{fig-DamComponents} the arrows pointing between the main parts of the system are only 1 way. This means that e.g. the \ProgramNamePlusSpace clients may address the \ProgramNamePlusSpace kernel, but the \ProgramNamePlusSpace kernel may not address the \ProgramNamePlusSpace clients. +As can be seen in \autoref{fig-DamComponents} the arrows pointing between the main parts of the system are only 1 way. This means that e.g. the \ProgramNamePlusSpace clients may address the \ProgramNamePlusSpace kernel, but the \ProgramNamePlusSpace kernel may not address the \ProgramNamePlusSpace clients. \section{External libraries and components} \label{sec:3.2} -\ProgramNamePlusSpace uses third-party libraries and components. Only open sources and free components, that are free to redistribute are allowed to be used. +\ProgramNamePlusSpace uses third-party libraries and components. Only open sources and free components, that are free to redistribute, are allowed to be used. Furthermore \ProgramNamePlusSpace uses the Delta Shell Light (DSL) library, that is developed by Deltares. @@ -181,8 +169,8 @@ \item DSL-Geo: geotechnics functionality \item DSL-GeoIO: geotechnics import and database functionality \item DSL-FormsStandard: standard UI functionality - \item DSL-FormsMaps: extend FormsStandard with GIS functionality - \item DSL-FormsGeo: extend FormsStandard with geotechnical functionality + \item DSL-FormsMaps: extends FormsStandard with GIS functionality + \item DSL-FormsGeo: extends FormsStandard with geotechnical functionality \end{itemize} Other libraries that are used are @@ -195,7 +183,7 @@ \end{itemize} \section{\ProgramNamePlusSpace kernel} \label{sec:3.4} -The \ProgramNamePlusSpace kernel only uses part of the DSL library +The \ProgramNamePlusSpace kernel only uses part (the non-UI modules) of the DSL library \begin{itemize} \item DSL-Core \item DSL-Probabilistic @@ -211,11 +199,11 @@ %------------------------------------------------------------------------------ \chapter{Version control} \label{chapter4} -For the version control system, Subversion with the Tortoise client will be used. The layout of the SVN repository will reflect the components of \ProgramNamePlusSpace as shown in \autoref{fig-DamComponents}. +For the version control system Subversion with the Tortoise client will be used. The layout of the SVN repository will reflect the components of \ProgramNamePlusSpace as shown in \autoref{fig-DamComponents}. -The failure mechanisms are not part of the \ProgramNamePlusSpace repository and will be stored in their own repositories +The failure mechanisms are not part of \ProgramNamePlusSpace itself and thus not of the \ProgramNamePlusSpace repository. Instead, the failure mechanisms will be stored in their own repositories. \ProgramNamePlusSpace will refer to the failure mechanisms as external libraries. -\section{\ProgramNamePlusSpace repository main layout} \label{sec:14.1} +\section{\ProgramNamePlusSpace repository main layout} \label{sec:4.1} In \autoref{fig-SVNMainLayout} the main layout is shown. @@ -229,13 +217,14 @@ \label{fig-SVNMainLayout} \end{figure} -The 3 main parts are +The 4 main parts are \begin{itemize} \item dam clients - the client applications that use the \ProgramNamePlusSpace kernel. - \item dam kernel - the computational kernel of \ProgramNamePlusSpace. + \item dam clients library - shared libraries by the \ProgramNamePlusSpace clients. + \item dam kernel - the computational kernel of \ProgramName. \item doc - general documentation for \ProgramNamePlusSpace (like this document). \end{itemize} -Each of these parts has its own trunk/branches/tags layout. +With the excpetion of "`dam clients"' Each of these parts has its own trunk/branches/tags layout. The map "'dam tools"' is for storing independent tools that are not part of \ProgramNamePlusSpace itself, but support the work processes of \ProgramNamePlusSpace (e.g. Dam Edit Design). @@ -249,12 +238,11 @@ \begin{flushleft} \includegraphics{pictures/DamSVNClientLayout.png} \end{flushleft} - \caption{\small \ProgramNamePlusSpace SVN clients layout.} \label{fig-SVNClientLayout} \end{figure} -The map "`dam clients"' has a trunk/branches/tags layout. +Each of the "`dam clients"' has its own trunk/branches/tags layout. The currently known applications are \begin{itemize} @@ -264,15 +252,25 @@ \item KernelComparisonRunner - a commandline utility for comparing the results of different macrostability kernels. \end{itemize} -The following items are shared projects for the applications +\section{\ProgramNamePlusSpace repository clients library layout} \label{sec:4.3} + +In \autoref{fig-SVNClientLibraryLayout} the layout of the \ProgramNamePlusSpace clients library map is shown + +\begin{figure}[H] + \begin{flushleft} + \includegraphics{pictures/DamSVNClientLibraryLayout.png} + \end{flushleft} + \caption{\small \ProgramNamePlusSpace SVN clients layout.} + \label{fig-SVNClientLibraryLayout} +\end{figure} + +At this moment only one project is foreseen to be put in the "`dam clients library"' map \begin{itemize} \item Deltares.Dam.Data - \item Deltares.Dam.Forms. \end{itemize} +\section{\ProgramNamePlusSpace repository full layout} \label{sec:4.4} -\section{\ProgramNamePlusSpace repository full layout} \label{sec:4.3} - The full layout of the \ProgramNamePlusSpace repository will be as shown in \autoref{fig-SVNLayout}. \begin{figure}[H] \begin{flushleft} @@ -296,7 +294,6 @@ \pagestyle{empty} \cleardoublepage \mbox{} -\includepdf[pages=2, offset=-72 -70]{pictures/dam_cover_architecture_overall.pdf} % links-rechts past precies %------------------------------------------------------------------------------ \end{document} Index: doc/trunk/DAM - Architecture Overall/pictures/DamSVNClientLayout.png =================================================================== diff -u -r59 -r94 Binary files differ