Index: doc/trunk/DAM - Architecture Overall/UML Diagrams/DAM Components.uxf =================================================================== diff -u --- doc/trunk/DAM - Architecture Overall/UML Diagrams/DAM Components.uxf (revision 0) +++ doc/trunk/DAM - Architecture Overall/UML Diagrams/DAM Components.uxf (revision 55) @@ -0,0 +1,167 @@ + + + 10 + + UMLGeneric + + 860 + 470 + 200 + 80 + + symbol=component + +Piping + + + + UMLGeneric + + 860 + 370 + 200 + 80 + + symbol=component + +Macrostability Outward + + + + UMLGeneric + + 860 + 270 + 200 + 80 + + symbol=component + +Macrostability Inward + + + + UMLDeployment + + 820 + 220 + 280 + 440 + + Failure Mechanisms + + + + UMLDeployment + + 460 + 220 + 280 + 440 + + DAM Kernel + + + + UMLDeployment + + 110 + 220 + 280 + 440 + + DAM Clients + + + + UMLGeneric + + 490 + 270 + 200 + 80 + + symbol=component + +Assessment Regional Dikes + + + + UMLGeneric + + 490 + 370 + 200 + 80 + + symbol=component + +Design Primary Dikes + + + + UMLGeneric + + 490 + 470 + 200 + 80 + + symbol=component + +Operational + + + + UMLGeneric + + 150 + 270 + 200 + 80 + + symbol=component + +DAM UI (DSL based) + + + + UMLGeneric + + 150 + 370 + 200 + 80 + + symbol=component + +DAMLive + + + + UMLGeneric + + 150 + 470 + 200 + 80 + + symbol=component + +DAMLive Showcase + + + + UMLGeneric + + 150 + 570 + 200 + 80 + + symbol=component + +Kernel Comparison Runner + + + Index: doc/trunk/DAM - Architecture Overall/pictures/dam_cover_architecture_overall.pdf =================================================================== diff -u Binary files differ Index: doc/trunk/DAM - Architecture Overall/pictures/DamComponents.png =================================================================== diff -u Binary files differ Index: doc/trunk/DAM - Architecture Overall/DAM - Architecture Overall.pdf =================================================================== diff -u Binary files differ Index: doc/trunk/DAM - Architecture Overall/pictures/algemeen-strookje20mm.jpg =================================================================== diff -u Binary files differ Index: doc/trunk/DAM - Architecture Overall/DAM - Architecture Overall.tex =================================================================== diff -u --- doc/trunk/DAM - Architecture Overall/DAM - Architecture Overall.tex (revision 0) +++ doc/trunk/DAM - Architecture Overall/DAM - Architecture Overall.tex (revision 55) @@ -0,0 +1,150 @@ +\documentclass[signature]{deltares_manual} +\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{Archticture Overall} +\subtitle{} +\projectnumber{1210702-000} +\client{Deltares - Geo engineering DKS} +\reference{1210702-000-GEO-0005} +\classification{-} + +\date{Jan. 2017} +\version{0.1} + +\keywords{Dike, safety assessment, design, software, macro stability, piping} + +\references{Refer to \autoref{chapter5}.} + +\summary{This document contains a description of the overall architecture for \ProgramName, an application that computes the strength of a complete dikering with respect to several failure mechnanisms, such as macro stability and piping.\\ +\\ +\textbf{\footnotesize{Samenvatting}} \\ +Dit document bevat het een beschrijving van de totale architectuur van \ProgramName, een User Interface applicatie die een gebruiker in staat stelt om voor een dijktraject berekeningen uit te voeren voor verschillende faalmechanismen, waaronder macrostabiliteit en piping.} + +\versioni{0.1} +\datei{Jan 2017} +\authori{Tom The} +\revieweri{John Bokma} +\approvali{Maya Sule} + +\status{draft} + + +\deltarestitle + + +%------------------------------------------------------------------------------ +\chapter{Introduction} \label{chapter1} + +\section{Purpose and scope of this document} \label{sec:1.1} + +This document contains the overall architecture of \ProgramName, a software package for the automated calculation of the strength of dikes, and all of its components. \ProgramNamePlusSpace was developed by Deltares with and for STOWA for all water authorities. + + +\section{Other system documents} \label{sec:1.2} + +The full documentation on the program comprises the following documents. + +\renewcommand{\arraystretch}{1.3} + +\begin{table}[H] +%\caption{xxx} +%\label{xxx} +\begin{tabular}{|p{40mm}|p{\textwidth-40mm-24pt}|} \hline +\textbf{Title} & \textbf{Content} \\ \hline +\ProgramNamePlusSpace - Architecture Overall \newline \citep{DAM_ArchitectureOverall} & Description of overall architecture of \ProgramNamePlusSpace and its components. \\ \hline +\ProgramNamePlusSpace Kernel - Technical Design \newline \citep{DAMKernel_TechnicalDesign} & Description of the implementation of the technical design of \ProgramName. \\ \hline +\ProgramNamePlusSpace Kernel - Test Plan \newline \citep{DAMKernel_TestPlan} & Description of the different regression and acceptation tests, including target values. \\ \hline +\ProgramNamePlusSpace Kernel - Test Report \newline \citep{DAMKernel_TestReport} & Description of the test results (benchmarks and test scripts). \\ \hline +\ProgramNamePlusSpace UI - Functional Design \newline \citep{DAMUI_FunctionalDesign} & Description of the requirements and functional design. \\ \hline +\ProgramNamePlusSpace UI - User Manual \newline \citep{DAMUI_Manual} & Description of the different functionalites available in the \textit{User Interface} and background information. \\ \hline +\ProgramNamePlusSpace UI - Technical documentation \newline \citep{DAMUI_TechnicalDocumentation} & Description of the arguments and usage of different software components, generated from in-line comment with Doxygen. \\ \hline +\end{tabular} +\end{table} + + +%------------------------------------------------------------------------------ +\chapter{\ProgramNamePlusSpace and its components} \label{chapter2} + +\begin{figure}[!h] + \begin{center} + \includegraphics[width=15cm]{pictures/DamComponents.png} + \end{center} + + \caption{\small \ProgramNamePlusSpace and its components.} + \label{fig-DamComponents} +\end{figure} + + +%------------------------------------------------------------------------------ +\chapter{Architectural Choices} \label{chapter3} + +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum + + + +%------------------------------------------------------------------------------ +\chapter{Version control} \label{chapter4} + +Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum + + + +%------------------------------------------------------------------------------ +\chapter{Literature} \label{chapter5} + +\bibliography{../DAM_references/dam_references} + + + +\cleardoublepage + +\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_references/dam_references.bib =================================================================== diff -u --- doc/trunk/DAM_references/dam_references.bib (revision 0) +++ doc/trunk/DAM_references/dam_references.bib (revision 55) @@ -0,0 +1,107 @@ +% Encoding: windows-1252 + +@Preamble{eck} + +@TechReport{DAMUI_TechnicalDocumentation, + author = {Doxygen}, + title = {DAM UI - Technical documentation, Generated by Doxygen 1.8.10}, + institution = {Deltares}, + year = {2017}, + date = {2017-01-31}, + month = {November}, + owner = {trp}, + timestamp = {2016.11.01}, +} + +@TechReport{DAMUI_FunctionalDesign, + author = {Vastenburg, E. Zwan, I vd}, + title = {DAM UI - Functional Design}, + institution = {Deltares}, + year = {2013}, + date = {2013-06-11}, + number = {1207094-000-GEO-0002, Versie 2, 11 juni 2013, concept}, + month = {September}, + owner = {trp}, + timestamp = {2016.04.12}, +} + +@TechReport{WTIParameterList, + Title = {WTI Parameterlijst}, + Author = {Lam, K.S.}, + Institution = {Deltares}, + Year = {2016}, + Month = {February}, + Number = {1220081-005-GEO-0003}, + + Owner = {trp}, + Timestamp = {2016.11.01} +} + +@TechReport{DAM_ArchitectureOverall, + author = {The, T.}, + title = {DAM Architecture Overall}, + institution = {Deltares}, + year = {2017}, + date = {2017-01-31}, + month = {May}, + owner = {trp}, + timestamp = {2016.04.12}, +} + +@TechReport{DAMKernel_TestPlan, + author = {Trompille, V.}, + title = {DAM Kernel - Test Plan}, + institution = {Deltares}, + year = {2017}, + date = {2017-01-31}, + month = {December}, + owner = {trp}, + timestamp = {2016.04.12}, +} + +@TechReport{DAMKernel_TestReport, + author = {Trompille, V.}, + title = {DAM Kernel - Test Report}, + institution = {Deltares}, + year = {2017}, + date = {2017-01-31}, + month = {May}, + owner = {trp}, + timestamp = {2016.04.12}, +} + +@TechReport{DAMUI_Manual, + author = {Zwan, I vd}, + title = {DAM UI - Manual}, + institution = {Deltares}, + year = {2017}, + date = {2017-01-31}, + number = {1207094-000-GEO-0005, Versie 2, 11 juni 2013, concept}, + month = {May}, + owner = {trp}, + timestamp = {2016.04.12}, +} + +@TechReport{DAMKernel_TechnicalDocumentation, + author = {Doxygen}, + title = {DAM Kernel - Technical documentation, Generated by Doxygen 1.8.10}, + institution = {Deltares}, + year = {2017}, + date = {2017-01-31}, + month = {November}, + owner = {trp}, + timestamp = {2016.11.01}, +} + +@TechReport{DAMKernel_TechnicalDesign, + author = {The, T.}, + title = {DAM Kernel - Technical Design}, + institution = {Deltares}, + year = {2017}, + date = {2017-01-31}, + month = {May}, + owner = {trp}, + timestamp = {2016.04.12}, +} + +@Comment{jabref-meta: databaseType:biblatex;}